Create connector

POST 
/v2/boards/:board_id/connectors

Adds a connector to a board.

Required scope

boards:write

Rate limiting

Level 2

Request

Path Parameters

board_id stringrequired

Unique identifier (ID) of the board for which you want to create the connector.

application/json

Body

required

startItem

object

required

The end point of the connector. endItem.id must be different from startItem.id

id string

Unique identifier (ID) of the item to which you want to attach the connector. Note that Frames are not supported at the moment.

position

object

The relative position of the point on an item where the connector is attached. Position with x=0% and y=0% correspond to the top-left corner of the item, x=100% and y=100% correspond to the right-bottom corner.

x string

X-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

y string

Y-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

snapTo string

Possible values: [auto, top, right, bottom, left]

The side of the item connector should be attached to, the connection point will be placed in the middle of that side. Option auto allows to pick a connection point automatically. Only either position or snapTo parameter is allowed to be set, if neither provided snapTo: auto will be used by default.

endItem

object

required

The end point of the connector. endItem.id must be different from startItem.id

id string

Unique identifier (ID) of the item to which you want to attach the connector. Note that Frames are not supported at the moment.

position

object

The relative position of the point on an item where the connector is attached. Position with x=0% and y=0% correspond to the top-left corner of the item, x=100% and y=100% correspond to the right-bottom corner.

x string

X-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

y string

Y-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

snapTo string

Possible values: [auto, top, right, bottom, left]

The side of the item connector should be attached to, the connection point will be placed in the middle of that side. Option auto allows to pick a connection point automatically. Only either position or snapTo parameter is allowed to be set, if neither provided snapTo: auto will be used by default.

shape string

Possible values: [straight, elbowed, curved]

The path type of the connector line, defines curvature. Default: curved.

captions

object[]

Possible values: <= 20 characters, <= 20

Blocks of text you want to display on the connector.

Array [

content stringrequired

Possible values: <= 200 characters

The text you want to display on the connector. Supports inline HTML tags.

position string

The relative position of the text on the connector, in percentage, minimum 0%, maximum 100%. With 50% value, the text will be placed in the middle of the connector line. Default: 50%

textAlignVertical string

Possible values: [top, middle, bottom]

The vertical position of the text on the connector. Default: middle

]

style

object

Contains information about the style of a connector, such as the color or caption font size

color string

Hex value representing the color for the captions on the connector. Default: #1a1a1a

endStrokeCap string

Possible values: [none, stealth, diamond, filled_diamond, oval, filled_oval, arrow, triangle, filled_triangle, erd_one, erd_many, erd_only_one, erd_zero_or_one, erd_one_or_many, erd_zero_or_many]

The decoration cap of the connector end, like an arrow or circle. Default: stealth.

fontSize string

Possible values: >= 10 and <= 288

Defines the font size, in dp, for the captions on the connector. Default: 14

startStrokeCap string

Possible values: [none, stealth, diamond, filled_diamond, oval, filled_oval, arrow, triangle, filled_triangle, erd_one, erd_many, erd_only_one, erd_zero_or_one, erd_one_or_many, erd_zero_or_many]

The decoration cap of the connector end, like an arrow or circle. Default: none.

strokeColor string

Hex value of the color of the connector line. Default: #000000.

strokeStyle string

Possible values: [normal, dotted, dashed]

The stroke pattern of the connector line. Default: normal.

strokeWidth string

Possible values: >= 1 and <= 24

The thickness of the connector line, in dp. Default: 1.0.

textOrientation string

Possible values: [horizontal, aligned]

The captions orientation relatively to the connector line curvature. Default: aligned.

Responses

200

Connector created

application/json

Schema

Schema

captions

object[]

Blocks of text you want to display on the connector.

Array [

content stringrequired

Possible values: <= 200 characters

The text you want to display on the connector. Supports inline HTML tags.

position string

The relative position of the text on the connector, in percentage, minimum 0%, maximum 100%. With 50% value, the text will be placed in the middle of the connector line. Default: 50%

textAlignVertical string

Possible values: [top, middle, bottom]

The vertical position of the text on the connector. Default: middle

]

createdAt date-time

Date and time when the connector 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.

endItem

object

The starting point of the connector.

id string

Unique identifier (ID) of the item the connector is attached to.

links

object

Contains applicable links for the current object.

self string

Link to obtain more information about the current object.

position

object

The relative position of the point on an item where the connector is attached. Position with x=0% and y=0% correspond to the top-left corner of the item, x=100% and y=100% correspond to the right-bottom corner.

x string

X-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

y string

Y-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

id stringrequired

Unique identifier (ID) of a connector.

isSupported boolean

Indicates whether the connector is supported at the moment. If this parameter returns false, we do not support the connector at the moment. We do not allow updates for unsupported connectors and we might not return all data about the connector, such as intermediate points and connection points to the canvas.

links

object

Contains applicable links for the current object.

self string

Link to obtain more information about the current object.

modifiedAt date-time

Date and time when the connector 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.

shape string

Possible values: [straight, elbowed, curved]

Default value: curved

The path type of the connector line, defines curvature. Default: curved.

startItem

object

The starting point of the connector.

id string

Unique identifier (ID) of the item the connector is attached to.

links

object

Contains applicable links for the current object.

self string

Link to obtain more information about the current object.

position

object

The relative position of the point on an item where the connector is attached. Position with x=0% and y=0% correspond to the top-left corner of the item, x=100% and y=100% correspond to the right-bottom corner.

x string

X-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

y string

Y-axis relative coordinate of the location where the connector connects with an item, in percentage, minimum 0%, maximum 100%.

style

object

Contains information about the style of a connector, such as the color or caption font size

color string

Hex value representing the color for the captions on the connector. Default: #1a1a1a

endStrokeCap string

Possible values: [none, stealth, diamond, filled_diamond, oval, filled_oval, arrow, triangle, filled_triangle, erd_one, erd_many, erd_only_one, erd_zero_or_one, erd_one_or_many, erd_zero_or_many]

The decoration cap of the connector end, like an arrow or circle. Default: stealth.

fontSize string

Possible values: >= 10 and <= 288

Defines the font size, in dp, for the captions on the connector. Default: 14

startStrokeCap string

Possible values: [none, stealth, diamond, filled_diamond, oval, filled_oval, arrow, triangle, filled_triangle, erd_one, erd_many, erd_only_one, erd_zero_or_one, erd_one_or_many, erd_zero_or_many]

The decoration cap of the connector end, like an arrow or circle. Default: none.

strokeColor string

Hex value of the color of the connector line. Default: #000000.

strokeStyle string

Possible values: [normal, dotted, dashed]

The stroke pattern of the connector line. Default: normal.

strokeWidth string

Possible values: >= 1 and <= 24

The thickness of the connector line, in dp. Default: 1.0.

textOrientation string

Possible values: [horizontal, aligned]

The captions orientation relatively to the connector line curvature. Default: aligned.

type string

Type of board object that is returned.

Example (from schema)

{
  "captions": [
    {
      "content": "<p>Caption text</p>",
      "position": "50%",
      "textAlignVertical": "top"
    }
  ],
  "createdAt": "2022-03-30T17:26:50.000Z",
  "createdBy": {
    "id": "3458764517517852417",
    "type": "user"
  },
  "endItem": {
    "id": "3458764517517818867",
    "links": {
      "self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
    },
    "position": {
      "x": "50%",
      "y": "0%"
    }
  },
  "id": "3458764517517818867",
  "isSupported": true,
  "links": {
    "self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
  },
  "modifiedAt": "2022-03-30T17:26:50.000Z",
  "modifiedBy": {
    "id": "3458764517517852417",
    "type": "user"
  },
  "shape": "curved",
  "startItem": {
    "id": "3458764517517818867",
    "links": {
      "self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
    },
    "position": {
      "x": "50%",
      "y": "0%"
    }
  },
  "style": {
    "color": "#9510ac",
    "endStrokeCap": "none",
    "fontSize": "15",
    "startStrokeCap": "none",
    "strokeColor": "#2d9bf0",
    "strokeStyle": "normal",
    "strokeWidth": "2.0",
    "textOrientation": "horizontal"
  },
  "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...