Gift v2 API for Pledge Creation

Alex Wong

@Heather McLean @Erik Leaver @Anthony Gallo

Hi, we have noticed that the automation I put in place for pledge creation using Gift v2's create gift (pledge) has failed, 1/16 was still working, and then first failed on 1/18 today.

When I look at the error, I notice it mention about installment object, so I checked the API documentation and notice there are some major changes to the JSON object used for creating pledge, which I understand and expect as it was always a PREVIEW.

My question to you is, is the new structure more or less the final structure now or more changes coming? We do rely on this pledge automation a LOT for our biggest program in the org, so I am wondering if I should take the time to update my code that aligns with the new structure or wait a few days/weeks.

Thank you

Alex Wong

Our finance and operation team deem the automation is too important to wait, so I went and tested the new structure and do want to say…

??????? THANK YOU! ???????

While I did have to play around with some situation where documentation isn't quite there, but was able create pledge with custom fields included (require the use of attribute type id, instead of category name), with acknowledgement info added (need to use “status” property, shown when click on the {} code icon instead of “AcknowledgementStatus” as shown in the “pancake” icon), gift subtype, and most importantly, the installment schedule. When pledge is created, it no longer has the “bug” where the pledge need to have installment rescheduled in database view in order for proper saving of the pledge.

the json object with the updated info from before:

{
"amount": {
"value": 5000
},
"comments": "PG2401-18P",
"constituent": {
"id": "458424"
},
"gift_date": "2024-01-18",
"gift_post_status": "NotPosted",
"gift_post_date": "2024-01-18",
"gift_splits": [
{
"amount": {
"value": 5000
},
"fund_id": "5386",
"campaign_id": "88",
"appeal_id": "3231",
"package_id": ""
}
],
"gift_type": "Pledge",
"gift_subtype": {
"name": "IL_PG_PLEDGE"
},
"receipts": [
{
"receipt_amount": {
"value": 5000
},
"receipt_status": "DoNotReceipt"
}
],
"payments": [
{
"amount": {
"value": 5000
},
"method": "Other"
}
],
"acknowledgements": [
{
"status": "NotAcknowledged",
"letter": {
"value": "12-Pledges"
}
}
],
"send_reminder": true,
"pledge_installments": [
{
"amount": 5000,
"date": "2024-09-30T00:00:00Z"
}
],
"custom_fields": [
{
"category": "401",
"description": "1"
},
{
"category": "726",
"description": "5000"
}
]
}

Heather McLean

@Alex Wong
Thank you for bringing this to my attention. Let me look into the documentation updates. I'm glad that the bug is fixed.