Manage Recurring Gift Commitment Schedule Action

Creates or updates a recurring type of gift commitment schedule record and creates the first upcoming gift commitment transaction record.

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/manageRcrGiftCmtSchd

Formats: JSON, XML

HTTP Methods: POST

Authentication: Authorization: Bearer token

Inputs

Input	Type	Description
`effectiveFromDate`	Date	The date from when the updates to the gift commitment schedule are effective. Only applicable in a schedule update scenario.
`effectiveToDate`	Date	The date until when the updates to the gift commitment schedule are effective. Only applicable in a schedule update scenario.
`giftCommitmentSchedule`	sObject	Required. The gift commitment schedule record to be created or updated.
`PaymentInstrument`	sObject	Required. The payment instrument record to be created or updated.

Outputs

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

Example

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

1{
2  "inputs": [
3    {
4      "giftCommitmentSchedules": [
5        {
6          "StartDate": "2023-08-26",
7          "PaymentMethod": "Check",
8          "Id": "6csNA000000hbx8YAA",
9          "EndDate": "2023-08-28"
10        },
11        {
12          "StartDate": "2023-08-29",
13          "PaymentMethod": "Check",
14          "Id": "6csNA000000hby4YAA",
15          "EndDate": "2023-08-30"
16        }
17      ],
18      "paymentInstrument": {
19        "Last4": "1234",
20        "Type": "Credit Card",
21        "ExpiryMonth": "May",
22        "ExpiryYear": "29"
23      }
24    }
25  ]
26}

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

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