Replace User

PUT /Users/:id

Fully replaces a user's attributes. You must provide all required fields in the request body.

Roam-specific behavior:

You can update name.givenName, name.familyName, active, externalId, and role
Set active: false to archive the user; active: true to reactivate
Email changes: update userName and the primary email together to the same new address to rename the user in place (chat history and group memberships are preserved). Changing only one of the pair returns 400; a change that conflicts with existing data (e.g. the new address belongs to an active user) returns 409 with the conflict reasons
Attributes Roam does not store (e.g. title, addresses, phoneNumbers, enterprise-extension fields) are ignored rather than failing the request

See RFC 7644 §3.5.1 for SCIM resource replacement.

Request

Updated user