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

KeyDatatypeRequiredDescription
Content-Typestring

RESPONSES

status: OK

{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;contactId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;amountPledged&quot;:&quot;\u003cdouble\u003e&quot;,&quot;frequency&quot;:&quot;\u003cstring\u003e&quot;,&quot;pledgeDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;expectedFulfillmentDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;createDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;createdByUser&quot;:&quot;\u003cstring\u003e&quot;,&quot;modifiedDateTimeUtc&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;modifiedByUser&quot;:&quot;\u003cstring\u003e&quot;,&quot;segmentId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;segment&quot;:&quot;\u003cstring\u003e&quot;,&quot;projectId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;project&quot;:&quot;\u003cstring\u003e&quot;,&quot;isPrivate&quot;:&quot;\u003cboolean\u003e&quot;,&quot;status&quot;:&quot;\u003cstring\u003e&quot;,&quot;payments&quot;:[{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;expectedPaymentDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;expectedAmount&quot;:&quot;\u003cdouble\u003e&quot;,&quot;giftId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;actualAmount&quot;:&quot;\u003cdouble\u003e&quot;},{&quot;id&quot;:&quot;\u003cinteger\u003e&quot;,&quot;expectedPaymentDate&quot;:&quot;\u003cdateTime\u003e&quot;,&quot;expectedAmount&quot;:&quot;\u003cdouble\u003e&quot;,&quot;giftId&quot;:&quot;\u003cinteger\u003e&quot;,&quot;actualAmount&quot;:&quot;\u003cdouble\u003e&quot;}],&quot;customFields&quot;:[{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;},{&quot;name&quot;:&quot;\u003cstring\u003e&quot;,&quot;value&quot;:&quot;\u003cstring\u003e&quot;,&quot;displayName&quot;:&quot;\u003cstring\u003e&quot;}]}