Resume Gift Commitment Schedule Action

Resumes a paused gift commitment schedule on a specified date.

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

Inputs

Input Details
giftCommitmentScheduleId
Type
String
Description
Required.
The ID of the gift commitment schedule record to be resumed.
resumeDate
Type
Date
Description
The date to resume the gift commitment schedule.
updateReason
Type
String
Description
The reason the gift commitment schedule is to be resumed.

Outputs

Input Details
giftCommitmentScheduleIdsList
Type
String
Description
A comma-delimited list of gift commitment schedule IDs for schedules that were created or updated.

Example

Here’s a request for the Resume Gift Commitment Schedule action.

{
  "inputs": [
    {
      "giftCommitmentScheduleId": "6csNA000000hbxpYAA",
      "resumeDate": "2023-08-27"
      "updateReason": "Test"
    }
  ]
}

Here’s a response for the Resume Gift Commitment Schedule action.

[
  {
    "actionName": "resumeGiftCommitmentSchedule",
    "errors": null,
    "isSuccess": true,
    "outputValues": {
      "giftCommitmentScheduleIdsList": [
        "6csNA000000hbxpYAA"
      ]
    },
    "version": 1
  }
]