Invite a new member to an entity

POST

/entity-access-invites

Creates a pending invitation for someone to join an entity (business) with a specific role. The inviting identity must already have the can_invite_entity_member permission on the entity, granted via their assigned role. On success, an email notification carrying an accept-invite link is queued for delivery to the invitee; it is not sent synchronously. The invitation expires 24 hours after creation if not accepted. Only one pending invitation may exist per entity/email combination at a time, and an email that already has access to the entity cannot be re-invited.

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Examples

Responses

🟢201

application/json

The invitation was created successfully and a notification email has been queued for delivery to the invitee.

Bodyapplication/json

🟠400

🟠401

🟠403

🟠404

Request Example

Shell

JavaScript

Java

Swift

cURL

Invite with the required fieldsInvite a new administrator

curl --location '/entity-access-invites' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
    "email": "jane.doe@example.com",
    "role": "operations"
}'

Response Example

201 - Success

{
    "message": "Entity access invite created successfully",
    "status": "success",
    "data": {
        "id": "01HQZR2BKPFQ8MXJVT3G7LWN5",
        "entity_id": "01HQZR2BKPFQ8MXJVT3G7LWNA",
        "email": "jane.doe@example.com",
        "role": "operations",
        "status": "pending",
        "expires_at": 1780250400000
    }
}

Modified at 2026-09-30 00:29:30

Accept an entity access invitation

List entity access invites