CorefinityCorefinityDocs
Open the Control PanelControl Panel
Team · 15 of 17

Delete a team member

Deletes the member's account. For somebody who has not accepted yet, this cancels the invitation and its link stops working. The company's last owner and its only user cannot be removed. You need to be an owner or hold the deleteUsers permission.

DELETE/api/user/{id}/delete

Path parameters

idintegerRequired

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

Returns

200 The member who was removed.

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

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.
403only_userThis is the only user in the organisation. Add another user first.
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.
429rate_limitedWait for the seconds in Retry-After.

Reasons are listed by name in Errors and refusals.

The same task elsewhere

curl -X DELETE https://manage.corefinity.com/api/user/2042/delete \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json"
{
  "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"
      }
    ]
  },
  "message": "User has been deleted successfully",
  "status": "success"
}
Try it

Try it is off for this endpointIt deletes data that cannot be brought back. Copy the request and run it yourself when you are sure.

Was this helpful?
Open in ClaudeOpen in ChatGPT