v1

latestOpenAPI 3.0.1Apache 2.02026-08-063494581.6 MB
esper_cloud_api_User

Delete a invite

Cancels and removes a specific pending user invitation from the tenant, preventing the invited user from completing registration with that invite link.

Use this endpoint when an invitation was sent in error, the intended recipient's role or email has changed, or the invite has expired and needs to be reissued.

About Delete a User Invite

Invite records in Esper remain active until the user accepts them or they are explicitly deleted. User invitations are valid for seven days — after that window, the invite link expires and the user must be re-invited. Deleting an invite does not remove or affect any existing user account — it only invalidates the pending invite record and its associated identity provider invitation. Once deleted, the invitation_url from the original invite will no longer be valid. Returns HTTP 204 on success with no response body.

Key Parameters

enterprise_id — the UUID of the tenant the invite belongs to

invite_id — the UUID of the invite record to cancel, obtained from POST /authn2/v0/tenant/{enterprise_id}/invite (create response) or GET /authn2/v0/tenant/{enterprise_id}/invite (list)

Common Use Cases

Revoking an invitation sent to the wrong email address

Clearing expired or stale invites before re-issuing a fresh invitation with updated role or group assignments

Cleaning up the invite queue as part of periodic tenant access audits

Best Practices

Always retrieve the invite_id from the list endpoint (GET .../invite) rather than storing it externally, to ensure you're targeting the correct and current record

Use created_at from the list response to identify invites approaching or past the 7-day expiry window — delete and re-invite rather than waiting for the user to report a broken link

After deletion, re-invite the user immediately if access is still intended — the previous invitation_url is no longer valid

If the re-invite requires a different role, including switching to or from AuthZ Role User, prepare the correct authz_role_id before calling the invite endpoint again

Confirm deletion success via the 204 response before notifying stakeholders that the invite has been revoked

Workflow

Call GET /authn2/v0/tenant/{enterprise_id}/invite to identify the target invite and retrieve its id

Call DELETE /authn2/v0/tenant/{enterprise_id}/invite/{invite_id} with the correct invite_id

Confirm the 204 response indicating successful deletion

Re-invite the user via POST /authn2/v0/tenant/{enterprise_id}/invite if access is still required

delete/authn2/v0/tenant/{enterprise_id}/invite/{invite_id}

Path parameters

enterprise_idstring uuid required

Enterprise ID

invite_idstring uuid required

Invite ID

Response

Deleted tenant user invite