customerPaymentMethodSendUpdateEmail mutation

Sends a link to the customer so they can update a specific payment method.

Required access

write_customers access scope.

On this page

• Interactive example
• Arguments
• EmailInput fields
• Return fields

Interactive example

This is an example mutation query. Use the embedded interactive tool below to edit the query.

Hint: use Ctrl + Space for autocompleting fields.

<font style="color:#1F61A0;">customer</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">id</font>
<font style="color:#555555;">}</font>
<font style="color:#1F61A0;">userErrors</font> <font style="color:#555555;">{</font>
  <font style="color:#1F61A0;">field</font>
  <font style="color:#1F61A0;">message</font>
<font style="color:#555555;">}</font>

Arguments

EmailInput fields

• bcc ([[String!]](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Specifies any bcc recipients for the email.
• body ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Specifies the email body.
• customMessage ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Specifies a custom message to include in the email.
• from ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Specifies the email sender.
• subject ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Specifies the email subject.
• to ([String](https://shopify.dev/docs/admin-api/graphql/reference/scalar#string-2021-01))
  Specifies the email recipient.

Return fields

• customer ([Customer](https://shopify.dev/docs/admin-api/graphql/reference/customers/customer))
  The customer to whom an update payment method email was sent.
• userErrors ([[UserError!]!](https://shopify.dev/docs/admin-api/graphql/reference/usererror))
  List of errors that occurred executing the mutation.