Inboxes

Create a label

A named, colored tag on one inbox. Names are unique per inbox, ignoring case; an inbox holds up to 100 labels. color defaults to mauve. Organising mail needs only the inbound:read scope.

post/v1/inboxes/{inbox_id}/labels

Request

  • Base URL: https://smtpfa.st/api
  • URL: https://smtpfa.st/api/v1/inboxes/{inbox_id}/labels
  • Auth: HTTP bearer

Path parameters

inbox_idstring required

The inbox id or its email address

Request body

namestring required
color'cyan' | 'teal' | 'grass' | 'lime' | 'yellow' | 'orange' | 'iris' | 'plum' | 'crimson' | 'bronze' | 'mauve'

Response

The new label

objectstring
idstring
namestring
color'cyan' | 'teal' | 'grass' | 'lime' | 'yellow' | 'orange' | 'iris' | 'plum' | 'crimson' | 'bronze' | 'mauve'
created_atstring date-time

Example response

{
  "object": "inbox_label",
  "name": "Urgent"
}

Changes

No recorded changes to this operation across all 1 revision of this API.