Choose a version:

customerAccessTokenDelete

mutation

Requires unauthenticated_write_customers access scope.

Permanently destroys a CustomerAccessToken. Use this mutation when a customer explicitly signs out or when you need to revoke the token. Use customerAccessTokenCreate to generate a new token with the customer's credentials.

Caution

This action is irreversible. The customer needs to sign in again to obtain a new access token.

Anchor to Arguments

Arguments

Anchor to customerAccessTokencustomerAccessToken •String! required: The access token used to identify the customer.

Was this section helpful?

Anchor to CustomerAccessTokenDeletePayload returnsCustomerAccessTokenDeletePayload returns

Anchor to deletedAccessTokendeletedAccessToken •String: The destroyed access token.
Anchor to deletedCustomerAccessTokenIddeletedCustomerAccessTokenId •String: ID of the destroyed customer access token.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

customerAccessTokenDelete reference

Mutation Reference

mutation customerAccessTokenDelete($customerAccessToken: String!) {

customerAccessTokenDelete(customerAccessToken: $customerAccessToken) {

deletedAccessToken

deletedCustomerAccessTokenId

userErrors {

field

message

}

Input

{

"customerAccessToken": "<your-customerAccessToken>"

}