Newer Version Available

This content describes an older version of this product. View Latest

Update Processed Gift Entries Action

Updates the status of a specified gift entry record that is already processed. If the processing fails, the failure reason is updated.

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

Inputs

Input Details
donorId
Type
ID
Description
The ID of the account of the donor that is updated when giftProcessingStatus is Success.
giftEntryId
Type
ID
Description
Required.
The ID of the gift entry record to be updated.
giftProcessingErrorDetails
Type
String
Description
The error details when giftProcessingStatus is Failure.
giftProcessingStatus
Type
String
Description
The processing status of the gift entry.

Valid values are:

  • Failure
  • New
  • Success
giftTransactionId
Type
ID
Description
The ID of the gift transaction record associated with the gift entry that is to be updated when giftProcessingStatus is Success.

Outputs

Field Details
giftEntryId
Type
ID
Description
The ID of the gift entry record that is updated.

Example

Here’s a request for the Update Processed Gift Entries action.

1{
2  "inputs": [
3    {
4      "donorId": "001RM000005ewDDYAY",
5      "giftEntryId": "6geRM00000000GdYAI",
6      "giftProcessingErrorDetails": null,
7      "giftProcessingStatus": "SUCCESS",
8      "giftTransactionId": "6trRM00000003PJ"
9    }
10  ]
11}

Here’s a response for the Update Processed Gift Entries action.

1[
2  {
3    "actionName": "updateProcessedGiftEntries",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "giftEntryId": "6geRM00000000GdYAI"
8    },
9    "version": 1
10  }
11]