Nonprofit Cloud Developer Guide
jCommitments (PATCH)
Modify the data for the schedule, campaign, outreach source code, donor, and payment
instrument on an active gift commitment.
Resource:
1/connect/fundraising/commitments/commitmentIdResource example:
1https://yourInstance.salesforce.com/services/data/v66.0/connect/fundraising/commitments/6gc0000AbCdZF9qAvailable version: 60.0
HTTP methods: PATCH
Request body for PATCH
JSON example
1{
2 "amount": 150.25,
3 "type": "pledge",
4 "transactionInterval": 3,
5 "transactionDay": "5",
6 "startDate": "2024-07-06",
7 "endDate": "2024-07-06",
8 "campaign": {
9 "id": "701y0030d0zk6t06f4"
10 },
11 "outreachSourceCode": {
12 "id": "0gx000d0d0d0FD",
13 "sourceCode": "AnimalEmailCampaign2023"
14 },
15 "processingOptions": {
16 "donorOptions": {
17 "defaultUpdateLogic": "update_all"
18 },
19 "disableGiftTransactionValidations": true,
20 "disableGiftCommitmentValidations": true,
21 "disableGiftCommitmentScheduleValidations": true
22 },
23 "donor": {
24 "donorType": "individual",
25 "organizationName": "ABC Inc.",
26 "firstName": "Daniel",
27 "lastName": "Chavez",
28 "phone": "510-434-8920",
29 "email": "d.chavez@salesforce.com",
30 "address": [
31 {
32 "street": "123 Main Street",
33 "city": "Oakland",
34 "state": "CA",
35 "postalCode": "94610",
36 "country": "US"
37 }
38 ],
39 "accountCustomFields": [
40 {
41 "fieldName": "string",
42 "fieldValue": "string"
43 }
44 ],
45 "paymentInstrument": {
46 "type": "Credit Card",
47 "accountHolderName": "Daniel Chavez",
48 "expiryMonth": "10",
49 "expiryYear": "2026",
50 "last4": "4321",
51 "cardBrand": "Diner's Club",
52 "bankName": "chase",
53 "digitalWalletProvider": "EProvider",
54 "bankAccountHolderType": "primary",
55 "bankAccountType": "checking",
56 "bankAccountNumber": "123456",
57 "bankCode": "HBUK",
58 "gatewayName": "Gateway",
59 "processorName": "Centpro",
60 "processorPaymentReference": "string",
61 "gatewayReference": "string"
62 },
63 "giftCommitmentCustomFields": [
64 {
65 "fieldName": "string",
66 "fieldValue": "string"
67 }
68 ],
69 "giftCommitmentScheduleCustomFields": [
70 {
71 "fieldName": "string",
72 "fieldValue": "string"
73 }
74 ]
75 }
76}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 |
| currencyIsoCode | 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 |
| giftCommitmentCustomFields | Custom Field Details[] | Custom fields of the gift commitment. | Optional | 60.0 |
| giftCommitmentScheduleCustomFields | Custom Field Details[] | Custom fields of the gift commitment schedule. | Optional | 60.0 |
| outreachSourceCode | Outreach Source Code Details | Outreach source code that's associated with the campaign for the gift commitment. | Optional | 60.0 |
| paymentInstrument | Payment Instrument Details | Payment instrument that's used to complete the transaction. | Required | 60.0 |
| processingOptions | Processing Options Details Input | Options for donor matching process and gift validation pausing | Optional | 60.0 |
| startDate | String | Start date of the new schedule for this gift commitment. The format is YYYY-MM-DD. | Required | 60.0 |
| transactionDay | 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 |
| transactionInterval | Integer | Transaction interval that's applicable to an incoming transaction in the commitment. | Optional | 60.0 |
| transactionPeriod | 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:
|
Optional | 62.0 |
Response body for PATCH: Update Commitment