customerSmsMarketingSubscribe - storefront - MUTATION

Version: unstable

Description:

Subscribes a customer to the newsletter with a phone number.

Access Scopes

`unauthenticated_write_customers` access scope.

Arguments

• phoneNumber: String! - The customer's phone number.

Returns

• customer: CustomerMarketingSubscribe The created customer object.
• customerUserErrors: CustomerUserError! The list of errors that occurred from executing the mutation.

Examples

• Subscribe a customer to your newsletter with a phone number

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Storefront-Access-Token: {storefront_access_token}' \\\n-d '{\n\"query\": \"mutation customerSmsMarketingSubscribe($phoneNumber: String!) { customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) { customer { phone } customerUserErrors { field message code } } }\",\n \"variables\": {\n    \"phoneNumber\": \"+16475555555\"\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Storefront({\n  domain: 'your-development-store.myshopify.com',\n  storefrontAccessToken,\n});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation customerSmsMarketingSubscribe($phoneNumber: String!) {\n      customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {\n        customer {\n          phone\n        }\n        customerUserErrors {\n          field\n          message\n          code\n        }\n      }\n    }`,\n    \"variables\": {\n      \"phoneNumber\": \"+16475555555\"\n    },\n  },\n});\n"
          Ruby example: null
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new ShopifyClientsStorefront(\"your-development-store.myshopify.com\", $storefrontAccessToken);\n$query = <<<QUERY\n  mutation customerSmsMarketingSubscribe($phoneNumber: String!) {\n    customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {\n      customer {\n        phone\n      }\n      customerUserErrors {\n        field\n        message\n        code\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"phoneNumber\" => \"+16475555555\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { storefront } = await unauthenticated.storefront(\n  'your-development-store.myshopify.com'\n);\n\nconst response = await storefront.graphql(\n  `#graphql\n  mutation customerSmsMarketingSubscribe($phoneNumber: String!) {\n    customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {\n      customer {\n        phone\n      }\n      customerUserErrors {\n        field\n        message\n        code\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"phoneNumber\": \"+16475555555\"\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation customerSmsMarketingSubscribe($phoneNumber: String!) {\n  customerSmsMarketingSubscribe(phoneNumber: $phoneNumber) {\n    customer {\n      phone\n    }\n    customerUserErrors {\n      field\n      message\n      code\n    }\n  }\n}"
        

  input: {
    "phoneNumber": "+16475555555"
  }

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