Create card item

POST 
/v2/boards/:board_id/cards

Adds a card item to a board

Required scope

boards:write

Rate limiting

Level 2

Request

Path Parameters

board_id stringrequired

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

application/json

Body

required

data

object

Contains card item data, such as the title, description, due date, or assignee ID.

assigneeId int64

Unique user identifier. In the GUI, the user ID is mapped to the name of the user who is assigned as the owner of the task or activity described in the card. The identifier is numeric, and it is automatically assigned to a user when they first sign up.

description string

A short text description to add context about the card.

dueDate date-time

The date when the task or activity described in the card is due to be completed. In the GUI, users can select the due date from a calendar. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

title string

A short text header for the card.

style

object

Contains information about the style of a card item, such as the card theme.

cardTheme string

Hex value of the border color of the card. Default: #2d9bf0.

position

object

Contains information about the item's position on the board, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

x double

X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

y double

Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

geometry

object

Contains geometrical information about the item, such as its width or height.

height double

Height of the item, in pixels.

rotation double

Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.

width double

Width of the item, in pixels.

parent

object

Contains information about the parent frame for the item.

id int64

Unique identifier (ID) of the parent frame for the item.

Responses

201

Card item created

application/json

Schema

Schema

id stringrequired

Unique identifier (ID) of an item.

data

object

Contains card item data, such as the title, description, due date, or assignee ID.

assigneeId int64

Unique user identifier. In the GUI, the user ID is mapped to the name of the user who is assigned as the owner of the task or activity described in the card. The identifier is numeric, and it is automatically assigned to a user when they first sign up.

description string

A short text description to add context about the card.

dueDate date-time

The date when the task or activity described in the card is due to be completed. In the GUI, users can select the due date from a calendar. Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

title string

A short text header for the card.

style

object

Contains information about the style of a card item, such as the card theme.

cardTheme string

Hex value of the border color of the card. Default: #2d9bf0.

position

object

Contains location information about the item, such as its x coordinate, y coordinate, and the origin of the x and y coordinates.

origin string

Possible values: [center]

Default value: center

Area of the item that is referenced by its x and y coordinates. For example, an item with a center origin will have its x and y coordinates point to its center. The center point of the board has x: 0 and y: 0 coordinates. Currently, only one option is supported.

relativeTo string

Possible values: [canvas_center, parent_top_left]

x double

X-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

y double

Y-axis coordinate of the location of the item on the board. By default, all items have absolute positioning to the board, not the current viewport. Default: 0. The center point of the board has x: 0 and y: 0 coordinates.

geometry

object

Contains geometrical information about the item, such as its width or height.

height double

Height of the item, in pixels.

rotation double

Rotation angle of an item, in degrees, relative to the board. You can rotate items clockwise (right) and counterclockwise (left) by specifying positive and negative values, respectively.

width double

Width of the item, in pixels.

createdAt date-time

Date and time when the item was created.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

createdBy

object

Contains information about the user who created the item.

id string

Unique identifier (ID) of the user.

type string

Indicates the type of object returned. In this case, type returns user.

modifiedAt date-time

Date and time when the item was last modified.
Format: UTC, adheres to ISO 8601, includes a trailing Z offset.

modifiedBy

object

Contains information about the user who last modified the item.

id string

Unique identifier (ID) of the user.

type string

Indicates the type of object returned. In this case, type returns user.

parent

object

Contains information about the parent frame for the item.

id int64

Unique identifier (ID) of the parent frame for the item.

links

object

Contains applicable links for the current object.

self string

Link to obtain more information about the current object.

links

object

Contains applicable links for the item.

related string

Link to obtain information about the child items related to the frame.

self string

Link to obtain information about the current item.

type stringrequired

Type of item that is returned.

Example (from schema)

{
  "id": "3458764517517819000",
  "data": {
    "assigneeId": "3074457362577955300",
    "description": "sample card description",
    "dueDate": "2023-10-12T22:00:55.000Z",
    "title": "sample card item"
  },
  "style": {
    "cardTheme": "#2d9bf0"
  },
  "position": {
    "origin": "center",
    "relativeTo": "canvas_center",
    "x": 100,
    "y": 100
  },
  "geometry": {
    "height": 60,
    "rotation": 0,
    "width": 320
  },
  "createdAt": "2022-03-30T17:26:50.000Z",
  "createdBy": {
    "id": "3458764517517852417",
    "type": "user"
  },
  "modifiedAt": "2022-03-30T17:26:50.000Z",
  "modifiedBy": {
    "id": "3458764517517852417",
    "type": "user"
  },
  "parent": {
    "id": "3074457362577955300",
    "links": {
      "self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
    }
  },
  "links": {
    "related": "http://api.miro.com/v2/boards/o9J_koQspF4=/items?parent_item_id=307445734914369434&limit=10&cursor=",
    "self": "http://api.miro.com/v2/boards/o9J_koQspF4=/item/3074457349143649487"
  },
  "type": "card"
}

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...