Skip to main content
Anchor to CustomerPhoneNumber

CustomerPhoneNumber

object

Requires read_customers access scope.

A phone number.

Anchor to FieldsFields

Anchor to phoneNumberphoneNumber
•String!
non-null

A customer's phone number.

Anchor to smsMarketingConsentsmsMarketingConsent
•CustomerSmsMarketingConsent!
non-null

The SMS marketing consent information for the customer's phone number. Update with the customerSmsMarketingConsentUpdate mutation.

Anchor to whatsAppMarketingConsentwhatsAppMarketingConsent
•CustomerWhatsAppMarketingConsent!
non-null

The WhatsApp marketing consent information for the customer's phone number. Update with the customerWhatsAppMarketingConsentUpdate mutation.

Deprecated fields

Anchor to marketingCollectedFrommarketingCollectedFrom
•CustomerConsentCollectedFrom
Deprecated
Anchor to marketingOptInLevelmarketingOptInLevel
•CustomerMarketingOptInLevel
Deprecated
Anchor to marketingStatemarketingState
•CustomerSmsMarketingState!
non-nullDeprecated
Anchor to marketingUpdatedAtmarketingUpdatedAt
•DateTime
Deprecated
Anchor to sourceLocationsourceLocation
•Location
Deprecated
Was this section helpful?

Anchor to MutationsMutations

Anchor to customerWhatsAppMarketingConsentUpdatecustomerWhatsAppMarketingConsentUpdate
•mutation

Updates a customer's WhatsApp marketing consent information. The customer's WhatsApp account is identified by their phone number.

You can set whether the customer subscribes or unsubscribes to WhatsApp marketing and specify the opt-in level. Optionally include when the consent was collected and which location collected it.

Arguments

Anchor to inputinput
•CustomerWhatsAppMarketingConsentUpdateInput!
required

Specifies the input fields to update a customer's WhatsApp marketing consent information.

Was this section helpful?