Choose a version:

Anchor to customerWhatsAppMarketingConsentUpdate

customerWhatsAppMarketingConsentUpdate

mutation

Requires customer_write_pre_authenticated access scope. Also: The user must be fully authenticated or pre-authenticated.

Updates the current 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.

Anchor to Arguments

Arguments

Anchor to inputinput

•CustomerWhatsAppMarketingConsentUpdateInput!

required

Specifies the input fields to update the current 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 •[UserErrorsCustomerMarketingConsentError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Subscribe to WhatsApp marketing

Description

Subscribe a customer to WhatsApp marketing. In this example, the returned state is `PENDING` because the shop is configured with confirmed opt-in.

Query

mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) {
  customerWhatsAppMarketingConsentUpdate(input: $input) {
    userErrors {
      field
      message
    }
    customerPhoneNumber {
      phoneNumber
      whatsAppMarketingConsent {
        state
      }
    }
  }
}

Variables

{
  "input": {
    "whatsAppMarketingConsent": {
      "state": "SUBSCRIBED"
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/customer/api/unstable/graphql \
-H 'Content-Type: application/json' \
-H 'Authorization: {access_token}' \
-d '{
"query": "mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) { customerWhatsAppMarketingConsentUpdate(input: $input) { userErrors { field message } customerPhoneNumber { phoneNumber whatsAppMarketingConsent { state } } } }",
 "variables": {
    "input": {
      "whatsAppMarketingConsent": {
        "state": "SUBSCRIBED"
      }
    }
  }
}'

Response

{
  "customerWhatsAppMarketingConsentUpdate": {
    "userErrors": [],
    "customerPhoneNumber": {
      "phoneNumber": "+16134504532",
      "whatsAppMarketingConsent": {
        "state": "PENDING"
      }
    }
  }
}

Unsubscribe from WhatsApp marketing

Query

mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) {
  customerWhatsAppMarketingConsentUpdate(input: $input) {
    userErrors {
      field
      message
    }
    customerPhoneNumber {
      phoneNumber
      whatsAppMarketingConsent {
        state
      }
    }
  }
}

Variables

{
  "input": {
    "whatsAppMarketingConsent": {
      "state": "UNSUBSCRIBED"
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/customer/api/unstable/graphql \
-H 'Content-Type: application/json' \
-H 'Authorization: {access_token}' \
-d '{
"query": "mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) { customerWhatsAppMarketingConsentUpdate(input: $input) { userErrors { field message } customerPhoneNumber { phoneNumber whatsAppMarketingConsent { state } } } }",
 "variables": {
    "input": {
      "whatsAppMarketingConsent": {
        "state": "UNSUBSCRIBED"
      }
    }
  }
}'

Response

{
  "customerWhatsAppMarketingConsentUpdate": {
    "userErrors": [],
    "customerPhoneNumber": {
      "phoneNumber": "+13125551212",
      "whatsAppMarketingConsent": {
        "state": "UNSUBSCRIBED"
      }
    }
  }
}

customerWhatsAppMarketingConsentUpdate reference

Examples

mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) {

customerWhatsAppMarketingConsentUpdate(input: $input) {

userErrors {

field

message

}

customerPhoneNumber {

phoneNumber

whatsAppMarketingConsent {

state

}

GQL

mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) {
  customerWhatsAppMarketingConsentUpdate(input: $input) {
    userErrors {
      field
      message
    }
    customerPhoneNumber {
      phoneNumber
      whatsAppMarketingConsent {
        state
      }
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/customer/api/unstable/graphql \
-H 'Content-Type: application/json' \
-H 'Authorization: {access_token}' \
-d '{
"query": "mutation customerWhatsAppMarketingConsentUpdate($input: CustomerWhatsAppMarketingConsentUpdateInput!) { customerWhatsAppMarketingConsentUpdate(input: $input) { userErrors { field message } customerPhoneNumber { phoneNumber whatsAppMarketingConsent { state } } } }",
 "variables": {
    "input": {
      "whatsAppMarketingConsent": {
        "state": "SUBSCRIBED"
      }
    }
  }
}'

Input variables

JSON

{

"input": {

"whatsAppMarketingConsent": {

"state": "SUBSCRIBED"

}

Response

JSON

{

"customerWhatsAppMarketingConsentUpdate": {

"userErrors": [],

"customerPhoneNumber": {

"phoneNumber": "+16134504532",

"whatsAppMarketingConsent": {

"state": "PENDING"

}