PUT/organization-memberships/{organizationId}
Update an organization membership
Operation organizationMemberships.update
Description
Changes the caller's own membership settings in an organization, such as pausing its sync to their devices. Pausing changes no grant, key, or policy. Returns 404 unless the caller's roster entry is active.
Authentication
Requires a signed-in session: the client sends its session token as a bearer token in the Authorization header.
Parameters
| Name | In | Type | Details |
|---|---|---|---|
organizationId | path | string | required
|
Request body
application/jsonUpdateOrganizationMembershipRequest
The caller's own setting for one organization they belong to.
1 field
syncPausedbooleanrequiredTrue to stop this organization's content syncing to the caller's devices; access and keys are unchanged.
Responses
200 OK
application/jsonOrganizationMembershipResponse
One organization the caller belongs to, as the caller's own settings for it; it grants nothing.
4 fields
isPersonalOrganizationOwnerbooleanrequiredTrue for the caller's personal organization, which can be neither paused nor left.
leaveRequestedAtstringrequirednullableWhen the caller asked to leave, or null.
organizationIdstringrequiredsyncPausedbooleanrequiredTrue when the caller paused this organization's sync to their devices.
Other fields are allowed.
Other responses
| Status | Meaning | Body |
|---|---|---|
| 400 | Bad Request |
|
| 401 | Unauthorized |
|
| 404 | Not Found |
|
| 409 | Conflict |
|
| 500 | Internal Server Error |
|
| 503 | Service Unavailable |
|