API Reference
Help Center
  1. GraphQL Admin API

Customers

Customer records, custom fields, and audience membership.

Queries

customerFields

Lists CustomerFields

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • byStatus (CustomerFieldStatusFilter) — The status of the CustomerField to filter results by
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • isCustom (Boolean) — Whether or not the CustomerField is a custom field
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to filter results
  • sortBy (SortCustomerFieldsBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: CustomerFieldConnection! — A connection to a list of items.

customerFieldsByIds

A list of CustomerFields by IDs

Arguments

  • ids ([ID!]!) — The IDs of the CustomerFields

Returns: [CustomerField]! — A field on a Customer profile

customerFieldsByKeys

A list of CustomerFields by keys

Arguments

  • keys ([String!]!) — The keys of the CustomerFields

Returns: [CustomerField]! — A field on a Customer profile

customersByExternalIds

A list of Customers by integrated customer external IDs

Arguments

  • externalIds ([ID!]!) — The external IDs of the integrated customers
  • integrationId (ID!) — The ID of the Integration

Returns: [Customer]! — A profile for an individual contact

searchCustomerFields

🚧

Deprecated: Use Query.customerFields instead

Lists CustomerFields

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • byStatus (CustomerFieldStatusFilter) — The status of the CustomerField to filter results by
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • isCustom (Boolean) — Whether or not the CustomerField is a custom field
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to filter results
  • sortBy (SortCustomerFieldsBy) — The sort key
  • sortDir (SortDirection) — The sort direction

Returns: CustomerFieldConnection! — A connection to a list of items.

searchCustomers

Searches Customers

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • before (String) — A cursor to search before (only include first & after or last & before)
  • filters ([SearchFilterInput!]) — A set of filters to apply
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to apply
  • sortBy (SortCustomersBy) — The sort key
  • sortDir (SortDirection) — The sort direction
  • timeZone (String) — The time zone to use for the search

Returns: CustomerConnection! — A connection to a list of items.

searchCustomersInAudience

Searches Customers

Arguments

  • after (String) — A cursor to search after (only include first & after or last & before)
  • audienceId (ID!) — The ID of the audience to search in
  • before (String) — A cursor to search before (only include first & after or last & before)
  • first (Int) — The number of results to fetch when searching forward (only include first & after or last & before)
  • last (Int) — The number of results to fetch when searching backward (only include first & after or last & before)
  • search (String) — A search query to apply
  • searchAsTeamId (ID!) — The ID of the Team to search as
  • searchAsUserId (ID!) — The ID of the User to search as
  • sortBy (SortCustomersBy) — The sort key
  • sortDir (SortDirection) — The sort direction
  • timeZone (String!) — The time zone to use for the search

Returns: CustomerConnection! — A connection to a list of items.

Mutations

createCustomer

Creates a new Customer

Arguments

Returns: CreateCustomerPayload!

createCustomerField

Creates a new CustomerField

Arguments

  • allowMultiple (Boolean!) — Whether the CustomerField allows multiple values
  • currency (Currency) — The currency of the CustomerField
  • customerFieldGroupId (ID) — (optional) The initial customer field group to assign this field to
  • description (String) — The description of the CustomerField
  • isUserEditable (Boolean!) — Whether the CustomerField is user editable
  • key (String!) — The key of the CustomerField
  • label (String!) — The label of the CustomerField
  • options ([CustomerFieldOptionInput!]) — The options of the CustomerField
  • order (CustomerFieldOrder) — The order of preference for single-value CustomerFields
  • type (CustomerFieldType!) — The type of the CustomerField

Returns: CreateCustomerFieldPayload!

initiateCustomerMerge

Initiates a background process to merge multiple Customers into one

Arguments

Returns: InitiateCustomerMergePayload!

requestCustomerDeletion

Queues a Customer to be deleted

Arguments

Returns: RequestCustomerDeletionPayload!

updateCustomerField

Updates an existing CustomerField

Arguments

  • actor (ActorContext) — The context of the User & Team making the request
  • description (String) — The description of the CustomerField
  • id (ID!) — The ID of the CustomerField to update
  • isAiEditable (Boolean) — Whether the CustomerField is AI editable
  • isHidden (Boolean) — Whether the CustomerField is hidden
  • isUserEditable (Boolean) — Whether the CustomerField is user editable
  • label (String) — The label of the CustomerField
  • llmDescription (String) — The description of the CustomerField for AI
  • options ([CustomerFieldOptionInput!]) — The options of the CustomerField. Pass null to clear, omit to leave unchanged.

Returns: UpdateCustomerFieldPayload!

updateCustomerFieldAttributes

Applies a set of CustomerFieldAttributeChanges to a Customer

Arguments

Returns: UpdateCustomerFieldAttributesPayload!

updateCustomerV2

Updates a Customer

Arguments

  • archived (Boolean!) — Whether the Customer is archived
  • editorId (ID) — The ID of the user who is editing the Customer
  • id (ID!) — The ID of the Customer to update

Returns: UpdateCustomerV2Payload!

Objects

CreateCustomerError

Fields

CreateCustomerFailure

Fields

CreateCustomerFieldError

Fields

CreateCustomerFieldFailure

Fields

CreateCustomerFieldSuccess

Fields

CreateCustomerSuccess

Fields

Customer

A profile for an individual contact

Fields

  • accepts_marketing (Boolean) — Whether the Customer accepts marketing — 🚧 Deprecated: Use EmailMarketingSubscription & SmsMarketingSubscription
  • addresses ([String!]!) — The associated physical addresses of the Customer
  • aggregations (CustomerAggregation!) — Aggregated metrics about the Customer
  • assigned_users ([User]!) — The Users that are assigned to the Customer
  • birthday (String) — The birthday of the Customer in one of the following formats: YYYY/MM/DD, MM/DD, MM
  • cities ([String!]!) — All of the cities of the Customer
  • countries ([String!]!) — All of the countries of the Customer
  • created_at (DateTime!) — The date the Customer was created
  • creator (User) — The User that created the Customer
  • custom_fields ([CustomerCustomField!]!) — The custom fields associated to the Customer
  • default_address (String) — The associated default physical address of the Customer
  • default_address_line_1 (String) — The first line of the default physical address of the Customer
  • default_address_line_2 (String) — The second line of the default physical address of the Customer
  • default_city (String) — The city of the Customer
  • default_country (String) — The country of the Customer
  • default_email_address (String) — The default email address of the Customer
  • default_phone_number (String) — The default phone number of the Customer
  • default_postal_code (String) — The postal code of the Customer
  • default_province (String) — The state/province of the Customer
  • deleted_at (DateTime) — The date the Customer was deleted
  • display_name (String) — The display identifier of the Customer
  • email_addresses ([String!]!) — All of the associated email addresses of the Customer
  • email_marketing_subscriptions ([EmailMarketingSubscription!]!) — The EmailMarketingSubscriptions of the Customer
  • first_name (String) — The first name of the Customer
  • first_seen (DateTime) — The date the Customer first interacted with the Brand
  • full_name (String) — The full name of the Customer
  • id (ID!) — The unique identifier of the Customer
  • integrated_customers ([IntegratedCustomer!]!) — The IntegratedCustomers of the Customer
  • is_archived (Boolean!) — Whether the Customer has been archived
  • is_merged (Boolean!) — Whether the Customer has been merged
  • last_name (String) — The last name of the Customer
  • merged ([Customer!]!) — The Customers that were merged into this one
  • merged_into (Customer) — The Customer that this Customer was merged into
  • phone_numbers ([String!]!) — All of the associated phone numbers of the Customer
  • postal_codes ([String!]!) — All of the postal codes of the Customer
  • provinces ([String!]!) — All of the states/provinces of the Customer
  • sms_marketing_subscriptions ([SmsMarketingSubscription!]!) — The SmsMarketingSubscriptions of the Customer
  • tags ([String!]!) — The tags associated with the Customer
  • updated_at (DateTime!) — The date the Customer was last updated
  • web_url (URL!) — The URL to the Customer inside the web application — 🚧 Deprecated: No longer supported

CustomerAggregation

Aggregated metrics about a Customer's history

Fields

  • average_order_value (Money) — The average amount of money spent per-order by the Customer
  • total_discount_value (Money!) — The total amount of discounts applied to the Customer
  • total_number_of_items (NonNegativeInt!) — The total number of items purchased by the Customer
  • total_number_of_orders (NonNegativeInt!) — The total number of purchases made by the Customer
  • total_refund_value (Money!) — The total amount of refunds issued to the Customer
  • total_spent (Money!) — The total amount of money spent by the Customer in their lifetime

CustomerConnection

A connection to a list of items.

Fields

CustomerCustomField

Fields

  • field (CustomerField!) — The CustomerField associated to the CustomerCustomField
  • values ([String!]!) — The values for the CustomerCustomField as a list of strings

CustomerDeletion

A request to delete a Customer's data

Fields

  • created_at (DateTime!) — The date and time the CustomerDeletion was created
  • id (ID!) — The ID of the CustomerDeletion
  • identifier (String!) — The identifier of the Customer to be deleted
  • identifier_type (CustomerDeletionIdentifierType!) — The type of identifier used to find the Customer
  • requested_by_integration (Integration)
  • requested_by_user (User)

CustomerEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (Customer) — The item at the end of the edge

CustomerField

A field on a Customer profile

Fields

  • allow_multiple (Boolean!) — Whether the CustomerField allows multiple values
  • created_at (DateTime!) — The date the CustomerField was created
  • currency (Currency) — The currency of the CustomerField
  • description (String!) — The description of the CustomerField
  • id (ID!) — The unique identifier of the CustomerField
  • is_custom (Boolean!) — Whether the CustomerField is a custom field
  • is_hidden (Boolean!) — Whether the CustomerField is hidden
  • is_user_editable (Boolean!) — Whether the CustomerField is user editable
  • key (String!) — The key of the CustomerField
  • label (String!) — The label of the CustomerField
  • options ([CustomerFieldOption!]) — The options of the CustomerField
  • order (CustomerFieldOrder!) — The order of values of the CustomerField
  • type (CustomerFieldType!) — The datatype of the CustomerField
  • updated_at (DateTime!) — The date the CustomerField was last updated

CustomerFieldAiSourceInfo

AI provenance metadata for an EditableCustomerFieldAttribute whose value was written by the AI Notetaker

Fields

  • created_at (DateTime!) — When the AI wrote this field value
  • note_id (ID) — The ID of the source note, if available
  • source_excerpt (String) — The excerpt from the note that the AI used to set this field value

CustomerFieldAttributeAbsoluteDateValue

An absolute date value for a CustomerFieldAttribute

Fields

  • as_absolute_date (DateTime!) — The absolute date representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributeBooleanValue

A boolean value for a CustomerFieldAttribute

Fields

  • as_boolean (Boolean!) — The boolean representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributeEmailAddressValue

An email address value for a CustomerFieldAttribute

Fields

  • as_email_address (String!) — The email address representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributeLocationValue

A location value for a CustomerFieldAttribute

Fields

  • as_location (Address!) — The location representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributeNumberValue

A number value for a CustomerFieldAttribute

Fields

  • as_number (Decimal!) — The number representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributePhoneNumberValue

A phone number value for a CustomerFieldAttribute

Fields

  • as_phone_number (String!) — The phone number representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributeRecurringDateValue

A recurring date value for a CustomerFieldAttribute

Fields

  • as_recurring_date (PartialLocalDate!) — The recurring date representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributeStringValue

A string value for a CustomerFieldAttribute

Fields

  • as_string (String!) — The string representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldAttributeURLValue

A URL value for a CustomerFieldAttribute

Fields

  • as_url (URL!) — The URL representation of the value
  • as_value (String!) — The primitive representation of the value

CustomerFieldConnection

A connection to a list of items.

Fields

CustomerFieldEdge

An edge in a connection.

Fields

  • cursor (String!) — A cursor for use in pagination
  • node (CustomerField) — The item at the end of the edge

CustomerFieldOption

Fields

  • hidden (Boolean) — Whether the CustomerFieldOption has been hidden
  • label (String!) — The label of the CustomerFieldOption
  • value (String!) — The value of the CustomerFieldOption

EditableCustomer

An editable profile for an individual contact

Fields

  • assigned_users ([User]!) — The Users that are assigned to the EditableCustomer
  • attributes ([CustomerFieldAttribute!]!) — The attributes of the EditableCustomer
  • created_at (DateTime!) — The date the EditableCustomer was created
  • creator (User) — The User that created the EditableCustomer
  • deleted_at (DateTime) — The date the EditableCustomer was deleted
  • id (ID!) — The unique identifier of the EditableCustomer
  • is_archived (Boolean!) — Whether the EditableCustomer has been archived
  • is_merged (Boolean!) — Whether the EditableCustomer has been merged
  • merged ([EditableCustomer!]!) — The EditableCustomers that were merged into this one
  • merged_at (DateTime) — The date the EditableCustomer was merged
  • merged_into (EditableCustomer) — The EditableCustomer that this EditableCustomer was merged into
  • updated_at (DateTime!) — The date the EditableCustomer was last updated

EditableCustomerFieldAttribute

An editable attribute on a Customer profile

Fields

  • ai_source_info (CustomerFieldAiSourceInfo) — AI provenance metadata for this field attribute. When present, indicates the value was written by the AI Notetaker, but may be null even when task_v2_approval_item_id is set if the underlying approval item cannot be loaded or parsed.
  • ai_source_status (CustomerFieldAiSourceStatus!) — The AI source status of the field attribute, indicating whether the current value was set by AI or manually
  • allow_changing (Boolean!) — Whether the CustomerFieldAttribute is editable
  • allow_removing (Boolean!) — Whether the CustomerFieldAttribute is removable
  • attribute (CustomerFieldAttributeValue!) — The value of the CustomerFieldAttribute
  • created_at (DateTime!) — The date the CustomerFieldAttribute was created
  • customer (EditableCustomer!) — The EditablerCustomer associated to the CustomerFieldAttribute
  • field (CustomerField!) — The CustomerField associated to the CustomerFieldAttribute
  • updated_at (DateTime!) — The date the CustomerFieldAttribute was last updated

InitiateCustomerMergeError

Fields

InitiateCustomerMergeFailure

Fields

InitiateCustomerMergeSuccess

Fields

IntegratedCustomer

A customer from an Integration

Fields

  • attributes ([CustomerFieldAttribute!]!) — The attributes of the IntegratedCustomer
  • created_at (DateTime!) — The date the IntegratedCustomer was created
  • external_id (ID!) — The external unique identifier of the IntegratedCustomer
  • id (ID!) — The unique identifier of the IntegratedCustomer
  • integration (Integration!) — The Integration associated to the IntegratedCustomer
  • updated_at (DateTime!) — The date the IntegratedCustomer was last updated

RequestCustomerDeletionError

Fields

RequestCustomerDeletionFailure

Fields

RequestCustomerDeletionSuccess

Fields

ResolvedCustomerFieldAttribute

A read-only attribute on a Customer profile

Fields

  • allow_changing (Boolean!) — Whether the CustomerFieldAttribute is editable
  • allow_removing (Boolean!) — Whether the CustomerFieldAttribute is removable
  • attribute (CustomerFieldAttributeValue!) — The value of the CustomerFieldAttribute
  • created_at (DateTime!) — The date the CustomerFieldAttribute was created
  • field (CustomerField!) — The CustomerField associated to the CustomerFieldAttribute
  • integrated_customer (IntegratedCustomer!) — The Integration associated to the CustomerFieldAttribute
  • integration (Integration!) — The Integration associated to the CustomerFieldAttribute
  • updated_at (DateTime!) — The date the CustomerFieldAttribute was last updated

UpdateCustomerFieldAttributesError

Fields

UpdateCustomerFieldAttributesFailure

Fields

UpdateCustomerFieldAttributesSuccess

Fields

UpdateCustomerFieldError

Fields

UpdateCustomerFieldFailure

Fields

UpdateCustomerFieldSuccess

Fields

UpdateCustomerV2Error

Fields

UpdateCustomerV2Failure

Fields

UpdateCustomerV2Success

Fields

Interfaces

CustomerFieldAttributeInterface

Fields

  • allow_changing (Boolean!) — Whether the CustomerFieldAttribute is editable
  • allow_removing (Boolean!) — Whether the CustomerFieldAttribute is removable
  • attribute (CustomerFieldAttributeValue!) — The value of the CustomerFieldAttribute
  • created_at (DateTime!) — The date the CustomerFieldAttribute was created
  • field (CustomerField!) — The CustomerField associated to the CustomerFieldAttribute
  • updated_at (DateTime!) — The date the CustomerFieldAttribute was last updated

Implemented by

CustomerFieldAttributeValueInterface

Fields

  • as_value (String!) — The primitive representation of the value

Implemented by

Unions

CreateCustomerFieldPayload

Possible types

CreateCustomerPayload

Possible types

CustomerFieldAttribute

An attribute on a Customer profile

Possible types

CustomerFieldAttributeValue

A value for a CustomerFieldAttribute

Possible types

InitiateCustomerMergePayload

Possible types

RequestCustomerDeletionPayload

Possible types

UpdateCustomerFieldAttributesPayload

Possible types

UpdateCustomerFieldPayload

Possible types

UpdateCustomerV2Payload

Possible types

Input Objects

CustomerFieldAttributeAbsoluteDateValueInput

A CustomerFieldAttributeAbsoluteDateValue to be added/updated

Fields

CustomerFieldAttributeBooleanValueInput

A CustomerFieldAttributeBooleanValue to be added/updated

Fields

CustomerFieldAttributeChangeInput

A CustomerFieldAttributeChange to be added

Fields

CustomerFieldAttributeCreateInput

A CustomerFieldAttribute to be added

Fields

CustomerFieldAttributeEmailAddressValueInput

A CustomerFieldAttributeEmailAddressValue to be added/updated

Fields

CustomerFieldAttributeInput

A CustomerFieldAttribute to be added/updated

Fields

CustomerFieldAttributeLocationValueInput

A CustomerFieldAttributeLocationValue to be added/updated

Fields

CustomerFieldAttributeNumberValueInput

A CustomerFieldAttributeNumberValue to be added/updated

Fields

CustomerFieldAttributePhoneNumberValueInput

A CustomerFieldAttributePhoneNumberValue to be added/updated

Fields

CustomerFieldAttributeRecurringDateValueInput

A CustomerFieldAttributeRecurringDateValue to be added/updated

Fields

CustomerFieldAttributeStringValueInput

A CustomerFieldAttributeStringValue to be added/updated

Fields

CustomerFieldAttributeURLValueInput

A CustomerFieldAttributeURLValue to be added/updated

Fields

CustomerFieldOptionInput

Fields

  • hidden (Boolean) — Whether the CustomerFieldOption has been hidden
  • label (String!) — The label of the CustomerFieldOption
  • value (String!) — The value of the CustomerFieldOption

ExternalCustomerCustomFieldInput

A CustomField to associated with the ExternalCustomer

Fields

  • key (String!) — The key of the custom field
  • values ([String!]!) — The values of the custom field

ExternalCustomerInput

An ExternalCustomer to be added/updated

Fields

  • birthday (PartialLocalDateInput) — The birthday of the ExternalCustomer
  • created_at (DateTime) — The date the ExternalCustomer was created
  • custom_fields ([ExternalCustomerCustomFieldInput!]) — Custom fields to associate with the ExternalCustomer
  • default_address (AddressInput) — The default address of the ExternalCustomer
  • deleted_at (DateTime) — The date the ExternalCustomer was deleted
  • email_address (EmailAddress) — The email address of the ExternalCustomer
  • email_marketing_subscription_status (ExternalCustomerMarketingSubscriptionStatus) — The email marketing subscription status of the ExternalCustomer
  • first_name (String) — The first name of the ExternalCustomer
  • id (ID!) — The unique identifier of the ExternalCustomer
  • last_name (String) — The last name of the ExternalCustomer
  • phone_number (String) — The phone number of the ExternalCustomer
  • sms_marketing_subscription_status (ExternalCustomerMarketingSubscriptionStatus) — The sms marketing subscription status of the ExternalCustomer
  • tags ([String!]) — Tags to associate withe ExternalCustomer
  • updated_at (DateTime) — The date the ExternalCustomer was last updated

MergeCustomersInput

A Customer ID and a list of Customer IDs to merge

Fields

  • customerId (ID!) — The ID of the Customer to merge into
  • customerIdsToMerge ([ID!]!) — The IDs of the Customers to merge
  • unarchive (Boolean) — Unarchive the target Customer

Enums

CreateCustomerErrorCode

Values

  • CUSTOMER_FIELD_INVALID — One or more of the provided customer fields was invalid
  • CUSTOMER_FIELD_NOT_FOUND — One or more of the provided customer fields was not found

CreateCustomerFieldErrorCode

Values

  • AI_EDITABLE_FIELD_MUST_BE_USER_EDITABLE — The AI editable field must be user editable.
  • CURRENCY_ONLY_FOR_NUMBER — The currency field can only be provided with number fields.
  • CUSTOMER_FIELD_GROUP_NOT_FOUND — The provided customerFieldGroupId was not found.
  • FORBIDDEN — You do not have permission to perform this action
  • INVALID_KEY — The key must be a non-empty string using only lowercase letters, numbers, and underscores. It must also end in an underscore.
  • INVALID_OPTION_VALUE — A provided option value is invalid.
  • KEY_ALREADY_EXISTS — A field with this key already exists.
  • MAXIMUM_AMOUNT_OF_CUSTOM_FIELDS_CREATED — This integration has already created the maximum allowed amount of custom fields.
  • ORDER_CANNOT_BE_PROVIDED_WHEN_ALLOW_MULTIPLE — The order field can not be provided with non-multiple fields.
  • ORDER_MUST_BE_PROVIDED_WHEN_ALLOW_SINGLE — The order field must be provided with non-multiple fields.
  • UNSUPPORTED_CUSTOM_FIELD_TYPE — The provided custom field type is not supported.

CustomerDeletionIdentifierType

Values

  • CUSTOMER_ID
  • EMAIL_ADDRESS

CustomerFieldAiSourceStatus

The AI source status of an editable customer field attribute, indicating whether the current value was set by AI or manually. Fields whose AI-written value was cleared are surfaced via EditableCustomer.fields_with_ai_removed_values instead.

Values

  • AI_ACTIVE — The field was set by AI and the current value still matches the AI suggestion
  • MANUAL — The field was set manually — no AI approval item is linked to it
  • MANUALLY_OVERRIDDEN — The field was originally set by AI but has since been manually changed

CustomerFieldAttributeChangeType

Values

  • APPEND — Places the value to the attribute at the end, leaving existing values
  • CLEAR — Removes all existing values from the attribute
  • OMIT — Removes the value from the attribute, leaving other values
  • PREPEND — Places the value to the attribute at the beginning, leaving existing values
  • SET — Sets the value of the attribute, clearing any existing value
  • SET_DEFAULT — Places the value to the attribute at the beginning, leaving existing values

CustomerFieldOrder

The order of values of a CustomerField

Values

  • ANY
  • DEFAULT_FIRST
  • HIGHEST_VALUE_FIRST
  • LATEST_UPDATED_FIRST
  • LOWEST_VALUE_FIRST
  • OLDEST_UPDATED_FIRST

CustomerFieldStatusFilter

The status of the CustomerField to filter results by

Values

  • ACTIVE
  • ALL
  • DELETED

CustomerFieldType

The datatype of a CustomerField

Values

  • ABSOLUTE_DATE
  • BOOLEAN
  • EMAIL
  • LOCATION
  • NUMBER
  • PHONE_NUMBER
  • RECURRING_DATE
  • STRING
  • URL

ExternalCustomerMarketingSubscriptionStatus

Values

  • SUBSCRIBED
  • UNSUBSCRIBED

InitiateCustomerMergeErrorCode

Values

  • CUSTOMERS_TO_MERGE_REQUIRED — The customers to merge must be provided
  • CUSTOMER_ALREADY_MERGED — The customer has already been merged
  • CUSTOMER_DELETED — The customer has been deleted
  • CUSTOMER_NOT_FOUND — The customer was not found
  • CUSTOMER_TO_MERGE_INCLUDES_SELF — You cannot merge a customer into itself

RequestCustomerDeletionErrorCode

Values

  • CUSTOMER_DELETION_ALREADY_EXISTS — The customer deletion already exists with the given identifier for the given brand
  • FORBIDDEN — You do not have permission to perform this action
  • INVALID_IDENTIFIER — The identifier is invalid

SortCustomerFieldsBy

The available keys to sort CustomerFields

Values

  • CREATED_AT
  • UPDATED_AT

SortCustomersBy

The available keys to sort Customers

Values

  • CREATED_AT
  • FIRST_PURCHASE_DATE
  • FIRST_SEEN
  • LAST_MESSAGE_DATE
  • LAST_PURCHASE_DATE
  • NAME
  • TOTAL_SPEND
  • UPDATED_AT

UpdateCustomerFieldAttributesErrorCode

Values

  • CONCURRENCY_ERROR — The customer has been updated since this request was initiated
  • CUSTOMER_DELETED — The customer is deleted
  • CUSTOMER_FIELD_INVALID — The customer field value is invalid
  • CUSTOMER_FIELD_NOT_FOUND — The customer field with the provided key could not be found
  • CUSTOMER_MERGED — The customer has already been merged into another customer and cannot be updated
  • CUSTOMER_NOT_FOUND — The customer with the provided ID could not be found

UpdateCustomerFieldErrorCode

Values

  • AI_EDITABLE_FIELD_MUST_BE_USER_EDITABLE — The AI editable field must be user editable.
  • CUSTOMER_FIELD_NOT_FOUND — The submitted customer field was not found
  • FORBIDDEN — You do not have permission to perform this action
  • INVALID_OPTION_VALUE — A provided option value is invalid.
  • MISSING_OPTION_VALUE — An existing option value is missing.

UpdateCustomerV2ErrorCode

Values

  • CUSTOMER_DELETED — The customer has been deleted
  • CUSTOMER_NOT_FOUND — The customer was not found
  • EDITOR_NOT_FOUND — The editor was not found

Updated 13 days ago

Did this page help you?

Updated 13 days ago

Did this page help you?