Sign in
Labels

Create label

Creates a label within a board. Requires board editor permissions.

post/boards/{boardId}/labels

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/boards/{boardId}/labels
  • Auth: one of:
    • HTTP bearer
    • API key in header X-Api-Key

Path parameters

boardIdstring required
Example:1357158568008091264

ID of the board to create the label in

Request body

positionnumber required

Position of the label within the board

namestring nullable

Name/title of the label

color'muddy-grey' | 'autumn-leafs' | 'morning-sky' | 'antique-blue' | 'egg-yellow' | 'desert-sand' | 'dark-granite' | 'fresh-salad' | 'lagoon-blue' | 'midnight-blue' | 'light-orange' | 'pumpkin-orange' | 'light-concrete' | 'sunny-grass' | 'navy-blue' | 'lilac-eyes' | 'apricot-red' | 'orange-peel' | 'silver-glint' | 'bright-moss' | 'deep-ocean' | 'summer-sky' | 'berry-red' | 'light-cocoa' | 'grey-stone' | 'tank-green' | 'coral-green' | 'sugar-plum' | 'pink-tulip' | 'shady-rust' | 'wet-rock' | 'wet-moss' | 'turquoise-sea' | 'lavender-fields' | 'piggy-red' | 'light-mud' | 'gun-metal' | 'modern-green' | 'french-coast' | 'sweet-lilac' | 'red-burgundy' | 'pirate-gold' required

Color of the label

Example request

{
  "position": 65536,
  "name": "Bug",
  "color": "berry-red"
}

Response

Label created successfully

Example response

{
  "item": {
    "id": "1357158568008091264",
    "boardId": "1357158568008091265",
    "position": 65536,
    "name": "Bug",
    "color": "berry-red",
    "createdAt": "2024-01-01T00:00:00.000Z",
    "updatedAt": "2024-01-01T00:00:00.000Z"
  }
}

Changes

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