Back to Collection Items
void ChilkatSample(void)
{
json.UpdateNumber(L"amount",L"150.25"); json.UpdateString(L"transactionPeriod",L"monthly"); json.UpdateInt(L"transactionInterval",3); json.UpdateString(L"transactionDay",L"5"); json.UpdateString(L"startDate",L"2024-07-06"); json.UpdateString(L"endDate",L"2024-07-06"); json.UpdateString(L"campaign.id",L"<CAMPAIGN_ID>"); json.UpdateString(L"outreachSourceCode.id",L"<SOURCE_CODE_ID>"); json.UpdateString(L"outreachSourceCode.sourceCode",L"AnimalEmailCampaign2023"); json.UpdateString(L"donor.donorType",L"individual"); json.UpdateString(L"donor.organizationName",L"mini cat town"); json.UpdateString(L"donor.firstName",L"David"); json.UpdateString(L"donor.lastName",L"Taylor"); json.UpdateString(L"donor.phone",L"510-434-8920"); json.UpdateString(L"donor.email",L"davidtaylor@salesforce.com"); json.UpdateString(L"donor.address[0].addressType",L"mailing"); json.UpdateString(L"donor.address[0].street",L"123 Main Street"); json.UpdateString(L"donor.address[0].city",L"Oakland"); json.UpdateString(L"donor.address[0].state",L"CA"); json.UpdateString(L"donor.address[0].postalCode",L"94610"); json.UpdateString(L"donor.address[0].country",L"US"); json.UpdateString(L"donor.accountCustomFields[0].fieldName",L"string"); json.UpdateString(L"donor.accountCustomFields[0].fieldValue",L"string"); json.UpdateString(L"paymentInstrument.type",L"credit card"); json.UpdateString(L"paymentInstrument.accountHolderName",L"david taylor"); json.UpdateString(L"paymentInstrument.expiryMonth",L"10"); json.UpdateString(L"paymentInstrument.expiryYear",L"2026"); json.UpdateString(L"paymentInstrument.last4",L"4585"); json.UpdateString(L"paymentInstrument.cardBrand",L"visa"); json.UpdateString(L"paymentInstrument.bankName",L"chase"); json.UpdateString(L"paymentInstrument.digitalWalletProvider",L"apple pay"); json.UpdateString(L"paymentInstrument.bankAccountHolderType",L"primary"); json.UpdateString(L"paymentInstrument.bankAccountType",L"checking"); json.UpdateString(L"paymentInstrument.bankAccountNumber",L"123456"); json.UpdateString(L"paymentInstrument.bankCode",L"HBUK"); json.UpdateString(L"paymentInstrument.gatewayName",L"stripe"); json.UpdateString(L"paymentInstrument.processorName",L"classy"); json.UpdateString(L"paymentInstrument.processorPaymentReference",L"string"); json.UpdateString(L"paymentInstrument.gatewayReference",L"string"); json.UpdateString(L"giftCommitmentCustomFields[0].fieldName",L"string"); json.UpdateString(L"giftCommitmentCustomFields[0].fieldValue",L"string"); json.UpdateString(L"giftCommitmentScheduleCustomFields[0].fieldName",L"string"); json.UpdateString(L"giftCommitmentScheduleCustomFields[0].fieldValue",L"string"); http.put_AuthToken(L"<access_token>"); json.EmitSb(sbRequestBody); success = http.HttpSb(L"PATCH",L"https://domain.com/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId",sbRequestBody,L"utf-8",L"application/json",resp); resp.GetBodySb(sbResponseBody); jResp.LoadSb(sbResponseBody); jResp.put_EmitCompact(false);
}
Curl Command
curl -X PATCH
-H "Authorization: Bearer <access_token>"
-d '{
"amount": 150.25,
"transactionPeriod": "monthly",
"transactionInterval": 3,
"transactionDay": "5",
"startDate": "2024-07-06",
"endDate": "2024-07-06",
"campaign": {
"id": "<CAMPAIGN_ID>"
},
"outreachSourceCode": {
"id": "<SOURCE_CODE_ID>",
"sourceCode": "AnimalEmailCampaign2023"
},
"donor": {
"donorType": "individual",
"organizationName": "mini cat town",
"firstName": "David",
"lastName": "Taylor",
"phone": "510-434-8920",
"email": "davidtaylor@salesforce.com",
"address": [
{
"addressType": "mailing",
"street": "123 Main Street",
"city": "Oakland",
"state": "CA",
"postalCode": "94610",
"country": "US"
}
],
"accountCustomFields": [
{
"fieldName": "string",
"fieldValue": "string"
}
]
},
"paymentInstrument": {
"type": "credit card",
"accountHolderName": "david taylor",
"expiryMonth": "10",
"expiryYear": "2026",
"last4": "4585",
"cardBrand": "visa",
"bankName": "chase",
"digitalWalletProvider": "apple pay",
"bankAccountHolderType": "primary",
"bankAccountType": "checking",
"bankAccountNumber": "123456",
"bankCode": "HBUK",
"gatewayName": "stripe",
"processorName": "classy",
"processorPaymentReference": "string",
"gatewayReference": "string"
},
"giftCommitmentCustomFields": [
{
"fieldName": "string",
"fieldValue": "string"
}
],
"giftCommitmentScheduleCustomFields": [
{
"fieldName": "string",
"fieldValue": "string"
}
]
}'
https://domain.com/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId
Postman Collection Item JSON
{
"name": "Update Commitments",
"request": {
"method": "PATCH",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"id\": \"<CAMPAIGN_ID>\"\n },\n \"outreachSourceCode\": {\n \"id\": \"<SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"organizationName\": \"mini cat town\",\n \"firstName\": \"David\",\n \"lastName\": \"Taylor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"davidtaylor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david taylor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments",
":commitmentId"
],
"variable": [
{
"key": "commitmentId",
"value": ""
}
]
},
"description": "Modify the schedule or payment instrument metadata on an existing active gift commitment.\n\n## Required Attributes:\n\n- {commitmentId}\n \n- amount\n \n- transactionPeriod (Monthly, Weekly, Yearly, etc.)\n \n- startDate\n \n- paymentInstrument.type\n \n\nAll other attributes are optional can be left as an empty string or just removed from the request body entirely. The only exceptions to this are:\n\n- CustomFields collections - These cannot be left in the request body as an empty collection or with an empty string for the FieldName.\n \n\n## Validated Property Formats (an empty string is considered valid)\n\n- DateTime - YYYY-MM-DDTHH:MM:SSZ\n \n- Date - YYYY-MM-DD\n \n- Email - a valid formatted email address\n \n\n### Other Attributes\n\n- OutreachSource -- This is optional. Be sure to create the OutreachSourceCode record in the system if passing a value\n \n- Will accept either an OutreachSourceCode.id (SalesforceId) or an OutreachSourceCode.Code.\n \n\n### Custom Fields\n\n- The field_value can be a text string (inc. for a date data-type) or a numeric value (without quotes)\n \n- Do not include an empty collection or an empty fieldName in the request body"
},
"response": [
{
"name": "Status200-UpdateCommitmentSuccess",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"id\": \"<CAMPAIGN_ID>\"\n },\n \"outreachSourceCode\": {\n \"id\": \"<SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"organizationName\": \"mini cat town\",\n \"firstName\": \"David\",\n \"lastName\": \"Taylor\",\n \"phone\": \"510-434-8920\",\n \"email\": \"davidtaylor@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david taylor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments",
":commitmentId"
],
"variable": [
{
"key": "commitmentId",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_ID>\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\"\n }\n }\n}"
},
{
"name": "Status200-UpdateCommitmentRequestValidationFailure",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"id\": \"<SFDC_CAMPAIGN_ID>\"\n },\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments",
":commitmentId"
],
"variable": [
{
"key": "commitmentId",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"field\": \"donor.id\",\n \"message\": \"You cant include the donor ID in the request for the Gift Commitment Patch endpoint. Remove the ID from the Donor JSON request and try again.\"\n }\n ],\n \"success\": false\n}"
},
{
"name": "Status200-UpdateCommitmentDatabaseFailure",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": 150.25,\n \"transactionPeriod\": \"tomorrow\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments",
":commitmentId"
],
"variable": [
{
"key": "commitmentId",
"value": ""
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"errors\": [\n {\n \"message\": \"Transaction Period: bad value for restricted picklist field: tomorrow\"\n }\n ],\n \"success\": false\n}"
},
{
"name": "Status200-UpdateCommitmentSuccessWithExternalIds",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n\"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"campaign\": {\n \"externalId\": {\n \"fieldName\": \"<EXTERNAL_ID_FIELD_NAME>\",\n \"fieldValue\": \"<EXTERNAL_ID_FIELD_VALUE>\"\n }\n },\n \"outreachSourceCode\": {\n \"id\": \"<SOURCE_CODE_ID>\",\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"donor\": {\n \"donorType\": \"individual\",\n \"organizationName\": \"ABC Inc.\",\n \"firstName\": \"David\",\n \"lastName\": \"Chavez\",\n \"phone\": \"510-434-8920\",\n \"email\": \"d.chavez@salesforce.com\",\n \"address\": [\n {\n \"addressType\": \"mailing\",\n \"street\": \"123 Main Street\",\n \"city\": \"Oakland\",\n \"state\": \"CA\",\n \"postalCode\": \"94610\",\n \"country\": \"US\"\n }\n ],\n \"accountCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"david chavez\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"classy\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n },\n \"giftCommitmentCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ],\n \"giftCommitmentScheduleCustomFields\": [\n {\n \"fieldName\": \"string\",\n \"fieldValue\": \"string\"\n }\n ]\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/{fieldValue}?externalIdField={fieldName}",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments",
"{fieldValue}"
],
"query": [
{
"key": "externalIdField",
"value": "{fieldName}"
}
]
}
},
"status": "OK",
"code": 200,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": "{\n \"success\": true,\n \"links\": {\n \"giftcommitment\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_ID>\"\n },\n \"giftcommitmentschedule\": {\n \"href\": \"/services/data/vXX.X/sobjects/sObject/<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\",\n \"id\": \"<SFDC_GIFT_COMMITMENT_SCHEDULE_ID>\"\n }\n }\n}"
},
{
"name": "Status400-BadRequestError",
"originalRequest": {
"method": "POST",
"header": [
],
"body": {
"mode": "raw",
"raw": "{\n \"amount\": 150.25,\n \"transactionPeriod\": \"monthly\",\n \"transactionInterval\": 3,\n \"transactionDay\": \"5\",\n \"startDate\": \"2024-07-06\",\n \"endDate\": \"2024-07-06\",\n \"outreachSourceCode\": {\n \"sourceCode\": \"AnimalEmailCampaign2023\"\n },\n \"paymentInstrument\": {\n \"type\": \"credit card\",\n \"accountHolderName\": \"test donor\",\n \"expiryMonth\": \"10\",\n \"expiryYear\": \"2026\",\n \"last4\": \"4585\",\n \"cardBrand\": \"visa\",\n \"bankName\": \"chase\",\n \"digitalWalletProvider\": \"apple pay\",\n \"bankAccountHolderType\": \"primary\",\n \"bankAccountType\": \"checking\",\n \"bankAccountNumber\": \"123456\",\n \"bankCode\": \"HBUK\",\n \"gatewayName\": \"stripe\",\n \"processorName\": \"test processor\",\n \"processorPaymentReference\": \"string\",\n \"gatewayReference\": \"string\"\n }\n}",
"options": {
"raw": {
"language": "json"
}
}
},
"url": {
"raw": "{{_endpoint}}/services/data/v{{version}}/connect/fundraising/commitments/:commitmentId",
"host": [
"{{_endpoint}}"
],
"path": [
"services",
"data",
"v{{version}}",
"connect",
"fundraising",
"commitments",
":commitmentId"
],
"variable": [
{
"key": "commitmentId",
"value": ""
}
]
}
},
"status": "Bad Request",
"code": 400,
"_postman_previewlanguage": "json",
"header": [
{
"key": "Content-Type",
"value": "application/json",
"description": ""
}
],
"cookie": [
],
"body": " // Even if the JSON request is valid, this is an example of a 400 error code that will be returned if duplicate matching rules are not active. Any non 200 error code would have a similar response structure.\n {\n \"errorCode\": \"UNKNOWN_EXCEPTION\",\n \"message\": \"Provide active duplicate matching rules on Account and Person Account for donor matching. -- industries.fundraisingops.connect.impl.validator.ValidatorUtil.validateMatchingMethod(ValidatorUtil.java:103)\"\n }"
}
]
}
