BEbetagouv
labels

POST /api/v1.0/labels/

Changed on

View and manage labels

Request

  • The document declares no server URL.
  • Auth
    API key in cookie sessionid

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

  • 2319a741f4d2Revision changes
    • breaking

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

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status