deleteInvitationLink
StringWrapper deleteInvitationLink(InvitationLinkDeleteRequestDto)
DELETE /api/2.0/portal/users/invitationlink
Delete an invitation link
Deletes the portal's invitation link with the given id, so the URL shared from it stops letting anyone in; accounts that already joined through it are not touched. Inviting members has to be enabled for the portal (GET api/2.0/settings/invitationsettings) and the link has to exist - a second call with the same id is answered as not found. The caller needs the right to add users of the link's role, and only the portal owner may delete the DocSpace administrator link. The call is destructive and cannot be undone: a link for the same role has to be created again with POST api/2.0/portal/users/invitationlink, and it gets a new id, a new URL and a currentUseCount that starts from zero. Nothing is returned in the body. To stop invitations without losing the links, switch inviting members off for the whole portal with PUT api/2.0/settings/invitationsettings - the links then stay stored but are refused until it is switched on again.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| InvitationLinkDeleteRequestDto | body | InvitationLinkDeleteRequestDto | [optional] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The invitation link is deleted and its URL no longer lets anyone join the portal | StringWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The request body cannot be read or has no id | - | - |
| 403 | Inviting members is disabled for the portal, the caller has no right to add users of the link's role, or a non-owner tries to delete the DocSpace administrator link | - | - |
| 404 | No invitation link with this ID exists on the portal | - | - |
| 401 | Unauthorized | ErrorApiResponse | - |
| 429 | Too Many Requests. | ErrorApiResponse | Retry-After |
| 500 | Internal Server Error. | ErrorApiResponse | - |
| 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