sendJoinInviteMail
StringWrapper sendJoinInviteMail(AdminMessageBaseSettingsRequestDto)
POST /api/2.0/settings/sendjoininvite
Send an invitation email
Sends an invitation email with a join link to the address in the request - the self-registration the sign-in page's register link performs. No token is needed. The portal has to publish a trusted-domain policy first, saved with POST api/2.0/settings/maildomainsettings: without one there is nothing to join and every caller alike is answered with 405 - the same condition GET api/2.0/settings reports as enabledJoin. email has to be a real address written in ASCII rather than an internationalized one, must not already belong to a portal member, and, when the policy names domains rather than accepting all of them, has to end with one of them - each of those faults is refused with 400. culture picks the language of the letter. The invitation is not an account: the invitee becomes a member only after following the link, and the role it grants, user or room administrator, follows the trusted-domain settings and drops to user once the portal's paid places are taken. Where the installation caps invitations, an accepted call spends one of those counted by invitationLimit, and only about a dozen calls from one address in two minutes are accepted. What comes back is a localized confirmation.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| AdminMessageBaseSettingsRequestDto | body | AdminMessageBaseSettingsRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | A localized message confirming that the invitation with the join link has been sent | StringWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no email, the email address is malformed, internationalized or longer than 255 characters, lies outside the trusted domains, or already belongs to a member of the portal | - | - |
| 403 | The portal is not accepting requests while it is being restored, transferred or encrypted | - | - |
| 405 | The portal publishes no trusted-domain policy, so it has nothing to join | - | - |
| 500 | Eleven invitation requests from the same network address have already been counted, each less than two minutes after the one before | - | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 502 | Bad Gateway. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
| 503 | Service Unavailable. Returned by the reverse proxy, response body may be HTML and not JSON. | - | - |
Return type
Authorization
Basic, OAuth2 (scopes: read, write), ApiKeyBearer, asc_auth_key, Bearer, OpenId
HTTP request headers
- Content-Type: application/json
- Accept: application/json