Qpien Api Docs
Help centerMain website
Help centerMain website
  1. Modules
  • Overview
  • Get started
    • Authentication
    • Scopes
  • Modules
    • Contacts
    • CustomerPersons
    • Conversations
    • Messages
    • Channels
    • WhatsappBusinessTemplates
    • SendMessages
  • Webhooks
    • Overview
Help centerMain website
Help centerMain website
  1. Modules

Contacts

Description#

The Contacts module provides functionality for managing external contacts. It supports creating, updating, deleting, and retrieving contacts with advanced filtering and pagination.

Entity Model#

ExternalContact#

FieldTypeDescription
_idID!Unique identifier of the contact.
customerID!Reference to the customer this contact belongs to.
firstNameString!First name of the contact.
lastNameStringLast name of the contact.
usernameStringUsername of the contact.
avatarString!URL of the contact's avatar.
emailStringEmail address of the contact.
phoneStringPhone number of the contact.
phoneCountryCodeStringCountry code of the phone number.
countryStringCountry where the contact resides.
genderStringGender of the contact.
tags[Tag]List of tags associated with the contact.
createdAtDateTimestamp when the contact was created.
phoneUsagePermissionBooleanPermission to use the phone for contact.
emailUsagePermissionBooleanPermission to use the email for contact.
languageStringPreferred language of the contact.
platforms[PPlatformsType]Platforms associated with the contact.
ownerStringOwner of the contact record.

Queries#

Get Contacts#

Use this query to get single contact.
Input:
Response:

Mutations#

Create Contact#

Use this mutation to create a new contact
Input:
Response:

Update Contact#

Use this mutation to update a contact
Input:
Response:

Delete Contact#

Use this mutation to delete a contact
Input:
Response:

Example Usage#

Query Example — Get Contacts#

Bash (cURL)
Node.js

Mutation Example — Create Contact#

Bash (cURL)
Node.js
Modified at 2025-09-28 17:03:37
Previous
Scopes
Next
CustomerPersons
Built with