Customer Impersonation Token
Create a Token
POST https://api.bigcommerce.com/stores/{store_hash}/v3/storefront/api-token-customer-impersonationRequest
Returns a Storefront API token that allows your application to impersonate customers when making GraphQL POST
requests. For more information on how to use the returned token, see customer impersonation tokens.
Required Scopes
Manage
Storefront API Customer Impersonation Tokens
Authentication
- X-Auth-Token in header
Parameters
- store_hash in path - string
- Accept in header with default of application/json - stringrequiredThe MIME type of the response body.
- Content-Type in header with default of application/json - stringrequiredThe MIME type of the request body.
Body
object | application/json
channel_idinteger
requiredChannel ID for requested tokenMin: 1Example: 1expires_atinteger
requiredUnix timestamp (UTC time) defining when the token should expire. Supports seconds, but does not support milliseconds, microseconds, or nanoseconds.Min: 0Example: 1885635176
example
{
"channel_id": 1,
"expires_at": 1885635176
}
Response
Body
object | application/json
dataobject
example
{
"data": {
"token": "string"
},
"meta": {}
}
Did you find what you were looking for?