Update a Recurring Gift | Virtuous Developer Documentation

curl -X PUT https://api.virtuoussoftware.com/api/RecurringGift/recurringGiftId \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "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>"
    }
  ]
}'

{
  "id": "<integer>",
  "transactionSource": "<string>",
  "transactionId": "<string>",
  "contactId": "<integer>",
  "startDate": "<dateTime>",
  "amount": "<double>",
  "frequency": "<string>",
  "anticipatedEndDate": "<dateTime>",
  "cancelDateTimeUtc": "<dateTime>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "segmentId": "<integer>",
  "segment": "<string>",
  "segmentUrl": "<string>",
  "automatedPayments": "<boolean>",
  "trackPayments": "<boolean>",
  "isPrivate": "<boolean>",
  "status": "<string>",
  "nextExpectedPaymentDate": "<dateTime>",
  "designations": [
    {
      "projectId": "<integer>",
      "project": "<string>",
      "projectUrl": "<string>",
      "amountDesignated": "<double>",
      "projectCode": "<string>"
    },
    {
      "projectId": "<integer>",
      "project": "<string>",
      "projectUrl": "<string>",
      "amountDesignated": "<double>",
      "projectCode": "<string>"
    }
  ],
  "customFields": [
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    },
    {
      "name": "<string>",
      "value": "<string>",
      "displayName": "<string>"
    }
  ]
}

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.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

recurringGiftIdstringRequired

Request

This endpoint expects an object.

startDatestringOptional

frequencystringOptional

amountstringOptional

nextExpectedPaymentDatestringOptional

anticipatedEndDatestringOptional

thankYouDatestringOptional

segmentIdstringOptional

automatedPaymentsstringOptional

trackPaymentsstringOptional

isPrivatestringOptional

designationslist of objectsOptional

customFieldslist of objectsOptional

Response

idstringOptional

transactionSourcestringOptional

transactionIdstringOptional

contactIdstringOptional

startDatestringOptional

amountstringOptional

frequencystringOptional

anticipatedEndDatestringOptional

cancelDateTimeUtcstringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

segmentIdstringOptional

segmentstringOptional

segmentUrlstringOptional

automatedPaymentsstringOptional

trackPaymentsstringOptional

isPrivatestringOptional

statusstringOptional

nextExpectedPaymentDatestringOptional

designationslist of objectsOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error