Skip to main content
POST
Create a Planned Gift

Authorizations

Authorization
string
header
required

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

Body

application/json
contactId
string

The identifier of the contact this record belongs to.

plannedGiftDate
string

The date the planned gift was committed.

plannedGiftType
string

The type of planned gift, for example a bequest or a charitable trust.

frequency
string

How often the payment recurs, for example Monthly, Quarterly, or Annually.

anticipatedAmount
string

The amount the organization expects to receive.

anticipatedStartDate
string

The date the organization expects to start receiving payments.

numberOfOccurrences
string

The number of payments expected.

currentValue
string

The current value of the planned gift.

contactIndividualId
string

The identifier of the contact individual this record belongs to.

assignedUserId
string

The identifier of the user responsible for the record.

projectId
string

The identifier of the project this record is designated to.

segmentId
string

The identifier of the segment this record is attributed to.

thankYouDate
string

The date the donor was thanked.

customFields
object[]

Custom field values to set on the record. Field names must match custom fields configured for the organization.

Response

OK

id
string

The unique identifier of the record in Virtuous.

plannedGiftUrl
string
giftsAppliedUrl
string
contactId
string

The identifier of the contact this record belongs to.

contactUrl
string

A link to the related contact.

plannedGiftDate
string
pkannedGiftType
string
frequency
string
anticipatedAmount
string
anticipatedStartDate
string
numberOfOccurrences
string
currentValue
string
fulfilled
string
projectId
string

The identifier of the project this record is designated to.

project
string
projectUrl
string

A link to the related project.

segmentId
string

The identifier of the segment this record is attributed to.

segment
string
segmentUrl
string

A link to the related segment.

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.

customFields
object[]

The custom field values stored on the record.

Last modified on August 11, 2026