updateUserActivationStatus
EmployeeFullArrayWrapper updateUserActivationStatus(activationStatus, UpdateMembersRequestDto)
PUT /api/2.0/people/activationstatus/{activationStatus}
Set my activation status
Sets the activation state of the calling account, which is how a person finishes confirming their email address after following the link they were sent. The request has to carry the confirmation token from that link rather than an ordinary session, and the account must be allowed to edit its own profile. Despite taking a list, it accepts exactly one ID and that ID has to be the calling account: an empty list, more than one entry, or somebody else's ID is answered with 400, so it cannot be used to activate other people. Setting Activated on the portal owner sends the administrator welcome email, once per portal. The change raises a UserUpdated webhook, and the answer holds the profile in its new state - or nothing at all when the account has meanwhile disappeared, which is skipped without an error. The account status is a different thing and is changed through PUT api/2.0/people/status/{status}.
Parameters
| Name | In | Type | Description | Notes |
|---|---|---|---|---|
| activationStatus | path | EmployeeActivationStatus | The activation state to set on the calling account, taken from the route: NotActivated, Activated, Pending or AutoGenerated. | [required] [example: Activated] [enum: 0, 1, 2, 4] |
| UpdateMembersRequestDto | body | UpdateMembersRequestDto | The account to change. Only userIds is read, it has to hold exactly one entry, and that entry has to be the calling account; resendAll is ignored here. | [required] |
Responses
| Status code | Description | Type | Response headers |
|---|---|---|---|
| 200 | The profile of the caller in its new activation state | EmployeeFullArrayWrapper | X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset |
| 400 | The list is empty, holds more than one ID, or names an account other than the caller | - | - |
| 403 | The account may not edit its own profile | - | - |
| 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