customersAdd
Create a new customer/contact.
Side effects: triggers a customer.created automation event and activity log entry, and notifies configured webhooks.
Auth · x-app-token · required permission customersAdd
Related: customers, customersEdit, Customer
customersAdd(state: String, avatar: String, firstName: String, lastName: String, primaryEmail: String, emails: [String], primaryPhone: String, phones: [String], primaryAddress: JSON, addresses: [JSON], ownerId: String, tagIds: [String], leadStatus: String, description: String, isSubscribed: String, links: JSON, customFieldsData: JSON, code: String, sex: Int, birthDate: Date, emailValidationStatus: String, phoneValidationStatus: String): CustomerArguments
Optional lifecycle state (e.g. lead vs. customer pipeline) at creation.
Profile image URL.
Given name.
Family name.
Main email address, used for identity matching.
Additional known email addresses.
Main phone number, used for identity matching.
Additional known phone numbers.
Primary address as free-form JSON.
Additional addresses as free-form JSON.
Id of the User to assign as owner.
Ids of Tag records to attach at creation.
Initial lead pipeline stage code.
Free-form notes.
Marketing consent flag, e.g. "Yes" / "No".
Social/external profile links as free-form JSON.
Custom field values as an array of { field, value } entries.
Optional short human-friendly identifier.
Sex/gender code.
Date of birth.
Initial email verification status, if already known.
Initial phone verification status, if already known.
Returns
Lifecycle bucket (e.g. lead vs. customer pipelines). Set at creation or via customersChangeState.
When this record was created.
When this record was last updated.
Profile image URL.
Id of the integration (channel) this customer first came in through, if any.
Given name.
Family name.
Date of birth, if known.
Numeric sex/gender code used by the CRM UI (implementation-defined).
Legacy single email field.
Prefer primaryEmail / emails — kept for backward compatibility only.
Main email address used for identity matching and messaging.
All known email addresses for this customer.
Main phone number (normalized), used for identity matching.
All known phone numbers for this customer.
Primary mailing/shipping address as free-form JSON.
All known addresses as free-form JSON.
Legacy single phone field.
Prefer primaryPhone / phones — kept for backward compatibility only.
Custom field values as an array of { field, value } entries.
Custom field values keyed by field code instead of field id.
Id of the User assigned as owner of this customer.
Current pipeline stage code for lead tracking.
Ordered history of lead pipeline stage changes.
Free-form notes about this customer.
Subscription/marketing consent flag (string enum, e.g. "Yes" / "No").
Short human-friendly identifier. Accepted anywhere _id is accepted on lookups such as customerDetail.
Result of the last email verification pass, if any.
Result of the last phone verification pass, if any.
Social/external profile links as free-form JSON.
Engagement/lead score, when scoring is enabled for this workspace.
Active segment memberships for this customer (segments-v2 only).