Process Gift Commitment Action

Updates the status and other relevant fields for a gift commitment based on the statuses of the associated gift transactions and the current gift commitment schedule.

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/processGiftCommitment
Formats
JSON, XML
HTTP Methods
POST
Authentication
Authorization: Bearer token

Inputs

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

Outputs

Input Details
giftCommitmentProcessingStatus
Type
String
Description
The status of the gift commitment record after it is processed.

Example

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

{
  "inputs": [
    {
      "giftCommitmentId": "6gcNA000000PeKhYAK"
    }
  ]
}

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

[
  {
    "actionName": "processGiftCommitment",
    "errors": null,
    "isSuccess": true,
    "outputValues": null,
    "version": 1
  }
]