YOUHODLERBusiness API
Get access
View as Markdown

postCancel user invitation

Required capabilityusers.invite

Cancels a pending invitation. Requires If-Match for optimistic concurrency. The invitation id and optional reason are supplied in the request body.

Request

Request URL

POST
POST /user-invitations/cancel

Request Body

application/json
{
  "invitation_id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "reason": "User withdrew their request"
}

Responses

Response

application/json
{
  "accepted_at": null,
  "cancelled_at": "2026-05-01T10:00:00Z",
  "challenge_ref": null,
  "created_at": "2026-05-01T10:00:00Z",
  "email_constraint": "jane.doe@acme.example",
  "enterprise_ref": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "etag": "W/\"a1b2c3d4\"",
  "expires_at": "2026-05-01T10:00:00Z",
  "id": "b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "invited_by": "users/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "pending_human_actor_ref": "users/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "role": "roles/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "scope": "enterprises/b8e2f1a0-4c3d-4e5f-9a1b-2c3d4e5f6a7b",
  "status": "cancelled",
  "updated_at": "2026-05-01T10:00:00Z"
}

Resource created successfully.