Nonprofit Cloud Developer Guide

Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Fundraising Standard Objects
Fundraising Fields on Other Objects
Fundraising Business APIs
Fundraising Invocable Actions
Close Gift Commitment Action
Manage Custom Gift Commitment Schedules Action
Manage Gift Default Designations Action
Manage Gift Transaction Designations Action
Manage Recurring Gift Commitment Schedule Action
Process Gift Entries Action
Pause Gift Commitment Schedule Action
Process Gift Commitment Action
Resume Gift Commitment Schedule Action
Update Processed Gift Entries Action
Fundraising Metadata API Types
Fundraising Tooling API Objects
Program Management
Case Management
Outcome Management Standard Objects
Grantmaking
Volunteer Management Standard Objects
Volunteer Management Fields on Other Objects
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

Close Gift Commitment Action

Updates the status of a gift commitment to closed and updates the status for each of its unpaid and failed gift transactions.

This action is available in API version 59.0 and later for users in orgs where the Fundraising Access license is enabled and the Fundraising User system permission is assigned.

Supported REST HTTP Methods

URI
/services/data/vXX.X/actions/standard/closeGiftCommitment
Formats
JSON
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

Input Details
giftCommitmentId
Type
String
Description
Required.
The ID of the gift commitment record to be closed.

Outputs

None.

Example

Here’s a request for the Close Gift Commitment action.

1{
2  "inputs": [
3    {
4      "giftCommitmentId": "6gcNA000000YshCYAS"
5    }
6  ]
7}

Here’s a response for the Close Gift Commitment action.

1[
2  {
3    "actionName": "closeGiftCommitment",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": null,
7    "version": 1
8  }
9]