Update an invite
/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
The invite's id, a uuid. An unknown invite, or one outside the token's organisation, returns 404.
Query parameters
Validate and run the call without committing it, returning what the real call would return with
meta.dry_runset.
Request body
application/json, required · InviteUpdate
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.The invitee's title, such as Mr, Ms or Dr.
The invitee's first name.
The invitee's last name.
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
{
"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"
}
}Authorization failed. error.code is one of org_disabled,
ip_blocked, missing_scope, scope_disabled, user_disabled.
The request conflicts with existing state (error.code = conflict),
e.g. a compliance flow with the requested name already exists.
The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per
problem, or a code documented on the operation.
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"
}'