User -- Switch Office

Moves the user to a different office. For international offices only, all of the user's numbers will be unassigned and a new number will be assigned except when the user only has internal numbers starting with 803 -- then the numbers will remain unchanged. Admin can also assign numbers via the user assign number API after. Only supported on paid accounts and there must be enough licenses to transfer the user to the destination office.

Added on May 31, 2021 for API v2.

Rate limit: 1200 per minute.

Path Params
string
required

The user's id. ('me' can be used if you are using a user level API key)

Body Params
int64 | null

The user's office id. When provided, the user will be moved to this office.

Response

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json