Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Create an API key

POST/api-keys
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Request body
requiredapplication/json
namestringrequired
min length 1 · max length 80
permissionstring
default: "full_access"
Allowed:full_accesssending_access
domain_idstring<uuid> | null

Restricts the key to this one verified domain of the team: a GET /domains row with shared: false. The key sends only from it and reads and changes only that domain's own resources: its emails, its broadcasts, topics and segments bound to it, its opt-outs, its inboxes and received mail, its own GET, PATCH, DELETE and verify of /domains/{id}, its metrics, and the keys held to the same domain (GET and DELETE /api-keys). Everything that belongs to the team as a whole answers 403 restricted_api_key: webhooks, suppressions, templates, contact properties, /usage, /deliverability, /verifications and POST /domains. Omitted or null, the key inherits the calling key's scope: all domains, or the calling key's domain if it is domain-scoped. A domain-scoped calling key cannot name any other domain (403 restricted_api_key).

inbox_idstring<uuid> | null

BillionSend extension: restricts the key to one inbox of the team. It reads that inbox's threads, drafts and received mail and sends only from its address; every other route answers 403 restricted_api_key. Needs full_access, can't be combined with domain_id, and an inbox holds at most 5 active keys (outside the team's 25).

Responses
200

API key created; the token is returned only here

idstring<uuid>required
tokenstringrequired
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
403

Restricted API key: a sending_access key, an inbox-scoped key, or a domain_id outside the calling key's domain

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error

statusCodenumberrequired
namestringrequired
messagestringrequired
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Bodyapplication/json
Request
curl -X POST 'https://api.billionsend.com/api-keys' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "permission": "full_access",
  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",
  "inbox_id": "5127f22b-d152-46dd-aeaa-3a852d9fbfc2"
}'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "token": "string"
}

Was this page helpful?