/pledges

Use this endpoint to create a new pledge 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 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.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
int32
required
Defaults to 10005165

The vanId of the Person who pledged.

int32
required
Defaults to 18754

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

double
Defaults to 500

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.

date-time
required
Defaults to 2026-01-01T00:00:00Z
int32
enum
required

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

Allowed:
int32
enum
required

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

Allowed:
int32
enum
required

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

Allowed:
Response
200
Language
Credentials
Basic
base64
:
LoadingLoading…
Response
Click Try It! to start a request and see the response here!