Update board member

PATCH 
/v2/boards/:board_id/members/:board_member_id

Updates the role of a board member.

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 update the role of the board member.

board_member_id stringrequired

Unique identifier (ID) of the board member whose role you want to update.

application/json

Body

required

role string

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

Default value: commenter

Role of the board member.

Responses

200

Board member updated

application/json

Schema

Schema

id stringrequired

Unique identifier (ID) of the user.

name stringrequired

Name of the user.

role string

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

Role of the board member.

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

Example (from schema)

{
  "id": "3074457353169356300",
  "name": "John Smith",
  "role": "viewer",
  "links": {
    "self": "http://api.miro.com/v2/boards/o9J_koQspF4=/object_type/3074457349143649487"
  },
  "type": "board_member"
}

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