Skip to main content
POST
/
api
/
v1
/
customers
/
{id_or_alias}
/
portal-token
Generate a portal token for a customer
curl --request POST \
  --url https://api.example.com/api/v1/customers/{id_or_alias}/portal-token \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "expires_in_seconds": 1
}
'
{
  "portal_url": "<string>",
  "token": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
id_or_alias
string
required

customer ID or alias

Body

application/json
​
expires_in_seconds
integer<int32> | null

Token lifetime in seconds. Defaults to 86400 (24 hours). Must be between 60 and 2592000 (30 days).

Required range: x >= 0

Response

Portal token generated

​
portal_url
string
required

Base URL of the customer portal

​
token
string
required

JWT token for portal access