User Invites

Update an invite

PATCH/invites/{id}

Changes the invitee's email, title, first_name, last_name or sso_id on a draft or invited invite and returns it, also updating the linked user. Sends nothing. A finished invite is 409 invalid_state. A SCIM invitee is 409 scim_managed only when a managed field or sso_id changes. A held email or sso_id is 422 unique. No change emits nothing. Emits invite.updated. Undo with the old values. 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.

Request body

application/json, required · InviteUpdate

  • emailstring (email)#

    The invitee's new email. At most 53 characters. An email another user or open invite holds returns 422 unique. It also rewrites the linked user's sign-in username.

  • titlestring | null#

    The invitee's title, such as Mr, Ms or Dr.

  • first_namestring#

    The invitee's first name.

  • last_namestring#

    The invitee's last name.

  • sso_idstring | null#

    The invitee's single sign-on id, or null to clear it. One another user or invite holds returns 422 unique.

{
  "first_name": "Augusta",
  "last_name": "King"
}

Responses

200

The updated invite.

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 PATCH https://your-org-domain/kong/core/api/v2/invites/{id}\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "first_name": "Augusta",
  "last_name": "King"
}'