Skip to navigation
API ReferenceUsers

Update Partner User

Updates a user’s assigned permissions roles.

These endpoints accept a partner key or an Organization-scoped key derived from a partner key. An Organization-scoped key can access users only in its own Organization.

To manage users with a user API key, use the current-Organization endpoints under /api/organization/users.

Only the user’s role assignments are modified. Profile information such as name and email address is not affected by this endpoint.

Authentication

AuthorizationBearer
Bearer partner API key

Path parameters

idstringRequiredformat: "uuid"
Unique identifier of the user to update
org_idstringRequiredformat: "uuid"
Unique identifier of the organization the user belongs to

Headers

X-Polytomic-VersionstringOptional

Request

This endpoint expects an object.
emailstringRequired
Email address used to sign the user in and receive notifications
role_idslist of stringsOptional
Identifiers of the permissions roles to assign to the user. Must contain at least one entry when provided.
rolestringOptionalDeprecated

Deprecated legacy role name. Use role_ids instead; setting both role and role_ids in the same request is rejected.

Response

OK
dataobjectOptional

Errors

403
Forbidden Error
422
Unprocessable Entity Error
500
Internal Server Error