Skip to main content
PUT
Replace User Locations

Authorizations

x-client-key
string
header
required
x-client-secret
string
header
required

Path Parameters

workspaceId
string<uuid>
required

UUID of the workspace. Must be the workspace your API key is bound to.

userId
string<uuid>
required

UUID of the user whose location memberships are being replaced.

Body

application/json
locations
string<uuid>[]

The complete set of location UUIDs the user should belong to. Required for API-key callers when replacing memberships. Also accepted as location_ids.

defaultLocationId
string | null

Sets the user's default location. Send null or "" to clear it. When this field is present, locations is ignored.

Response

Memberships replaced — data is the user's resulting location ids. (On a defaultLocationId call, data is the user's workspace membership record instead.)