Anchor to section titled 'undefined'

customerAccessTokenRenew
mutation

Requires unauthenticated_write_customers access scope.

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 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 'CustomerAccessTokenRenewPayload returns'

CustomerAccessTokenRenewPayload returns

Anchor to CustomerAccessTokenRenewPayload.customerAccessToken
customerAccessToken
CustomerAccessToken

The renewed customer access token object.

Anchor to CustomerAccessTokenRenewPayload.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 customerAccessTokenRenew($customerAccessToken: String!) {
  customerAccessTokenRenew(customerAccessToken: $customerAccessToken) {
    customerAccessToken {
      # CustomerAccessToken fields
    }
    userErrors {
      field
      message
    }
  }
}
Hide code
Input
Copy
{
  "customerAccessToken": "<your-customerAccessToken>"
}