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

1
PUT https://site-api.datocms.com/users/:user_id HTTP/1.1
2
Authorization: Bearer YOUR-API-TOKEN
3
Accept: application/json
4
X-Api-Version: 3
5
Content-Type: application/vnd.api+json
6
7
{
8
"data": {
9
"type": "user",
10
"id": "312"
11
}
12
}
Terminal window
1
curl -g 'https://site-api.datocms.com/users/:user_id' \
2
-X PUT \
3
-H "Authorization: Bearer YOUR-API-TOKEN" \
4
-H "Accept: application/json" \
5
-H "X-Api-Version: 3" \
6
-H "Content-Type: application/vnd.api+json" \
7
--data-binary '{"data":{"type":"user","id":"312"}}'
1
await fetch("https://site-api.datocms.com/users/:user_id", {
2
method: "PUT",
3
headers: {
4
Authorization: "Bearer YOUR-API-TOKEN",
5
Accept: "application/json",
6
"X-Api-Version": "3",
7
"Content-Type": "application/vnd.api+json",
8
},
9
body: JSON.stringify({ data: { type: "user", id: "312" } }),
10
});
1
HTTP/1.1 200 OK
2
Content-Type: application/json
3
Cache-Control: cache-control: max-age=0, private, must-revalidate
4
X-RateLimit-Limit: 30
5
X-RateLimit-Remaining: 28
6
7
{
8
"data": {
9
"type": "user",
10
"id": "312",
11
"relationships": {
12
"role": {
13
"data": {
14
"type": "role",
15
"id": "34"
16
}
17
}
18
},
19
"attributes": {
20
"email": "mark.smith@example.com",
21
"is_2fa_active": true,
22
"full_name": "Mark Smith",
23
"is_active": true
24
}
25
}
26
}