/commitments

post

https://api.securevan.com/v4/commitments

Use this endpoint to create a new Commitment record with the properties provided in the request body. If successful, the endpoint responds with HTTP Status Code 201 Created and the integer ID of the created Recurring Commitment in the response body. If any of the specified ids (vanId, codeId, or extendedSourceCodeId) are not accessible in the current context (e.g., the associated api user does not have access to the person), the response will be considered invalid.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

contact

object

required

The Person who contributed

designation

object

required

The financial entity which will receive funds associated with this Commitment.

startDate

date

required

Defaults to 2025-01-01

The date the Recurring Commitment started. The startDate must be the same or later than the current US Eastern Time date.

endDate

date

Defaults to 2026-01-01

The date the Recurring Commitment ended. If present, endDate must be later than startDate.

frequency

string

enum

required

The frequency of each recurring commitment installment.

amount

double

required

Defaults to 10

Decimal monetary amount of each Recurring Commitment installment.

paymentType

string

enum

required

Payment method by which the funds will be contributed

codes

array of objects

An array of zero or one Code to apply to the contribution. Contributions may not have more than one Code applied, and if a Code is applied, it must be a Source Code.

codes

generalLederFund

object

The associated GeneralLedgerFund object

costCenter

object

The associated CostCenter object

directMarketingCode

string

Defaults to Excelsior Consulting

A direct marketing code

notes

string

Defaults to Donated in-person at Annual Gala

A note describing this commitment

extendedSourceCode

object

The Extended Source Code object to apply to the Contribution. If this is provided, we’ll look for and apply a matching Source Code to the contribution from a Direct Response Plan segment that the contact is in with a contact history record that has the extended source code. If no matching source code is found, then the POST will fail.

Responses

201201

400400

403403