CustomerAccessToken
object

Choose a version:

Requires unauthenticated_read_customers access scope.

A CustomerAccessToken represents the unique token required to make modifications to the customer object.

Anchor to section titled 'Fields'

Fields

Anchor to CustomerAccessToken.accessToken accessToken String! non-null: The customer’s access token.
Anchor to CustomerAccessToken.expiresAt expiresAt DateTime! non-null: The date and time when the customer access token expires.

Was this section helpful?

Anchor to section titled 'Mutations'

Mutations

Anchor to customerAccessTokenCreate customerAccessTokenCreate mutation: Creates a customer access token. The customer access token is required to modify the customer object in any way.
Anchor to customerAccessTokenCreateWithMultipass customerAccessTokenCreateWithMultipass mutation: Creates a customer access token using a multipass token instead of email and password. A customer record is created if the customer doesn't exist. If a customer record already exists but the record is disabled, then the customer record is enabled.
Anchor to customerAccessTokenRenew customerAccessTokenRenew mutation: Renews a customer access token.

Access token renewal must happen before a token expires. If a token has already expired, a new one should be created instead via customerAccessTokenCreate.
Anchor to customerActivateByUrl customerActivateByUrl mutation: Activates a customer with the activation url received from customerCreate.
Anchor to customerActivate customerActivate mutation: Activates a customer.
Anchor to customerResetByUrl customerResetByUrl mutation: "Resets a customer’s password with the reset password URL received from a reset password email. You can send a reset password email with the customerRecover mutation."
Anchor to customerReset customerReset mutation: "Resets a customer’s password with the token received from a reset password email. You can send a reset password email with the customerRecover mutation."
Anchor to customerUpdate customerUpdate mutation: Updates an existing customer.

Was this section helpful?

<~>

CustomerAccessToken Mutations

CustomerAccessToken

CustomerAccessTokenobject

Fields

Mutations

Mutated by

CustomerAccessToken
object