---
title: "Invite somebody to your team"
url: https://docs.corefinity.com/api/reference/organisation/invite-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_invite.md
---
# Invite somebody to your team

Invites a person into your own company with one role and emails them. The answer is the same whether or not
the address already has a Control Panel account; the invitation is listed on your team as `invite_sent`.
You need to be an owner or hold the `inviteUsers` permission.

```http
POST /api/user/invite
```

- 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.

## Body

- `email` (string, required): The address the invitation goes to. Compared without regard to case.
- `name` (string, required)
- `role` (string, required): The slug of a role you may give, as `GET /roles` lists them.

## Request

### curl

```bash
curl -X POST https://manage.corefinity.com/api/user/invite \
  -H "Authorization: Bearer $COREFINITY_TOKEN" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "rosa.whitlock@harbourandfinch.example.com",
    "name": "Rosa Whitlock",
    "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/invite', [
        'email' => 'rosa.whitlock@harbourandfinch.example.com',
        'name' => 'Rosa Whitlock',
        'role' => 'client-member-full',
    ]);

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

### Node

```javascript
const res = await fetch('https://manage.corefinity.com/api/user/invite', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.COREFINITY_TOKEN}`,
    Accept: 'application/json',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({
    email: 'rosa.whitlock@harbourandfinch.example.com',
    name: 'Rosa Whitlock',
    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/invite",
    headers={
        "Authorization": f"Bearer {os.environ['COREFINITY_TOKEN']}",
        "Accept": "application/json",
    },
    json={
        "email": "rosa.whitlock@harbourandfinch.example.com",
        "name": "Rosa Whitlock",
        "role": "client-member-full",
    },
)

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

## Responses

### 201 The invitation was made.

```json
{
  "data": {
    "created_at": "2026-11-09T10:15:00.000000Z",
    "email": "rosa.whitlock@harbourandfinch.example.com",
    "id": "2044",
    "name": "Rosa Whitlock",
    "role": "Member (Full Access)"
  },
  "message": "User has been invited 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 invite users (`forbidden`), only an owner or Corefinity staff can invite somebody as an owner (`owner_grant`), or the role carries a permission you do not hold yourself (`permission_grant`).

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

### 409 Your company is not active, so nobody can be invited yet (`invite_company_gone`).

```json
{
  "code": "invite_company_gone",
  "message": "This company is not active, so nobody can be invited to its team until it is.",
  "reason": "invite_company_gone",
  "status": "error"
}
```

### 422 A field is missing or wrong (`invalid`): a role that does not exist or that you may not give in your company, or an address that is already on your team.

```json
{
  "code": "invalid",
  "errors": {
    "email": [
      "Someone with this email address is already on this team."
    ]
  },
  "field": "email",
  "message": "Someone with this email address is already on this team.",
  "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
}
```

### 500 The invitation could not be made. Nothing was saved.

```json
{
  "message": "Failed to invite user",
  "status": "error"
}
```

## 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 | `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 | `scope_required` | Use a token with the scope named in `scope`. |
| 409 | `invite_company_gone` | The organisation the person was invited to no longer exists or is not active. Invite them again from an active organisation. |
| 422 | `invalid` | Fix the field named in `field`; `errors` says why. |
| 429 | `rate_limited` | Wait for the seconds in `Retry-After`. |
| 500 |  | Read the message; it says what happened. |

## The same task elsewhere

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