CorefinityCorefinityDocs
Open the Control PanelControl Panel
Team · 17 of 17

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.

POST/api/user/{id}/update

Path parameters

idintegerRequired

The id of a user. Digits only; anything else answers 404. At least 1.

Body

alerts_notificationsboolean or null
emailstringRequired

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.

email_notificationsboolean or null
maintenance_window_notificationsboolean or null
namestringRequired

Up to 255 characters.

positionstring or null

Up to 255 characters.

rolestringRequired

The slug of a role the member holds already or one you may give them.

subscribe_to_deployment_alertsboolean or null
subscribe_to_newslettersboolean or null

Returns

200 The member as saved. email_change is null unless the update asked for a new address.

Fields of the 200 answer
dataobjectRequired

A person with a Control Panel account. Ids are sent as strings.

Fields
companyobject or any or null

The user's company, as GET /companies answers it. Null when the account belongs to no company.

company_idstringRequired

The id of the user's company, as a string of digits. An empty string when the account belongs to no company.

emailstringRequired

The address the person is shown with. For somebody invited who has not accepted, the address they were invited at.

idstringRequired

The user's id, as a string of digits.

mobilestring or nullRequired
namestringRequired
rolearray of objectsRequired

The person's roles.

Fields of each item
namestringRequired
permissionsarray of stringsRequired

The keys of the permissions the role grants, such as viewWebsites.

slugstringRequired
messagestringRequired
statusstringRequired
email_changeobject or any or nullRequired

Null unless the update named a new address for somebody else.

If it is refused

StatusReasonWhat to do
401noneSend a valid token as Authorization: Bearer <token>.
403forbiddenThe person is not allowed to do this.
403last_ownerThe organisation must keep at least one owner. Make someone else an owner first.
403owner_grantOnly an owner or Corefinity staff can make someone an owner. Ask an owner.
403permission_grantYou can give someone a role only if you hold all of its permissions yourself. Ask someone who holds them.
403privileged_targetThat person's account can be changed only by Corefinity. Contact support.
403scope_requiredUse a token with the scope named in scope.
404noneCheck the id. You see only what your account can reach.
422invalidFix the field named in field; errors says why.
429rate_limitedWait 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"
  }'
{
  "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"
}
Try it

Try it is off for this endpointIt sends email to real people. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT