Update Partner User | Polytomic Docs

Updates a user’s assigned permissions roles.

🚧 Requires partner key

User endpoints are only accessible using partner keys.

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

AuthorizationBearer

Bearer partner API key

idstringRequiredformat: "uuid"

Unique identifier of the user to update.

org_idstringRequiredformat: "uuid"

Unique identifier of the organization the user belongs to.

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.

dataobject

403

Forbidden Error

422

Unprocessable Entity Error

500

Internal Server Error

1	curl -X PUT https://app.polytomic.com/api/organizations/248df4b7-aa70-47b8-a036-33ac447e668d/users/248df4b7-aa70-47b8-a036-33ac447e668d \
2	-H "X-Polytomic-Version: X-Polytomic-Version" \
3	-H "Authorization: Bearer <token>" \
4	-H "Content-Type: application/json" \
5	-d '{
6	"email": "jane.doe@polytomic.com"
7	}'

1	{
2	"data": {
3	"email": "jane.doe@polytomic.com",
4	"id": "a3f1c9e2-7b4d-4f8a-9c2e-1d2f3b4a5c6d",
5	"organization_id": "248df4b7-aa70-47b8-a036-33ac447e668d",
6	"role_ids": [
7	"f47ac10b-58cc-4372-a567-0e02b2c3d479"
8	],
9	"role": "admin"
10	}
11	}