Customers & Directory
Switch Active Profile
Switch the active customer profile for the current session to a different profile owned by the same user account.
PUT
Switch Active Profile
Switch Active Profile
Changes the active customer profile for the current session. A single user account can have multiple customer profiles (individual, company, or profiles at different locations). This endpoint sets the specified profile as the default, so subsequent authenticated requests operate in that profile’s context.Authentication
Requires a valid customer bearer token.Query Parameters
number
required
The numeric identifier of the profile to switch to. Obtain valid profile IDs from
GET /api/public/coworkers/profiles — use a Profiles[].Id value
where Profiles[].Active is true.Response
The portal typically discards the response body and re-fetchesGET /api/public/coworkers/profiles after a successful switch to update the session state.
Returns an ActionConfirmation envelope.
boolean
true when the profile was switched successfully.string | null
Usually
null on success.number
HTTP-style status code mirrored in the body.
200 on success.string | null
Human-readable message. Usually
null on success.any
Validation errors.
null on success.Example Response
TypeScript Integration
Usage in Portal
Error Responses
error
The bearer token is missing, expired, or invalid.
error
No profile with the given
coworkerId exists or it does not belong to this user account.Related Endpoints
Switch Active Profile