Sorry, no results found for "".

Show examples in:
Javascript HTTP
Endpoint info
Available examples

Content Management API > Collaborator

Update a collaborator

Body parameters

type string Required

Must be exactly "user".

attributes.is_active boolean Optional

Whether the user is active or not

relationships.role.data Optional

Role

Returns

Returns a resource object of type user.

Examples

PUT https://site-api.datocms.com/users/:user_id HTTP/1.1
Authorization: Bearer YOUR-API-TOKEN
Accept: application/json
X-Api-Version: 3
Content-Type: application/vnd.api+json
{
"data": {
"type": "user",
"id": "312"
}
}
Terminal window
curl -g 'https://site-api.datocms.com/users/:user_id' \
-X PUT \
-H "Authorization: Bearer YOUR-API-TOKEN" \
-H "Accept: application/json" \
-H "X-Api-Version: 3" \
-H "Content-Type: application/vnd.api+json" \
--data-binary '{"data":{"type":"user","id":"312"}}'
await fetch("https://site-api.datocms.com/users/:user_id", {
method: "PUT",
headers: {
Authorization: "Bearer YOUR-API-TOKEN",
Accept: "application/json",
"X-Api-Version": "3",
"Content-Type": "application/vnd.api+json",
},
body: JSON.stringify({ data: { type: "user", id: "312" } }),
});
HTTP/1.1 200 OK
Content-Type: application/json
Cache-Control: cache-control: max-age=0, private, must-revalidate
X-RateLimit-Limit: 30
X-RateLimit-Remaining: 28
{
"data": {
"type": "user",
"id": "312",
"relationships": {
"role": {
"data": {
"type": "role",
"id": "34"
}
}
},
"attributes": {
"email": "mark.smith@example.com",
"is_2fa_active": true,
"full_name": "Mark Smith",
"is_active": true
}
}
}