Choose a version:

customerSmsMarketingSubscribe

mutation

Requires unauthenticated_write_customers access scope.

Subscribes a customer to the newsletter with a phone number.

Arguments

Anchor to phoneNumberphoneNumber •String! required: The customer's phone number.

Was this section helpful?

Anchor to CustomerSmsMarketingSubscribePayload returnsCustomerSmsMarketingSubscribePayload returns

Anchor to customercustomer •CustomerMarketingSubscribe: The created customer object.
Anchor to customerUserErrorscustomerUserErrors •[CustomerUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Subscribe a customer to your newsletter with a phone number

Description

Subscribe a customer to your newsletter with a phone number

Query

mutation customerSmsMarketingSubscribe($phoneNumber: String!) {
  customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {
    customer {
      phone
    }
    customerUserErrors {
      field
      message
      code
    }
  }
}

Variables

{
  "phoneNumber": "+16475555555"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation customerSmsMarketingSubscribe($phoneNumber: String!) { customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) { customer { phone } customerUserErrors { field message code } } }",
 "variables": {
    "phoneNumber": "+16475555555"
  }
}'

Remix

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  mutation customerSmsMarketingSubscribe($phoneNumber: String!) {
    customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {
      customer {
        phone
      }
      customerUserErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "phoneNumber": "+16475555555"
    },
  },
);

const data = await response.json();

Node.js

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: {
    "query": `mutation customerSmsMarketingSubscribe($phoneNumber: String!) {
      customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {
        customer {
          phone
        }
        customerUserErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "phoneNumber": "+16475555555"
    },
  },
});

Response

{
  "customerSmsMarketingSubscribe": {
    "customer": {
      "phone": "+16475555555"
    },
    "customerUserErrors": []
  }
}

customerSmsMarketingSubscribe reference

Examples

Open in GraphiQL

const { storefront } = await unauthenticated.storefront(

'your-development-store.myshopify.com'

);

const response = await storefront.graphql(

`#graphql

mutation customerSmsMarketingSubscribe($phoneNumber: String!) {

customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {

customer {

phone

}

customerUserErrors {

field

message

code

}

}`,

{

variables: {

"phoneNumber": "+16475555555"

);

const data = await response.json();

mutation customerSmsMarketingSubscribe($phoneNumber: String!) {
  customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {
    customer {
      phone
    }
    customerUserErrors {
      field
      message
      code
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/api/unstable/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \
-d '{
"query": "mutation customerSmsMarketingSubscribe($phoneNumber: String!) { customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) { customer { phone } customerUserErrors { field message code } } }",
 "variables": {
    "phoneNumber": "+16475555555"
  }
}'

const { storefront } = await unauthenticated.storefront(
  'your-development-store.myshopify.com'
);

const response = await storefront.graphql(
  `#graphql
  mutation customerSmsMarketingSubscribe($phoneNumber: String!) {
    customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {
      customer {
        phone
      }
      customerUserErrors {
        field
        message
        code
      }
    }
  }`,
  {
    variables: {
        "phoneNumber": "+16475555555"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Storefront({
  domain: 'your-development-store.myshopify.com',
  storefrontAccessToken,
});
const data = await client.query({
  data: {
    "query": `mutation customerSmsMarketingSubscribe($phoneNumber: String!) {
      customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {
        customer {
          phone
        }
        customerUserErrors {
          field
          message
          code
        }
      }
    }`,
    "variables": {
        "phoneNumber": "+16475555555"
    },
  },
});

Input variables

JSON

{

"phoneNumber": "+16475555555"

}

Response

JSON

{

"customerSmsMarketingSubscribe": {

"customer": {

"phone": "+16475555555"

"customerUserErrors": []

}