Update User Metadata

BETA

This endpoint is in beta and may change in future releases.

PUT/workspace/{workspaceIdentifier}/user/{userIdentifier}

Replaces the entire userDetails (metadata) for a user in a workspace. This is a full replace — keys not included will be removed.

Path Parameters

workspaceIdentifierstringrequired

Workspace UUID or slug.

userIdentifierstringrequired

User UUID or email.

Request Body

userDetailsarrayrequired

Array of key-value pairs representing the user's metadata fields. Replaces all existing metadata.

Error Responses

400

Invalid request body or user account is inactive.

403

External API disabled, missing EXTERNAL_API license, or invalid Authorization token.

404

User or workspace not found.

Request

curl -X PUT "https://{your-domain}/api/ext/workspace/{workspaceIdentifier}/user/{userIdentifier}" -H "Authorization: Basic <access_token>" -H "Content-Type: application/json" -d '{
"userDetails": [
  {
    "key": "department",
    "value": "Platform"
  },
  {
    "key": "title",
    "value": "Senior Engineer"
  }
]
}'

Response: 200