Anchor to section titled 'undefined'

customerSmsMarketingSubscribe
mutation

Requires unauthenticated_write_customers access scope.

Subscribes a customer to the newsletter with a phone number.

Anchor to section titled 'Arguments'

Arguments

Anchor to phoneNumber
phoneNumber
String!
required

The customer's phone number.

Was this section helpful?
Anchor to section titled 'CustomerSmsMarketingSubscribePayload returns'

CustomerSmsMarketingSubscribePayload returns

Anchor to CustomerSmsMarketingSubscribePayload.customer
customer
CustomerMarketingSubscribe

The created customer object.

Anchor to CustomerSmsMarketingSubscribePayload.customerUserErrors
customerUserErrors
[CustomerUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerSmsMarketingSubscribe($phoneNumber: String!) {
  customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {
    customer {
      # CustomerMarketingSubscribe fields
    }
    customerUserErrors {
      # CustomerUserError fields
    }
  }
}
Hide code
Input
Copy
{
  "phoneNumber": "<your-phoneNumber>"
}