Skip to main content
MUTATION
customersChangeState(_id: String!, value: String!): Customer

Arguments

_id
String!
required

Customer id to update.

value
String!
required

New lifecycle state key.

Returns

Customer
state
String

Lifecycle bucket (e.g. lead vs. customer pipelines). Set at creation or via customersChangeState.

createdAt
Date

When this record was created.

modifiedAt
Date

When this record was last updated.

avatar
String

Profile image URL.

integrationId
String

Id of the integration (channel) this customer first came in through, if any.

firstName
String

Given name.

lastName
String

Family name.

birthDate
Date

Date of birth, if known.

sex
Int

Numeric sex/gender code used by the CRM UI (implementation-defined).

email
String

Legacy single email field. Prefer primaryEmail / emails — kept for backward compatibility only.

primaryEmail
String

Main email address used for identity matching and messaging.

emails
[String]

All known email addresses for this customer.

primaryPhone
String

Main phone number (normalized), used for identity matching.

phones
[String]

All known phone numbers for this customer.

primaryAddress
JSON

Primary mailing/shipping address as free-form JSON.

addresses
[JSON]

All known addresses as free-form JSON.

phone
String

Legacy single phone field. Prefer primaryPhone / phones — kept for backward compatibility only.

tagIds
[String]

Ids of Tag records attached to this customer. See customers's tag filter.

customFieldsData
JSON

Custom field values as an array of { field, value } entries.

customFieldsDataByFieldCode
JSON

Custom field values keyed by field code instead of field id.

ownerId
String

Id of the User assigned as owner of this customer.

leadStatus
String

Current pipeline stage code for lead tracking.

leadStageHistory
[LeadStageHistoryEntry]

Ordered history of lead pipeline stage changes.

description
String

Free-form notes about this customer.

isSubscribed
String

Subscription/marketing consent flag (string enum, e.g. "Yes" / "No").

code
String

Short human-friendly identifier. Accepted anywhere _id is accepted on lookups such as customerDetail.

emailValidationStatus
String

Result of the last email verification pass, if any.

phoneValidationStatus
String

Result of the last phone verification pass, if any.

links
JSON

Social/external profile links as free-form JSON.

companies
[Company]

Company records this customer is related to via conformity.

getTags
[Tag]

Resolved Tag objects for tagIds.

integration
Integration
owner
User

Resolved User for ownerId.

score
Float

Engagement/lead score, when scoring is enabled for this workspace.

segmentsV2
[CustomerSegmentV2Membership]

Active segment memberships for this customer (segments-v2 only).

_id
String!
conversations
[Conversation]
Mutation
Variables
Response
آخر تعديل في ١١ أغسطس ٢٠٢٦