Update a Pledge | Virtuous Developer Documentation

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

{
  "id": "<integer>",
  "contactId": "<integer>",
  "amountPledged": "<double>",
  "frequency": "<string>",
  "pledgeDate": "<dateTime>",
  "expectedFulfillmentDate": "<dateTime>",
  "createDateTimeUtc": "<dateTime>",
  "createdByUser": "<string>",
  "modifiedDateTimeUtc": "<dateTime>",
  "modifiedByUser": "<string>",
  "segmentId": "<integer>",
  "segment": "<string>",
  "projectId": "<integer>",
  "project": "<string>",
  "isPrivate": "<boolean>",
  "status": "<string>",
  "payments": [
    {
      "id": "<integer>",
      "expectedPaymentDate": "<dateTime>",
      "expectedAmount": "<double>",
      "giftId": "<integer>",
      "actualAmount": "<double>"
    },
    {
      "id": "<integer>",
      "expectedPaymentDate": "<dateTime>",
      "expectedAmount": "<double>",
      "giftId": "<integer>",
      "actualAmount": "<double>"
    }
  ],
  "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

pledgeIdstringRequired

Request

This endpoint expects an object.

amountPledgedstringOptionalformat: "style"

frequencystringOptionalformat: "style"

pledgeDatestringOptional

expectedFulfillmentDatestringOptionalformat: "style"

giftAskIdstringOptional

segmentIdstringOptionalformat: "style"

projectIdstringOptional

isPrivatestringOptionalformat: "style"

paymentslist of objectsOptional

customFieldslist of objectsOptional

Response

idstringOptional

contactIdstringOptional

amountPledgedstringOptional

frequencystringOptional

pledgeDatestringOptional

expectedFulfillmentDatestringOptional

createDateTimeUtcstringOptional

createdByUserstringOptional

modifiedDateTimeUtcstringOptional

modifiedByUserstringOptional

segmentIdstringOptional

segmentstringOptional

projectIdstringOptional

projectstringOptional

isPrivatestringOptional

statusstringOptional

paymentslist of objectsOptional

customFieldslist of objectsOptional

Errors

400

Bad Request Error