Skip to Content
ReferenceStorefrontv1.3.0 API Reference (Latest)MutationscustomerAccessTokenDelete

customerAccessTokenDelete

Deletes a customer access token, effectively logging out the customer.

Authentication

Authentication Required: Secret API key with scope customer:auth

Mutation Structure

mutation {
  customerAccessTokenDelete(customerAccessToken: String!) {
    deletedAccessToken
    customerUserErrors {
      code
      field
      message
    }
  }
}

Input Arguments

ArgumentTypeRequiredDescription
customerAccessTokenStringYesThe customer access token to delete

Return Type

CustomerAccessTokenDeletePayload - The payload returned after deleting a customer access token, containing the deleted token string and any errors that occurred during the operation.

Example

mutation {
  customerAccessTokenDelete(customerAccessToken: "eyJhbGciOiJIUzI1NiJ9.eyJkYXRhIjoiY3VzdG9tZXJfYWNjZXNzX3Rva2VuXzEyMzQ1Njc4OTAifQ.signature") {
    deletedAccessToken
    customerUserErrors {
      code
      field
      message
    }
  }
}