NGngpvan

/pledges

Changed on

Use this endpoint to create a new pledge with the properties provided in the request body.<br/><br/> If successful, the endpoint responds with HTTP status code 201 Created and the integer ID of the created pledge in the response body. If any of the specified ids (vanId, or designationId) are not accessible in the current context (e.g., the associated api user does not have access to the contact), the request will be considered invalid.

post/pledges

Request

  • Base URL
    https://api.securevan.com/v4
  • URL
    https://api.securevan.com/v4/pledges
  • Auth
    HTTP basic

Request body

vanIdinteger required

The vanId of the Person who pledged.

designationIdinteger required

The Id of the Designation which will receive funds associated with this pledge.

amountnumber double

If the amount field is not included the created pledge will have an amount value of: Unknown. If included, amount must be a value greater than 0.

datePledgedstring date-time required
pledgeTypeId1 | 2 required

Pledge Type ID must contain one of the following values: 1 = To Give 2 = To Raise

commitmentLevelId1 | 2 | 3 required

Commitment Level ID must contain one of the following values: 1 - Hard (Promise) 2 - Soft (Intent) 3 - Not Specified

fulfillmentStatusId1 | 2 | 3 | 4 required

Fulfillment Status ID must contain one of the following values: 1 - Active 2 - Inactive (Abandoned) 3 - Inactive (Forgiven) 4 - Completed

Changes