Skip to main content
POST
Create API token

Authorizations

X-Auth-Token
string
header
required

API token generated at Settings > API

Body

application/json
name
string

Descriptive name for the token

expires_at
string<date-time>

Expiration date (null for no expiry)

scopes
enum<string>[]

Permission scopes (empty = full access)

Available options:
templates:read,
templates:write,
submissions:read,
submissions:write,
submissions:draft,
submissions:send,
submissions:remind,
submitters:read,
submitters:write,
audit_events:read,
users:read,
users:write,
account:read,
account:write,
webhooks:read,
webhooks:write
allowed_ips
string[]

IP allowlist (empty = all IPs)

Response

Token created

token
object
raw_token
string

The API token value. Only shown once at creation.