Sign in
labels

View and manage labels

post/api/v1.0/labels/

Request body

namestring required

Name of the label/folder (can use slashes for hierarchy, e.g. 'Work/Projects')

colorstring

Color of the label in hex format (e.g. #FF0000)

mailboxstring uuid required

Mailbox that owns this label

threadsstring[]

Threads that have this label

descriptionstring

Description of the label, used by AI to understand its purpose

is_autoboolean

Whether this label should be automatically applied by AI

Response

Created label

idstring uuid required

primary key for the record as UUID

namestring required

Name of the label/folder (can use slashes for hierarchy, e.g. 'Work/Projects')

slugstring required

URL-friendly version of the name

colorstring

Color of the label in hex format (e.g. #FF0000)

display_namestring required
mailboxstring uuid required

Mailbox that owns this label

threadsstring[]

Threads that have this label

descriptionstring

Description of the label, used by AI to understand its purpose

is_autoboolean

Whether this label should be automatically applied by AI

Changes

Changed in 1 of the 54 revisions of this API.19

  • 75dbb02c61c019See the full diff
    • ▲

      the response's body type/format changed from array/ to object/ for status 201

      response-body-type-changed

    • ○

      added the optional property color to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property description to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property is_auto to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property threads to the response with the 201 status

      response-optional-property-added

    • ○

      added the required property display_name to the response with the 201 status

      response-required-property-added

    • ○

      added the required property id to the response with the 201 status

      response-required-property-added

    • ○

      added the required property mailbox to the response with the 201 status

      response-required-property-added

    • ○

      added the required property name to the response with the 201 status

      response-required-property-added

    • ○

      added the required property slug to the response with the 201 status

      response-required-property-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog