customerSmsMarketingConsentUpdate - admin-graphql - MUTATION

Version: 2024-10

Description:

Update a customer's SMS marketing consent information.

Access Scopes

`write_customers` access scope.

Arguments

• input: CustomerSmsMarketingConsentUpdateInput! - Specifies the input fields to update a customer's SMS marketing consent information.

Returns

• customer: Customer The updated customer.
• userErrors: CustomerSmsMarketingConsentError! The list of errors that occurred from executing the mutation.

Examples

• Subscribe a customer to SMS marketing materials

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) { customerSmsMarketingConsentUpdate(input: $input) { userErrors { field message } customer { id phone smsMarketingConsent { marketingState marketingOptInLevel consentUpdatedAt consentCollectedFrom } } } }\",\n \"variables\": {\n    \"input\": {\n      \"customerId\": \"gid://shopify/Customer/207119551\",\n      \"smsMarketingConsent\": {\n        \"marketingState\": \"SUBSCRIBED\",\n        \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n      customerSmsMarketingConsentUpdate(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        customer {\n          id\n          phone\n          smsMarketingConsent {\n            marketingState\n            marketingOptInLevel\n            consentUpdatedAt\n            consentCollectedFrom\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"customerId\": \"gid://shopify/Customer/207119551\",\n        \"smsMarketingConsent\": {\n          \"marketingState\": \"SUBSCRIBED\",\n          \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"customerId\": \"gid://shopify/Customer/207119551\",\n    \"smsMarketingConsent\": {\n      \"marketingState\": \"SUBSCRIBED\",\n      \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"customerId\" => \"gid://shopify/Customer/207119551\",\n    \"smsMarketingConsent\" => [\n      \"marketingState\" => \"SUBSCRIBED\",\n      \"marketingOptInLevel\" => \"SINGLE_OPT_IN\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"customerId\": \"gid://shopify/Customer/207119551\",\n        \"smsMarketingConsent\": {\n          \"marketingState\": \"SUBSCRIBED\",\n          \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n  customerSmsMarketingConsentUpdate(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    customer {\n      id\n      phone\n      smsMarketingConsent {\n        marketingState\n        marketingOptInLevel\n        consentUpdatedAt\n        consentCollectedFrom\n      }\n    }\n  }\n}"
        

  input: {
    "input": {
      "customerId": "gid://shopify/Customer/207119551",
      "smsMarketingConsent": {
        "marketingState": "SUBSCRIBED",
        "marketingOptInLevel": "SINGLE_OPT_IN"
      }
    }
  }

  response: {
    "data": {
      "customerSmsMarketingConsentUpdate": {
        "userErrors": [],
        "customer": {
          "id": "gid://shopify/Customer/207119551",
          "phone": "+16136120707",
          "smsMarketingConsent": {
            "marketingState": "SUBSCRIBED",
            "marketingOptInLevel": "SINGLE_OPT_IN",
            "consentUpdatedAt": "2024-09-12T01:08:05Z",
            "consentCollectedFrom": "OTHER"
          }
        }
      }
    }
  }

  Subscribe a customer to SMS marketing materials with the date at which the consent was collected

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) { customerSmsMarketingConsentUpdate(input: $input) { userErrors { field message } customer { id phone smsMarketingConsent { marketingState marketingOptInLevel consentUpdatedAt consentCollectedFrom } } } }\",\n \"variables\": {\n    \"input\": {\n      \"customerId\": \"gid://shopify/Customer/207119551\",\n      \"smsMarketingConsent\": {\n        \"marketingState\": \"UNSUBSCRIBED\",\n        \"marketingOptInLevel\": \"SINGLE_OPT_IN\",\n        \"consentUpdatedAt\": \"2021-01-07T15:50:00Z\"\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n      customerSmsMarketingConsentUpdate(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        customer {\n          id\n          phone\n          smsMarketingConsent {\n            marketingState\n            marketingOptInLevel\n            consentUpdatedAt\n            consentCollectedFrom\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"customerId\": \"gid://shopify/Customer/207119551\",\n        \"smsMarketingConsent\": {\n          \"marketingState\": \"UNSUBSCRIBED\",\n          \"marketingOptInLevel\": \"SINGLE_OPT_IN\",\n          \"consentUpdatedAt\": \"2021-01-07T15:50:00Z\"\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"customerId\": \"gid://shopify/Customer/207119551\",\n    \"smsMarketingConsent\": {\n      \"marketingState\": \"UNSUBSCRIBED\",\n      \"marketingOptInLevel\": \"SINGLE_OPT_IN\",\n      \"consentUpdatedAt\": \"2021-01-07T15:50:00Z\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"customerId\" => \"gid://shopify/Customer/207119551\",\n    \"smsMarketingConsent\" => [\n      \"marketingState\" => \"UNSUBSCRIBED\",\n      \"marketingOptInLevel\" => \"SINGLE_OPT_IN\",\n      \"consentUpdatedAt\" => \"2021-01-07T15:50:00Z\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"customerId\": \"gid://shopify/Customer/207119551\",\n        \"smsMarketingConsent\": {\n          \"marketingState\": \"UNSUBSCRIBED\",\n          \"marketingOptInLevel\": \"SINGLE_OPT_IN\",\n          \"consentUpdatedAt\": \"2021-01-07T15:50:00Z\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n  customerSmsMarketingConsentUpdate(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    customer {\n      id\n      phone\n      smsMarketingConsent {\n        marketingState\n        marketingOptInLevel\n        consentUpdatedAt\n        consentCollectedFrom\n      }\n    }\n  }\n}"
        

  input: {
    "input": {
      "customerId": "gid://shopify/Customer/207119551",
      "smsMarketingConsent": {
        "marketingState": "UNSUBSCRIBED",
        "marketingOptInLevel": "SINGLE_OPT_IN",
        "consentUpdatedAt": "2021-01-07T15:50:00Z"
      }
    }
  }

  response: {
    "data": {
      "customerSmsMarketingConsentUpdate": {
        "userErrors": [],
        "customer": {
          "id": "gid://shopify/Customer/207119551",
          "phone": "+16136120707",
          "smsMarketingConsent": {
            "marketingState": "UNSUBSCRIBED",
            "marketingOptInLevel": "SINGLE_OPT_IN",
            "consentUpdatedAt": "2021-01-07T15:50:00Z",
            "consentCollectedFrom": "OTHER"
          }
        }
      }
    }
  }

  Unsubscribe a customer from SMS marketing materials

          Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) { customerSmsMarketingConsentUpdate(input: $input) { userErrors { field message } customer { id phone smsMarketingConsent { marketingState marketingOptInLevel consentUpdatedAt consentCollectedFrom } } } }\",\n \"variables\": {\n    \"input\": {\n      \"customerId\": \"gid://shopify/Customer/207119551\",\n      \"smsMarketingConsent\": {\n        \"marketingState\": \"UNSUBSCRIBED\",\n        \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n      }\n    }\n  }\n}'\n"
          Node example: "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n  data: {\n    \"query\": `mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n      customerSmsMarketingConsentUpdate(input: $input) {\n        userErrors {\n          field\n          message\n        }\n        customer {\n          id\n          phone\n          smsMarketingConsent {\n            marketingState\n            marketingOptInLevel\n            consentUpdatedAt\n            consentCollectedFrom\n          }\n        }\n      }\n    }`,\n    \"variables\": {\n      \"input\": {\n        \"customerId\": \"gid://shopify/Customer/207119551\",\n        \"smsMarketingConsent\": {\n          \"marketingState\": \"UNSUBSCRIBED\",\n          \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n        }\n      }\n    },\n  },\n});\n"
          Ruby example: "session = ShopifyAPI::Auth::Session.new(\n  shop: \"your-development-store.myshopify.com\",\n  access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n  session: session\n)\n\nquery = <<~QUERY\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"input\": {\n    \"customerId\": \"gid://shopify/Customer/207119551\",\n    \"smsMarketingConsent\": {\n      \"marketingState\": \"UNSUBSCRIBED\",\n      \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n    }\n  }\n}\n\nresponse = client.query(query: query, variables: variables)\n"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"input\" => [\n    \"customerId\" => \"gid://shopify/Customer/207119551\",\n    \"smsMarketingConsent\" => [\n      \"marketingState\" => \"UNSUBSCRIBED\",\n      \"marketingOptInLevel\" => \"SINGLE_OPT_IN\",\n    ],\n  ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
          Remix example: "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n    customerSmsMarketingConsentUpdate(input: $input) {\n      userErrors {\n        field\n        message\n      }\n      customer {\n        id\n        phone\n        smsMarketingConsent {\n          marketingState\n          marketingOptInLevel\n          consentUpdatedAt\n          consentCollectedFrom\n        }\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"input\": {\n        \"customerId\": \"gid://shopify/Customer/207119551\",\n        \"smsMarketingConsent\": {\n          \"marketingState\": \"UNSUBSCRIBED\",\n          \"marketingOptInLevel\": \"SINGLE_OPT_IN\"\n        }\n      }\n    },\n  },\n);\n\nconst data = await response.json();\n"
          Graphql query: "mutation customerSmsMarketingConsentUpdate($input: CustomerSmsMarketingConsentUpdateInput!) {\n  customerSmsMarketingConsentUpdate(input: $input) {\n    userErrors {\n      field\n      message\n    }\n    customer {\n      id\n      phone\n      smsMarketingConsent {\n        marketingState\n        marketingOptInLevel\n        consentUpdatedAt\n        consentCollectedFrom\n      }\n    }\n  }\n}"
        

  input: {
    "input": {
      "customerId": "gid://shopify/Customer/207119551",
      "smsMarketingConsent": {
        "marketingState": "UNSUBSCRIBED",
        "marketingOptInLevel": "SINGLE_OPT_IN"
      }
    }
  }

  response: {
    "data": {
      "customerSmsMarketingConsentUpdate": {
        "userErrors": [],
        "customer": {
          "id": "gid://shopify/Customer/207119551",
          "phone": "+16136120707",
          "smsMarketingConsent": {
            "marketingState": "UNSUBSCRIBED",
            "marketingOptInLevel": "SINGLE_OPT_IN",
            "consentUpdatedAt": "2024-09-12T01:08:05Z",
            "consentCollectedFrom": "OTHER"
          }
        }
      }
    }
  }