Sends an invitation email

POST /api/2.0/settings/sendjoininvite

Request

Sends an invitation email with a link to the DocSpace.

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 administrator message settings

emailstringformat: email

Email

culturestring

Culture

Examples

POST /api/2.0/settings/sendjoininvite HTTP/1.1
Accept: application/json
Content-Length: 72
Content-Type: application/json
Host: example.com

{
  "email": "Americo.Bergstrom81@yahoo.com",
  "culture": "some text"
}

curl --request POST \
  --url https://example.com/api/2.0/settings/sendjoininvite \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "email": "Americo.Bergstrom81@yahoo.com",
  "culture": "some text"
}'

Responses

200

Message about sending a link to confirm joining the DocSpace

400

Incorrect email or email already exists

403

No permissions to perform this action

429

Request limit is exceeded