Share board

POST 
/v2/boards/:board_id/members

Shares the board and Invites new members to collaborate on a board by sending an invitation email. Depending on the board's Sharing policy, there might be various scenarios where membership in the team is required in order to share the board with a user.

Required scope

boards:write

Rate limiting

Level 3

Request

Path Parameters

board_id stringrequired

Unique identifier (ID) of the board to which the board member belongs.

application/json

Body

required

emails string[]required

Possible values: >= 1, <= 20

Email IDs of the users you want to invite to the board. You can invite up to 20 members per call.

role string

Possible values: [viewer, commenter, editor, coowner, owner]

Default value: commenter

Role of the board member.

message string

The message that will be sent in the invitation email.

Responses

201

Board members invited

application/json

Schema

Schema

failed

object[]

Contains information about the invites that failed.

Array [

email string

Email ID for which the invitation failed.

reason string

Reason why the invitation failed.

]

successful int64[]

Contains information about the invites that were successfully sent.

Example (from schema)

{
  "failed": [
    {
      "email": "john.smith.demo@miro.com",
      "reason": "INVITATION_FAILED"
    }
  ],
  "successful": 3074457350804038700
}

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