Nonprofit Cloud Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Introduction to Nonprofit Cloud
Nonprofit Cloud Data Model
Fundraising
Fundraising Standard Objects
Fundraising Fields on Other Objects
Fundraising Business APIs
Resources
Gifts Transactions (POST)
Commitments (POST)
Commitments (PATCH)
Transactions Payment Updates (POST)
Commitments Payment Updates (POST)
Request Bodies
Response Bodies
Fundraising Invocable Actions
Fundraising Metadata API Types
Fundraising Tooling API Objects
Program Management
Case Management
Outcome Management Standard Objects
Grantmaking
Group Memberships and Households in Nonprofit Cloud
Record Rollup Definitions
NonProfit Cloud Associated Objects
PDF

Commitments (PATCH)

Modify the data for the schedule, campaign, outreach source code, donor, and payment instrument on an active gift commitment.
Resource
/connect/fundraising/commitments/commitmentId
Resource example
https://yourInstance.salesforce.com/services/data/v63.0/connect​/fundraising/commitments/6gc0000AbCdZF9q
Available version
60.0
HTTP methods
PATCH
Request body for PATCH

You can pass the campaign, donor, and designation IDs in an externalId object containing fieldName and fieldValue.

Note

JSON example
{
  "amount": 150.25,
  "type": "pledge",
  "transactionInterval": 3,
  "transactionDay": "5",
  "startDate": "2024-07-06",
  "endDate": "2024-07-06",
  "campaign": {
    "id": "701y0030d0zk6t06f4"
  },
  "outreachSourceCode": {
    "id": "0gx000d0d0d0FD",
    "sourceCode": "AnimalEmailCampaign2023"
  },
  "donor": {
    "donorType": "individual",
    "organizationName": "ABC Inc.",
    "firstName": "Daniel",
    "lastName": "Chavez",
    "phone": "510-434-8920",
    "email": "d.chavez@salesforce.com",
    "address": [
      {
        "street": "123 Main Street",
        "city": "Oakland",
        "state": "CA",
        "postalCode": "94610",
        "country": "US"
      }
    ],
    "accountCustomFields": [
      {
        "fieldName": "string",
        "fieldValue": "string"
      }
    ],
    "paymentInstrument": {
      "type": "Credit Card",
      "accountHolderName": "Daniel Chavez",
      "expiryMonth": "10",
      "expiryYear": "2026",
      "last4": "4321",
      "cardBrand": "Diner's Club",
      "bankName": "chase",
      "digitalWalletProvider": "EProvider",
      "bankAccountHolderType": "primary",
      "bankAccountType": "checking",
      "bankAccountNumber": "123456",
      "bankCode": "HBUK",
      "gatewayName": "Gateway",
      "processorName": "Centpro",
      "processorPaymentReference": "string",
      "gatewayReference": "string"
    },
    "giftCommitmentCustomFields": [
      {
        "fieldName": "string",
        "fieldValue": "string"
      }
    ],
    "giftCommitmentScheduleCustomFields": [
      {
        "fieldName": "string",
        "fieldValue": "string"
      }
    ]
  }
}
Properties
Name Type Description Required or Optional Available Version
amount Double Gift amount of each transaction associated with the gift commitment schedule. Required 60.0
campaign Campaign Details Campaign that's associated with the gift commitment. Optional 60.0
currency​IsoCode String Currency ISO code of the gift commitment. Optional 60.0
donorId Donor Details Input Person, household, or organization account associated with the commitment. Optional 60.0
endDate String End date of the new schedule for this gift commitment. The format is YYYY-MM-DD. Optional 60.0
giftCommitment​Custom​Fields Custom Field Details[] Custom fields of the gift commitment. Optional 60.0
giftCommitment​Schedule​CustomFields Custom Field Details[] Custom fields of the gift commitment schedule. Optional 60.0
outreach​Source​Code Outreach Source Code Details Outreach source code that's associated with the campaign for the gift commitment. Optional 60.0
payment​Instrument Payment Instrument Details Payment instrument that's used to complete the transaction. Required 60.0
startDate String Start date of the new schedule for this gift commitment. The format is YYYY-MM-DD. Required 60.0
transaction​Day String Specifies the day of the month to create gift transactions in the future for a monthly transaction period. If you select the day as 29 or 30, the gift transaction is created on the last day for the months that don't have that many days. Optional 60.0
transaction​Interval Integer Transaction interval that's applicable to an incoming transaction in the commitment. Optional 60.0
transaction​Period String Transaction period that's applicable to the incoming transaction in the commitment. When type is pledge, this property must be set to Custom. If transactionPeriod is not provided, the default isCustom. Required 60.0
type String Type of transaction. Possible values are:
  • Pledge
  • Recurring
The default value is the Recurring. 		Optional 62.0
Response body for PATCH
Update Commitment