POST/embed/sessions

Mint an embed session for a customer account

Requires Bearer authentication. See Authentication.

Request body

Field	Type	Description
`customerExternalId`required	string	—
`customerName`required	string	—
`permissions`required	string[]	—
`ttlSeconds`	integer	—
`metadata`	object (record)	—
`allowedTypes`	string[]	—

Responses

201 201

Field	Type	Description
`token`required	string	—
`expiresAt`required	string	—
`customerAccountId`required	string (uuid)	—

400 400

Field Type Description

errorrequired object —

`code`required	string	—
`message`required	string	—
`details`	any	—

Errors

Errors use the standard envelope. See Errors for codes, status mappings, and retry semantics.

Request

curl -X POST https://api.pushrail.io/embed/sessions \
  -H "Authorization: Bearer pk_live_..." \
  -H "Content-Type: application/json" \
  -d '  {
    "customerExternalId": "string",
    "customerName": "string",
    "permissions": [
      "string"
    ],
    "ttlSeconds": 3600,
    "metadata": {},
    "allowedTypes": [
      "string"
    ]
  }'

Response · 201201

{
  "token": "string",
  "expiresAt": "string",
  "customerAccountId": "00000000-0000-0000-0000-000000000000"
}

Response · 400400

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null
  }
}