customerWhatsAppMarketingConsentUpdate

mutation

Requires write_customers access scope. Also: The user must have permission to create and edit customers.

Updates a customer's WhatsApp marketing consent information. Shopify identifies the customer's WhatsApp account by their phone number.

You can subscribe or unsubscribe the customer from WhatsApp marketing and specify the opt-in level. You can also include when and where the consent was collected.

Anchor to Arguments

Arguments

Anchor to inputinput

•CustomerWhatsAppMarketingConsentUpdateInput!

required

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

Was this section helpful?

Anchor to CustomerWhatsAppMarketingConsentUpdatePayload returnsCustomerWhatsAppMarketingConsentUpdatePayload returns

Anchor to customerPhoneNumbercustomerPhoneNumber •CustomerPhoneNumber: The customer phone number with the updated WhatsApp marketing consent information.
Anchor to userErrorsuserErrors •[CustomerMarketingConsentError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

customerWhatsAppMarketingConsentUpdate reference

Mutation Reference

mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) {

customerWhatsAppMarketingConsentUpdate(input: $input) {

customerPhoneNumber {

# CustomerPhoneNumber fields

}

userErrors {

field

message

}

Input

{

"input": {

"customerId": "gid://shopify/Customer/10079785100",

"whatsAppMarketingConsent": {

"optInLevel": "CONFIRMED_OPT_IN",

"sourceLocationId": "gid://shopify/Location/10079785100",

"state": "NEVER_SUBSCRIBED",

"updatedAt": "2019-09-07T15:50:00Z"

}

Variables

{
  "input": {
    "customerId": "gid://shopify/Customer/10079785100",
    "whatsAppMarketingConsent": {
      "optInLevel": "CONFIRMED_OPT_IN",
      "sourceLocationId": "gid://shopify/Location/10079785100",
      "state": "NEVER_SUBSCRIBED",
      "updatedAt": "2019-09-07T15:50:00Z"
    }
  }
}

Schema

input CustomerWhatsAppMarketingConsentUpdateInput {
  customerId: ID!
  whatsAppMarketingConsent: CustomerMarketingConsentInput!
}

input CustomerMarketingConsentInput {
  optInLevel: CustomerMarketingOptInLevel
  sourceLocationId: ID
  state: CustomerMarketingConsentState!
  updatedAt: DateTime
}