Create app card item

POST 
/v2/boards/:board_id/app_cards

Adds an app 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 app card item data, such as the title, description, or fields.

description string

A short text description to add context about the app card.

fields

object[]

Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.

Array [

fillColor string

Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card.

iconShape string

Possible values: [round, square]

Default value: round

The shape of the icon on the preview field.

iconUrl string

A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: JPG/JPEG, PNG, SVG.

textColor string

Hex value representing the color of the text string assigned to value.

tooltip string

A short text displayed in a tooltip when clicking or hovering over the preview field.

value string

The actual data value of the custom field. It can be any type of information that you want to convey.

]

status string

Possible values: [disconnected, connected, disabled]

Default value: disconnected

Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns disabled.

title string

Default value: sample app card item

A short text header to identify the app card.

style

object

Contains information about the style of an app card item, such as the fill color.

fillColor string

Hex value of the border color of the app 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

App card item created

application/json

Schema

Schema

id stringrequired

Unique identifier (ID) of an item.

data

object

Contains app card item data, such as the title, description, or fields.

description string

A short text description to add context about the app card.

fields

object[]

Array where each object represents a custom preview field. Preview fields are displayed on the bottom half of the app card in the compact view.

Array [

fillColor string

Hex value representing the color that fills the background area of the preview field, when it's displayed on the app card.

iconShape string

Possible values: [round, square]

Default value: round

The shape of the icon on the preview field.

iconUrl string

A valid URL pointing to an image available online. The transport protocol must be HTTPS. Possible image file formats: JPG/JPEG, PNG, SVG.

textColor string

Hex value representing the color of the text string assigned to value.

tooltip string

A short text displayed in a tooltip when clicking or hovering over the preview field.

value string

The actual data value of the custom field. It can be any type of information that you want to convey.

]

owned boolean

Defines whether the card is owned by the application making the call.

status string

Possible values: [disconnected, connected, disabled]

Status indicating whether an app card is connected and in sync with the source. When the source for the app card is deleted, the status returns disabled.

title string

A short text header to identify the app card.

style

object

Contains information about the style of an app card item, such as the fill color.

fillColor string

Hex value of the border color of the app 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": {
    "description": "Sample app card description",
    "fields": [
      {
        "fillColor": "#2fa9e3",
        "iconShape": "round",
        "iconUrl": "https://cdn-icons-png.flaticon.com/512/5695/5695864.png",
        "textColor": "#1a1a1a",
        "tooltip": "Completion status indicator",
        "value": "Status: in progress"
      }
    ],
    "owned": true,
    "status": "disconnected",
    "title": "sample app card item"
  },
  "style": {
    "fillColor": "#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": "app_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...