Update a Pledge
PUT {{baseUrl}}/api/v2/Pledge/:pledgeId
Similar to other update methods in the API, excluding a property will remove it's value from the object. If you're only updating a single property, the entire model is still required.
Request Body
{"amountPledged"=>"<double:required>", "frequency"=>"<string:Once|Weekly|Monthly|Quarterly|Semiannually|Annually|Biennially|Custom:required>", "pledgeDate"=>"<dateTime:required>", "expectedFulfillmentDate"=>"<dateTime:required>", "giftAskId"=>"<integer:optional>", "segmentId"=>"<integer:optional>", "projectId"=>"<integer:optional>", "isPrivate"=>"<boolean:required>", "payments"=>[{"expectedPaymentDate"=>"<dateTime:required>", "expectedAmount"=>"<double:required>"}, {"expectedPaymentDate"=>"<dateTime:required>", "expectedAmount"=>"<double:required>"}], "customFields"=>[{"name"=>"<string:required>", "value"=>"<string:optional>"}, {"name"=>"<string:required>", "value"=>"<string:optional>"}]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"id":"\u003cinteger\u003e","contactId":"\u003cinteger\u003e","amountPledged":"\u003cdouble\u003e","frequency":"\u003cstring\u003e","pledgeDate":"\u003cdateTime\u003e","expectedFulfillmentDate":"\u003cdateTime\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","isPrivate":"\u003cboolean\u003e","status":"\u003cstring\u003e","payments":[{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"},{"id":"\u003cinteger\u003e","expectedPaymentDate":"\u003cdateTime\u003e","expectedAmount":"\u003cdouble\u003e","giftId":"\u003cinteger\u003e","actualAmount":"\u003cdouble\u003e"}],"customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]}