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.
Body
The address the invitation goes to. Compared without regard to case. Up to 254 characters. Format: email.
Up to 255 characters.
The slug of a role you may give, as GET /roles lists them.
Returns
201 The invitation was made.
Fields of the 201 answer
The person who was invited.
Fields
When the invitation was made, in UTC, with microseconds. Format: date-time.
The address the person was invited at.
The new user's id, as a string of digits.
The name of the role, not its slug.
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 | 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 | none | Read the message; it says what happened. |
Reasons are listed by name in Errors and refusals.
The same task elsewhere
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": "[email protected]",
"name": "Rosa Whitlock",
"role": "client-member-full"
}'use Illuminate\Support\Facades\Http;
$response = Http::withToken(env('COREFINITY_TOKEN'))
->acceptJson()
->post('https://manage.corefinity.com/api/user/invite', [
'email' => '[email protected]',
'name' => 'Rosa Whitlock',
'role' => 'client-member-full',
]);
$data = $response->json();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: '[email protected]',
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);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": "[email protected]",
"name": "Rosa Whitlock",
"role": "client-member-full",
},
)
data = res.json() if res.content else None{
"data": {
"created_at": "2026-11-09T10:15:00.000000Z",
"email": "[email protected]",
"id": "2044",
"name": "Rosa Whitlock",
"role": "Member (Full Access)"
},
"message": "User has been invited successfully",
"status": "success"
}{
"message": "Unauthenticated."
}{
"code": "forbidden",
"message": "You are not allowed to invite users.",
"reason": "forbidden",
"status": "error"
}{
"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"
}{
"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"
}{
"code": "rate_limited",
"message": "Too many requests. Try again in 60 seconds.",
"reason": "rate_limited",
"retry_after_seconds": 60
}{
"message": "Failed to invite user",
"status": "error"
}Try it is off for this endpointIt sends email to real people. Copy the request and run it yourself when you are sure.