Create tag

POST 
/v2/boards/:board_id/tags

Creates a tag on a board.

Required scope

boards:write

Rate limiting

Level 1

Request

Path Parameters

board_id stringrequired

Unique identifier (ID) of the board where you want to create the tag.

application/json

Body

required

fillColor string

Possible values: [red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black]

Default value: red

Fill color for the tag.

title stringrequired

Possible values: <= 120 characters

Text of the tag. Case-sensitive. Must be unique.

Responses

201

Tag created

application/json

Schema

Schema

id stringrequired

Unique identifier of the tag.

title stringrequired

Text of the tag

fillColor stringrequired

Possible values: [red, light_green, cyan, yellow, magenta, green, blue, gray, violet, dark_green, dark_blue, black]

Background color of the tag.

links

object

Contains applicable links for the current object.

self string

Link to obtain more information about the current object.

type stringrequired

Type of the object that is returned. In this case, type returns tag.

Example (from schema)

{
  "id": "3074457363306854000",
  "title": "delayed",
  "fillColor": "red",
  "links": {
    "self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
  },
  "type": "string"
}

400

Malformed request

application/json

Schema

Schema

code string

Code of the error

message string

Description of the error

status int32

Status code of the error

type string

Type of the error

Example (from schema)

{
  "code": "error",
  "message": "Error message",
  "status": 400,
  "type": "error"
}

404

Not found

application/json

Schema

Schema

code string

Code of the error

message string

Description of the error

status int32

Status code of the error

type string

Type of the error

Example (from schema)

{
  "code": "error",
  "message": "Error message",
  "status": 400,
  "type": "error"
}

429

Too many requests

application/json

Schema

Schema

code string

Code of the error

message string

Description of the error

status int32

Status code of the error

type string

Type of the error

Example (from schema)

{
  "code": "error",
  "message": "Error message",
  "status": 400,
  "type": "error"
}

Loading...