Nonprofit Cloud Developer Guide
jNote: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.
Pause Gift Commitment Schedule Action
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/pauseGiftCommitmentSchedule
Formats: JSON, XML
HTTP Methods: POST
Authentication: Authorization: Bearer token
Inputs
| Input | Type | Description |
|---|---|---|
| endDate | Date | The date to resume the gift commitment schedule. |
| giftCommitmentScheduleId | String | Required. The ID of the gift commitment schedule record to be paused. |
| startDate | Date | The date to pause the gift commitment schedule. |
| updateReason | String | The reason the gift commitment schedule is to be paused. |
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 Pause Gift Commitment Schedule action.
1{
2 "inputs": [
3 {
4 "giftCommitmentScheduleId": "6csNA000000YNbOYAW",
5 "startDate": "2023-08-25"
6 }
7 ]
8}Here's a response for the Pause Gift Commitment Schedule action.
1[
2 {
3 "actionName": "pauseGiftCommitmentSchedule",
4 "errors": null,
5 "isSuccess": true,
6 "outputValues": {
7 "giftCommitmentScheduleIdsList": [
8 "6csNA000000YNbOYAW",
9 "6csNA000000hbxuYAA"
10 ]
11 },
12 "version": 1
13 }
14]