Create an API key

POST/api-keys

The s0_ token is returned once. sending_access keys may only send; add domain_id to restrict sending to one domain, or inbox_id for an agent key scoped to one inbox.

Authorization

apiKey

AuthorizationBearer <token>

A project API key: Authorization: Bearer s0_…

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name*string

Length1 <= length <= 50

permission?string

Default"full_access"

Value in

"full_access"
"sending_access"

domain_id?string

Stamp0 dom_ identifier

Match^dom_[0-9A-Za-z]{16}$

inbox_id?string

Stamp0 ibx_ identifier

Match^ibx_[0-9A-Za-z]{16}$

Response Body

`application/json`

curl -X POST "https://example.com/api-keys" \  -H "Content-Type: application/json" \  -d '{    "name": "string"  }'

{  "id": "string",  "token": "string"}

Create an API key

AuthorizationCopy Anchor Link

Request BodyCopy Anchor Link

Response BodyCopy Anchor Link

200application/json

400application/json

401application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

Authorization

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`