Skip to main content
PUT
Cancel a Recurring Gift

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

recurringGiftId
string
required

(Required) The recurring gift identifier.

Body

application/json
cancelReason
string

The reason the recurring gift is being cancelled.

categoryId
string

Response

OK

id
string

The unique identifier of the record in Virtuous.

transactionSource
string

The external system the record was imported from.

transactionId
string

The identifier of this record in the source system.

contactId
string

The identifier of the contact this record belongs to.

startDate
string
amount
string
frequency
string
anticipatedEndDate
string
cancelDateTimeUtc
string
createDateTimeUtc
string

The UTC date and time the record was created.

createdByUser
string

The name of the user who created the record.

modifiedDateTimeUtc
string

The UTC date and time the record was last modified.

modifiedByUser
string

The name of the user who last modified the record.

segmentId
string

The identifier of the segment this record is attributed to.

segment
string
segmentUrl
string

A link to the related segment.

automatedPayments
string
trackPayments
string
isPrivate
string

When true, the record is only visible to users with permission to view private records.

status
string
nextExpectedPaymentDate
string
designations
object[]
customFields
object[]

The custom field values stored on the record.

Last modified on April 23, 2026