Invite User

POST https://{server_address}/api/v1/organization/users/invite

Invite a new user to a specific organization. This endpoint will send the invitation email to the specified email address.

Headers

Name	Type	Description
Authorization*	Bearer {access_token}
Content-Type*	application/json

Request Body

Name	Example	Description
email*	[email protected]	New user's email, string.
name*	John	New user's name, string.
roleId*	3	New user's role identifier, integer.
orgId	1	Organization, where user should be invited to, integer. The OAuth Client organization is used by default.
locale	en_US	New user's locale, string. The locale is consist of two-letter language code defined by ISO 639-1 (e.g., "en" for English) and a two-letter country code defined by ISO 3166-1 alpha-2 (e.g., "US" for the United States) separated by underscore.

201: User invited

{
   "id": 1078,
   "name": "John Doe",
   "email": "[email protected]",
   "title": "John",
   "nickName": "john",
   "phoneNumber": "[phone]",
   "roleId": 3,
   "orgId": 703,
   "tz": "Europe/Kiev",
   "locale": "en_US",
   "status": "Active",
   "lastModifiedTs": 1702985292062,
   "lastLoggedAt": 1702985292062,
   "registeredAt": 1702985292062,
   "isDev": false
}

404: Organisation is not found

400: Role is not found

400: Email already used

Request examples:

# curl command example:
$ curl -X POST -H "Content-Type: application/json" \
      -H "Authorization: Bearer {accessToken}" \
      -d '{"email":"[email protected]","name":"Test User","roleId":1,"locale":"en_US"}' \
      https://fra1.blynk.cloud/api/v1/organization/users/invite

$ curl -X POST -H "Content-Type: application/json" \
      -H "Authorization: Bearer eIdWHQqRfFmvP5LDDh-IGxPUzi7I27HthzCPAVmS" \
      -d '{"email":"[email protected]","name":"Test User","roleId":1,"locale":"en_US"}' \
      https://fra1.blynk.cloud/api/v1/organization/users/invite