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 unknownrequired

List of user invitations

culturestring

Culture

Examples

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

{
  "invitations": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ],
  "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": [
    {
      "int": 1234,
      "string": "some text",
      "boolean": true
    }
  ],
  "culture": "some text"
}'

Responses

200

List of users

idstringformat: uuid

displayNamestring

titlestring

avatarstring

avatarOriginalstring

avatarMaxstring

avatarMediumstring

avatarSmallstring

profileUrlstring

hasAvatarboolean

isAnonimboolean

401

Unauthorized

403

Forbidden