Mailboxes
Create a mailbox label
Creates a label on a mailbox and returns it with status 201.
Creates a label on a mailbox and returns it with status 201. Slugs are unique within the mailbox, and a mailbox holds at most 100 labels; either limit conflicts.
Authorization
apiKey x-api-key<token>
In: header
Path Parameters
id*string
Match
^mbx_[0-9a-hjkmnp-tv-z]{16,24}$Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
slug*string
displayName*string
color?|null|null
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/mailboxes/string/labels" \ -H "Content-Type: application/json" \ -d '{ "slug": "string", "displayName": "string" }'{ "id": "string", "slug": "string", "displayName": "string", "color": "billing", "createdAt": "string", "updatedAt": "string"}