Share a whiteboard to new users or team chat channels.

POST {{baseUrl}}/whiteboards/:whiteboardId/collaborator

Use this API to add collaborators to a whiteboard.

Scopes: whiteboard_collaborator:write:admin

Rate Limit Label: MEDIUM

Request Body

{"collaborators"=>[{"email"=>"<string>", "channel_id"=>"<string>", "role"=>0}, {"email"=>"<string>", "channel_id"=>"<string>", "role"=>2}]}

HEADERS

KeyDatatypeRequiredDescription
Content-Typestring
Acceptstring

RESPONSES

status: Created

[{&quot;collaborator_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;collaborator_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatar&quot;:&quot;\u003cstring\u003e&quot;,&quot;role&quot;:1,&quot;collaborator_type&quot;:1},{&quot;collaborator_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;collaborator_name&quot;:&quot;\u003cstring\u003e&quot;,&quot;user_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;channel_id&quot;:&quot;\u003cstring\u003e&quot;,&quot;avatar&quot;:&quot;\u003cstring\u003e&quot;,&quot;role&quot;:3,&quot;collaborator_type&quot;:1}]