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

Formats

JSON, XML

HTTP Methods

POST

Authentication

Authorization: Bearer token

Inputs

Outputs

Example

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

{
  "inputs": [
    {
      "effectiveFromDate": "2023-09-25",
      "effectiveToDate": "2023-10-25",
      "giftCommitmentSchedule": {
        "GiftCommitmentId": "6gcNA000000PeKiYAK",
        "TransactionAmount": 100,
        "StartDate": "2023-08-30",
        "PaymentMethod": "Cheque",
        "Id": "6csNA000000hbxQYAQ"
      }
    }
  ]
}

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

[
  {
    "actionName": "manageRcrGiftCmtSchd",
    "errors": null,
    "isSuccess": true,
    "outputValues": {
      "giftCommitmentScheduleIdsList": [
        "6csNA000000hbx8YAA",
        "6csNA000000hby4YAA"
      ]
    },
    "version": 1
  }
]