Anchor to section titled 'undefined'customer
customer
mutation
Unstable
Requires write access scope. Also: User needs customers permission.
Sends a link to the customer so they can update a specific payment method.
Anchor to section titled 'Arguments'
Arguments
The payment method to be updated.
Specifies the payment method update email fields.
Was this section helpful?
Anchor to section titled 'CustomerPaymentMethodSendUpdateEmailPayload returns'
CustomerPaymentMethodSendUpdateEmailPayload returns
The customer to whom an update payment method email was sent.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: customerPaymentMethodSendUpdateEmail
Query Reference for MUTATION: customerPaymentMethodSendUpdateEmail
"mutation customerPaymentMethodSendUpdateEmail($customerPaymentMethodId: ID!) {\n customerPaymentMethodSendUpdateEmail(customerPaymentMethodId: $customerPaymentMethodId) {\n customer {\n # Customer fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: customerPaymentMethodSendUpdateEmail
"{\n \"customerPaymentMethodId\": \"gid://shopify/<objectName>/10079785100\",\n \"email\": {\n \"bcc\": [\n \"<your-bcc>\"\n ],\n \"body\": \"<your-body>\",\n \"customMessage\": \"<your-customMessage>\",\n \"from\": \"<your-from>\",\n \"subject\": \"<your-subject>\",\n \"to\": \"<your-to>\"\n }\n}"Schema Reference for MUTATION: customerPaymentMethodSendUpdateEmail
"input EmailInput {\n bcc: [String!]\n body: String\n customMessage: String\n from: String\n subject: String\n to: String\n}\n"Display Examples for MUTATION: customerPaymentMethodSendUpdateEmail
[
{
"example": {
"type_name": "customerpaymentmethodsendupdateemail",
"title": "Send an email with only the customer payment method id",
"query_string": "mutation sendCustomerPaymentUpdateEmail($customerPaymentMethodId: ID!) {\n customerPaymentMethodSendUpdateEmail(customerPaymentMethodId: $customerPaymentMethodId) {\n customer {\n id\n }\n userErrors {\n field\n message\n }\n }\n}",
"query_arguments": {
"customerPaymentMethodId": "$customerPaymentMethodId"
},
"variables": {
"customerPaymentMethodId": "gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff"
},
"response": {
"data": {
"customerPaymentMethodSendUpdateEmail": {
"customer": {
"id": "gid://shopify/Customer/544365967"
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2023-10",
"maximum_api_version": "unstable",
"location": "/components/customers/test/unit/graph_api/admin/mutations/customer_payment_method_send_update_email_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation sendCustomerPaymentUpdateEmail($customerPaymentMethodId: ID!) { customerPaymentMethodSendUpdateEmail(customerPaymentMethodId: $customerPaymentMethodId) { customer { id } userErrors { field message } } }\",\n \"variables\": {\n \"customerPaymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\"\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation sendCustomerPaymentUpdateEmail($customerPaymentMethodId: ID!) {\n customerPaymentMethodSendUpdateEmail(customerPaymentMethodId: $customerPaymentMethodId) {\n customer {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"customerPaymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\"\n },\n },\n);\n\nconst data = await response.json();\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 sendCustomerPaymentUpdateEmail($customerPaymentMethodId: ID!) {\n customerPaymentMethodSendUpdateEmail(customerPaymentMethodId: $customerPaymentMethodId) {\n customer {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"customerPaymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\"\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation sendCustomerPaymentUpdateEmail($customerPaymentMethodId: ID!) {\n customerPaymentMethodSendUpdateEmail(customerPaymentMethodId: $customerPaymentMethodId) {\n customer {\n id\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"customerPaymentMethodId\": \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\"\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation sendCustomerPaymentUpdateEmail($customerPaymentMethodId: ID!) {\n customerPaymentMethodSendUpdateEmail(customerPaymentMethodId: $customerPaymentMethodId) {\n customer {\n id\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"customerPaymentMethodId\" => \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\",\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "customerPaymentMethodId",
"description": "The payment method to be updated.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "customerPaymentMethodId",
"argValue": " \"gid://shopify/CustomerPaymentMethod/b7cc6e3267aace169e516ed48be72dff\"",
"typeKind": "MUTATION"
}
]
}
]