CorefinityCorefinityDocs
Open the Control PanelControl Panel
Team · 14 of 17

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.

POST/api/user/invite

Body

emailstringRequired

The address the invitation goes to. Compared without regard to case. Up to 254 characters. Format: email.

namestringRequired

Up to 255 characters.

rolestringRequired

The slug of a role you may give, as GET /roles lists them.

Returns

201 The invitation was made.

Fields of the 201 answer
dataobjectRequired

The person who was invited.

Fields
created_atstringRequired

When the invitation was made, in UTC, with microseconds. Format: date-time.

emailstringRequired

The address the person was invited at.

idstringRequired

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

namestringRequired
rolestringRequired

The name of the role, not its slug.

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.
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.
403scope_requiredUse a token with the scope named in scope.
409invite_company_goneThe organisation the person was invited to no longer exists or is not active. Invite them again from an active organisation.
422invalidFix the field named in field; errors says why.
429rate_limitedWait for the seconds in Retry-After.
500noneRead 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"
  }'
{
  "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"
}
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