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	Type	Description
`giftCommitmentId`	String	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]