User Invites

Send an invite

POST/invites/{id}/actions/send
invites:writesend_inviteIdempotent

Sends a draft invite: it becomes invited, expires in 30 days, records its sent date and emails the invitee after commit, never on dry_run. An invited one is already sent: nothing happens (200, no email or event); use resend. A completed or revoked one returns 409 invalid_state; one with no linked user returns 422 invite_has_no_user. Emits invite.sent. Undo with revoke. Advisor invites are 404 for callers who may not escalate, internal_user invites for personal tokens without create-new-user or super admin.

Path parameters

  • idstring (uuid)Required#

    The invite's id, a uuid. An unknown invite, or one outside the token's organisation, returns 404.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Responses

200

The invite after the action.

Invite
{
  "data": {
    "id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "type": "investor",
    "status": "invited",
    "email": "string",
    "title": "string",
    "first_name": "string",
    "last_name": "string",
    "sso_id": "string",
    "onboarding_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "user_id": "9a9d1c5e-4f2b-4c8e-9a7d-2f1e6b3c4d5a",
    "expires_at": "2026-06-12T10:00:00+00:00",
    "invited_at": "2026-06-12T10:00:00+00:00",
    "created_at": "2026-06-12T10:00:00+00:00",
    "updated_at": "2026-06-12T10:00:00+00:00"
  }
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

Error
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl -X POST https://your-org-domain/kong/core/api/v2/invites/{id}/actions/send\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"