Anchor to section titled 'undefined'

customerAccessTokenDelete
mutation

Requires unauthenticated_write_customers access scope.

Permanently destroys a customer access token.

Anchor to section titled 'Arguments'

Arguments

Anchor to customerAccessToken
customerAccessToken
String!
required

The access token used to identify the customer.

Was this section helpful?
Anchor to section titled 'CustomerAccessTokenDeletePayload returns'

CustomerAccessTokenDeletePayload returns

Anchor to CustomerAccessTokenDeletePayload.deletedAccessToken
deletedAccessToken
String

The destroyed access token.

Anchor to CustomerAccessTokenDeletePayload.deletedCustomerAccessTokenId
deletedCustomerAccessTokenId
String

ID of the destroyed customer access token.

Anchor to CustomerAccessTokenDeletePayload.userErrors
userErrors
[UserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?
Hide code
Mutation reference
Copy
mutation customerAccessTokenDelete($customerAccessToken: String!) {
  customerAccessTokenDelete(customerAccessToken: $customerAccessToken) {
    deletedAccessToken
    deletedCustomerAccessTokenId
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "customerAccessToken": "<your-customerAccessToken>"
}