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

CustomerPersons

Description#

The CustomerPersons module allows external clients to manage customer person records. It provides queries to retrieve customer person information and mutations to update or delete customer person records.

Entity Model#

FieldTypeDescription
_idID!Unique identifier of the customer person.
customerID!Reference to the customer this person belongs to.
typeCustomerType!Type of the customer person (e.g., JR_AGENT, PERSON, ADMIN, OWNER, ROBOT).
statusCPersonStatus!Status of the customer person.
firstNameString!First name of the person.
lastNameString!Last name of the person.
profilePhotoStringURL of the profile photo.
emailString!Email address of the customer person.
phoneStringPhone number of the customer person.
languageStringPreferred language of the customer person.

Queries#

Get Customer Person#

Use this query to get single customer person.
Input:
Response:

Get Customer Person List#

Use this query to fetch customer person list for the customer
Input:
Response:

Mutations#

Update Customer Person#

Use this mutation to update the customer person
Input:
Response:

Example Usage#

Query Example — Get Customer Person List#

Bash (cURL)
Node.js

Mutation Example — Update Customer Person#

Bash (cURL)
Node.js
Modified at 2025-09-28 17:08:31
Previous
Contacts
Next
Conversations
Built with