Switching to another organisation of the user account¶
Note
If the user switches organisations, only information from the switched-to organisation will be requested, changed, or created.
Note
The same session must be used to verify the switch by calling /user/me.
Sends a POST request to the endpoint /user/switch-account/{id}.
Description¶
The Switch-Organisation request allows the user to switch to an organisation to which the user belongs.
Requirements¶
Values of the request: Organisation-ID {id}d}
Objects: none
Request¶
To switch to another organisation, add the Organization-ID {id} to the path of the request.
No further information is required.
The system only returns a 200 HTTP code in response to the successful request.
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 201 | The request has succeeded and a new object has been created. |
| 400 | The request was unsuccessful. The request was invalid or information is missing. |
| 401 | The request has not succeeded because the user authentication was incorrect. |
| 403 | The request has not succeeded because the user does not have the right permissions. |