Invite users

POST /api/2.0/people/invite

Request

Invites users specified in the request to the current portal.

Authorization

An API key is a token that you provide when making API calls. Include the token in a cookie parameter called asc_auth_key.

Example: asc_auth_key=864FE52C-1C1C-469F-9308-51DAFEFE7436.

Headers

Acceptenum of string

Can be one of: application/json, text/json, text/plain.

Content-Typeenum of string

Can be one of: application/json, application/*+json, text/json.

Body

Request parameters for inviting users

invitationsarray of objectrequired

List of user invitations

emailstringformat: email

Email address

typeone of

.enum of string

[All - All, RoomAdmin - Room admin, Guest - Guest, DocSpaceAdmin - DocSpace admin, User - User]

Can be one of: All, RoomAdmin, Guest, DocSpaceAdmin, User.

.enum of integer

[0 - All, 1 - Room admin, 2 - Guest, 3 - DocSpace admin, 4 - User]

Can be one of: 0, 1, 2, 3, 4.

culturestring

Culture

Examples

POST /api/2.0/people/invite HTTP/1.1
Accept: application/json
Content-Length: 126
Content-Type: application/json
Host: example.com

{
  "invitations": [
    {
      "value": {
        "email": "Adele94@gmail.com"
      }
    }
  ],
  "culture": "some text"
}

curl --request POST \
  --url https://example.com/api/2.0/people/invite \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "invitations": [
    {
      "value": {
        "email": "Adele94@gmail.com"
      }
    }
  ],
  "culture": "some text"
}'

Responses

200

List of users

idstringformat: uuid

ID

displayNamestring

Display name

titlestring

Title

avatarstring

Avatar

avatarOriginalstring

Original size avatar

avatarMaxstring

Maximum size avatar

avatarMediumstring

Medium size avatar

avatarSmallstring

Small avatar

profileUrlstring

Profile URL

hasAvatarboolean

Specifies if the user has an avatar or not

isAnonimboolean

Specifies if the user is an anonim or not

401

Unauthorized

403

No permissions to perform this action