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	Type	Description
`giftCommitmentScheduleId`	String	Required. The ID of the gift commitment schedule record to be resumed.
`resumeDate`	Date	The date to resume the gift commitment schedule.
`updateReason`	String	The reason the gift commitment schedule is to be resumed.

Outputs

Input	Type	Description
`giftCommitmentScheduleIdsList`	String	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.

1{
2  "inputs": [
3    {
4      "giftCommitmentScheduleId": "6csNA000000hbxpYAA",
5      "resumeDate": "2023-08-27"
6      "updateReason": "Test"
7    }
8  ]
9}

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

1[
2  {
3    "actionName": "resumeGiftCommitmentSchedule",
4    "errors": null,
5    "isSuccess": true,
6    "outputValues": {
7      "giftCommitmentScheduleIdsList": [
8        "6csNA000000hbxpYAA"
9      ]
10    },
11    "version": 1
12  }
13]