Skip to main content
POST
Cancel a commitment through Zapier

Authorizations

Authorization
string
header
required

Passport bearer token authentication for legacy admin sessions.

Path Parameters

id
integer
required

Identifier of the existing record in the authenticated organization.

Body

application/json

Validated input accepted by this Zapier transport.

external_reference
string
required

Stable external record/reference identifying this mutation occurrence. Validation: required|string|max:191.

Maximum string length: 191
Example:

"external-recurring-001"

Response

Created, updated or replayed record; this transport unwraps the primitive success envelope.

Cancellation action result; linked sponsorship and standalone commitment identifiers are distinguished.

id
integer | null

Existing record identifier in the authenticated organization.

Example:

12345

commitment_id
integer | null

Commitment id.

Example:

12345

sponsorship_id
integer | null

Sponsorship id.

Example:

12345

donor_id
integer | null

Donor who owns the gift or commitment.

Example:

12345

recipient_id
integer | null

Recipient selected for the sponsorship.

Example:

4711

donor_form_id
integer | null

Donor form id.

Example:

12345

program_id
integer | null

Program containing the recipient or sponsorship.

Example:

11

type
integer | null

Record type accepted by this operation.

Example:

12345

archived
boolean | null

Archived.

Example:

false

status
string | null

Requested active or archived lifecycle state.

Example:

"active"

archived_at
string | null

Archived at.

Example:

"2026-10-20T10:00:00Z"

cancellation_event_id
string | null

Cancellation event id.

Example:

"example"

external_reference
string | null

Stable external record/reference identifying this mutation occurrence.

Example:

"external-recurring-001"