Update a team member
Changes a member's name, role, position and notification preferences. name, email and role are always sent; a preference you leave out stays as it is. Only the role you may give is replaced; other roles the member holds stay. A new email for somebody else is never saved: the member is emailed to say you asked, the rest of the update saves, and email_change says so. You need to be an owner or hold the editUsers permission.
Path parameters
The id of a user. Digits only; anything else answers 404. At least 1.
Body
Send the address the member has now. A different one is not saved: the member is emailed to say you asked. A different address for yourself is refused 422. Up to 254 characters. Format: email.
Up to 255 characters.
Up to 255 characters.
The slug of a role the member holds already or one you may give them.
Returns
200 The member as saved. email_change is null unless the update asked for a new address.
Fields of the 200 answer
A person with a Control Panel account. Ids are sent as strings.
Fields
The user's company, as GET /companies answers it. Null when the account belongs to no company.
The id of the user's company, as a string of digits. An empty string when the account belongs to no company.
The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.
The user's id, as a string of digits.
The person's roles.
Fields of each item
The keys of the permissions the role grants, such as viewWebsites.
Null unless the update named a new address for somebody else.
If it is refused
| Status | Reason | What to do |
|---|---|---|
401 | none | Send a valid token as Authorization: Bearer <token>. |
403 | forbidden | The person is not allowed to do this. |
403 | last_owner | The organisation must keep at least one owner. Make someone else an owner first. |
403 | owner_grant | Only an owner or Corefinity staff can make someone an owner. Ask an owner. |
403 | permission_grant | You can give someone a role only if you hold all of its permissions yourself. Ask someone who holds them. |
403 | privileged_target | That person's account can be changed only by Corefinity. Contact support. |
403 | scope_required | Use a token with the scope named in scope. |
404 | none | Check the id. You see only what your account can reach. |
422 | invalid | Fix the field named in field; errors says why. |
429 | rate_limited | Wait for the seconds in Retry-After. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
curl -X POST https://manage.corefinity.com/api/user/2042/update \
-H "Authorization: Bearer $COREFINITY_TOKEN" \
-H "Accept: application/json" \
-H "Content-Type: application/json" \
-d '{
"email": "[email protected]",
"name": "Tom Harbour",
"role": "client-member-full"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/user/2042/update', [
'email' => '[email protected]',
'name' => 'Tom Harbour',
'role' => 'client-member-full',
]);
$data = $response->json();const res = await fetch('https://manage.corefinity.com/api/user/2042/update', {
method: 'POST',
headers: {
Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
Accept: 'application/json',
'Content-Type': 'application/json',
},
body: JSON.stringify({
email: '[email protected]',
name: 'Tom Harbour',
role: 'client-member-full',
}),
});
// An answer with no body (204) has nothing to parse.
const text = await res.text();
const data = text && JSON.parse(text);import os
import requests
res = requests.post(
"https://manage.corefinity.com/api/user/2042/update",
headers={
"Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
"Accept": "application/json",
},
json={
"email": "[email protected]",
"name": "Tom Harbour",
"role": "client-member-full",
},
)
data = res.json() if res.content else None{
"data": {
"company_id": "1204",
"email": "[email protected]",
"id": "2042",
"mobile": null,
"name": "Tom Harbour",
"role": [
{
"name": "Member (Full Access)",
"permissions": [
"viewWebsites",
"viewDeployments",
"viewTickets",
"createTickets"
],
"slug": "client-member-full"
}
]
},
"email_change": {
"message": "Only the member can change their sign-in email address, on their Profile page. We have emailed them to say you asked.",
"requested_email": "[email protected]",
"status": "member_asked"
},
"message": "User has been updated successfully",
"status": "success"
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "You are not allowed to edit users.",
"reason": "forbidden",
"status": "error"
}{
"message": "Not found."
}{
"code": "invalid",
"errors": {
"email": [
"Change your own email address on your Profile page, where the new address is confirmed before it is used."
]
},
"field": "email",
"message": "Change your own email address on your Profile page, where the new address is confirmed before it is used.",
"reason": "invalid"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}Try it is off for this endpointIt sends email to real people. Copy the request and run it yourself when you are sure.