Skip to content
Esc
↑↓navigate↵open⌘Jpreview

Create a label

A named, colored tag of one inbox: at most 100, names unique regardless of case. A color is picked when omitted.

POST/inboxes/{inbox_id}/labels
Authorization
AuthorizationBearer token · headerrequired

A BillionSend API key (bs_…).

Path parameters
inbox_idstringrequired

The inbox ID or its email address, such as support@example.com

Request body
requiredapplication/json
namestringrequired

1-64 characters, unique in the inbox regardless of case

colorstring

#RRGGBB; a color is picked when omitted

Responses
201

Label created

idstring<uuid>required
namestringrequired
colorstringrequired

Uppercase #RRGGBB

created_atstringrequired
objectstringrequired
Allowed:inbox_label
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequired
namestringrequired
messagestringrequired
404

Not found

statusCodenumberrequired
namestringrequired
messagestringrequired
422

Validation error, a duplicate name or the 100-label cap

statusCodenumberrequired
namestringrequired
messagestringrequired
429

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

statusCodenumberrequired
namestringrequired
messagestringrequired
Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X POST 'https://api.billionsend.com/inboxes/string/labels' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "color": "string"
}'
Response
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "color": "string",
  "created_at": "string",
  "object": "inbox_label"
}

Was this page helpful?