---
title: "Update a team member"
url: https://docs.corefinity.com/api/reference/organisation/update-team-user
type: endpoint
last_updated: 2026-11-13
feature: team
related:
  - https://docs.corefinity.com/guides/organisation/people/users-and-invitations.md
  - https://docs.corefinity.com/mcp/tools/corestack_team_member_update.md
---
# 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.

```http
POST /api/user/{id}/update
```

- Scope: `write`
- Rate limit: 60 a minute
- Try it in the console: off. It sends email to real people. Copy the request and run it yourself when you are sure.

## Path parameters

- `id` (integer, required): The id of a user. Digits only; anything else answers `404`.

## Body

- `alerts_notifications` (boolean or null)
- `email` (string, required): 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`.
- `email_notifications` (boolean or null)
- `maintenance_window_notifications` (boolean or null)
- `name` (string, required)
- `position` (string or null)
- `role` (string, required): The slug of a role the member holds already or one you may give them.
- `subscribe_to_deployment_alerts` (boolean or null)
- `subscribe_to_newsletters` (boolean or null)

## Request

### curl

```bash
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": "t.harbour@harbourandfinch.example.com",
    "name": "Tom Harbour",
    "role": "client-member-full"
  }'
```

### PHP

```php
use Illuminate\Support\Facades\Http;

$response = Http::withToken(env('COREFINITY_TOKEN'))
    ->acceptJson()
    ->post('https://manage.corefinity.com/api/user/2042/update', [
        'email' => 't.harbour@harbourandfinch.example.com',
        'name' => 'Tom Harbour',
        'role' => 'client-member-full',
    ]);

$data = $response->json();
```

### Node

```javascript
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: 't.harbour@harbourandfinch.example.com',
    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);
```

### Python

```python
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": "t.harbour@harbourandfinch.example.com",
        "name": "Tom Harbour",
        "role": "client-member-full",
    },
)

data = res.json() if res.content else None
```

## Responses

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

```json
{
  "data": {
    "company_id": "1204",
    "email": "tom.harbour@harbourandfinch.example.com",
    "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": "t.harbour@harbourandfinch.example.com",
    "status": "member_asked"
  },
  "message": "User has been updated successfully",
  "status": "success"
}
```

### 401 No token, or a token that is not valid.

```json
{
  "message": "Unauthenticated."
}
```

### 403 The token lacks the `write` scope (`scope_required`), you may not edit users (`forbidden`), the account is not yours to change (`privileged_target`: an owner's, unless you are an owner of the same company), the change would leave the company without an owner (`last_owner`), only an owner or Corefinity staff can make somebody an owner (`owner_grant`), or the role carries a permission you do not hold (`permission_grant`).

```json
{
  "code": "forbidden",
  "message": "You are not allowed to edit users.",
  "reason": "forbidden",
  "status": "error"
}
```

### 404 The id does not exist, or it is something you cannot see. Both answer the same body.

```json
{
  "message": "Not found."
}
```

### 422 A field is missing or wrong (`invalid`). On `email`: a new address for yourself (change it on your Profile page), a new address for somebody who has not accepted their invitation, or too many requests for the same member to change their address.

```json
{
  "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"
}
```

### 429 Too many requests (`rate_limited`). Wait for the number of seconds in `Retry-After`, which `retry_after_seconds` repeats.

```json
{
  "code": "rate_limited",
  "message": "Too many requests. Try again in 60 seconds.",
  "reason": "rate_limited",
  "retry_after_seconds": 60
}
```

## If it is refused

| Status | Reason | What to do |
|---|---|---|
| 401 |  | 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 |  | 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`. |

## The same task elsewhere

- Guide: [Users and invitations](https://docs.corefinity.com/guides/organisation/people/users-and-invitations.md)
- MCP tool: [`corestack_team_member_update`](https://docs.corefinity.com/mcp/tools/corestack_team_member_update.md)
