Update a Recurring Gift
PUT {{baseUrl}}/api/RecurringGift/:recurringGiftId
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
{"startDate"=>"<dateTime>", "frequency"=>"Weekly|Bimonthly|Monthly|Quarterly|Semiannually|Annually|Biennially", "amount"=>"<double>", "nextExpectedPaymentDate"=>"<dateTime>", "anticipatedEndDate"=>"<dateTime>", "thankYouDate"=>"<dateTime>", "segmentId"=>"<integer>", "automatedPayments"=>"<boolean>", "trackPayments"=>"<boolean>", "isPrivate"=>"<boolean>", "designations"=>[{"projectId"=>"<integer>", "amountDesignated"=>"<double>"}, {"projectId"=>"<integer>", "amountDesignated"=>"<double>"}], "customFields"=>[{"name"=>"<string>", "value"=>"<string>", "displayName"=>"<string>"}, {"name"=>"<string>", "value"=>"<string>", "displayName"=>"<string>"}]}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string |
RESPONSES
status: OK
{"id":"\u003cinteger\u003e","transactionSource":"\u003cstring\u003e","transactionId":"\u003cstring\u003e","contactId":"\u003cinteger\u003e","startDate":"\u003cdateTime\u003e","amount":"\u003cdouble\u003e","frequency":"\u003cstring\u003e","anticipatedEndDate":"\u003cdateTime\u003e","cancelDateTimeUtc":"\u003cdateTime\u003e","createDateTimeUtc":"\u003cdateTime\u003e","createdByUser":"\u003cstring\u003e","modifiedDateTimeUtc":"\u003cdateTime\u003e","modifiedByUser":"\u003cstring\u003e","segmentId":"\u003cinteger\u003e","segment":"\u003cstring\u003e","segmentUrl":"\u003cstring\u003e","automatedPayments":"\u003cboolean\u003e","trackPayments":"\u003cboolean\u003e","isPrivate":"\u003cboolean\u003e","status":"\u003cstring\u003e","nextExpectedPaymentDate":"\u003cdateTime\u003e","designations":[{"projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","projectCode":"\u003cstring\u003e"},{"projectId":"\u003cinteger\u003e","project":"\u003cstring\u003e","projectUrl":"\u003cstring\u003e","amountDesignated":"\u003cdouble\u003e","projectCode":"\u003cstring\u003e"}],"customFields":[{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"},{"name":"\u003cstring\u003e","value":"\u003cstring\u003e","displayName":"\u003cstring\u003e"}]}