users

Invite user

Creates a new person in the workspace, or reuses an existing one, and assigns them a role at the chosen locations. A new person gets an email with a link to set their password. When a signed-in user sends the invite, the email goes out only when that user's own email address is verified. An invite made with an API key sends the email in the workspace's name. You cannot grant a role carrying permissions you do not hold yourself.

Notes.

  • Answers 200 (not 201) for a new person too; created tells the two apart.
  • For a signed-in user, the set-password email is sent only when that user's own email address is verified. An invite made with an API key sends the email too, from the workspace (the key's name is not shown). The 30-a-minute limit counts per key for a key.
post/v1/users/invite

Request

  • Base URL: https://api.brixsignage.com
  • URL: https://api.brixsignage.com/v1/users/invite
  • Auth: HTTP bearer

Request body

emailstring required

Stored in lower case.

namestring

Used only when the person is new.

roleIdstring required
nodeIdsstring[] required

Locations to grant the role at. You need user.edit and every permission of the role at each one.

Response

Success.

Changes

No recorded changes to this operation across all 1 revision of this API.