Boards

Invite user to board by role

POST
/public-api/v1/Boards/inviteUser/{boardId}
cURL
curl --request POST \
  --url '/public-api/v1/Boards/inviteUser/{boardId}' \
  --header 'user-api-key: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '{
  "Email": "[email protected]",
  "Role": "Contributor",
  "PreventInvitationMail": false
}'

Autorisations

  • user-api-keystringheader

    User's API Key · apiKey

Paramètres de chemin

  • boardIdstringobligatoire

    Board Id

Corps

application/json

Invitation data.

Role valid values: Admin, Contributor, Visitor

  • Emailstringobligatoire

    Email for user

  • Rolestringobligatoire
  • Languagestring

    Email language : fr, en, de

  • PreventInvitationMailboolean

    If true, prevents sending the invitation email to the invited user.

Réponses

OK