API v1 Reference

This API method is speculative; it does not yet exist.

The Update Pledge request updates an existing pledge record. Submit only the fields that you wish to update. Submitting a field parameter with no value will result in that field being overwritten as empty.

REST

Request

https://api.neoncrm.com/neonws/services/api/donation/updatePledge?userSessionId=[session id]&pledge.pledgeId=3847&pledge.amount=49&pledge.purpose.id=26&pledge.campaign.id=243&pledge.fund.id=11&pledge.date=2018-03-21

Response

{
    "updatePledge": {
        "operationResult": "SUCCESS",
        "responseDateTime": "2018-03-21T21:15:26.131-06:00",
        "pledgeId": 41727
    }
}

Request Parameters

Name Required Description
pledge.pledgeId Yes ID of pledge to be updated.
pledge.amount Dollar amount of pledge
pledge.date Pledge date. Format: 2012-12-30
pledge.anonymousType Possible values: No, DonorNameAnonymous, pledgeAmountAnonymous
pledge.donorName Specify the donor name if it is different from the account being credited for the pledge.
pledge.campaign.id Possible values can be retrieved from List Campaigns method. Required if campaign.name is not provided.
pledge.campaign.name Possible values can be retrieved from List Campaigns method. Required if campaign.id is not provided.
pledge.purpose.id Possible values can be retrieved from List Purposes method. Required if purpose.name is not provided.
pledge.purpose.name Possible values can be retrieved from List Purposes method. Required if purpose.id is not provided.
pledge.fund.id Possible values can be retrieved from List Funds method. Required if fund.name is not provided.
pledge.fund.name Possible values can be retrieved from List Funds method. Required if fund.id is not provided.
pledge.source.id Possible values can be retrieved from List Sources method. Required if source.name is not provided.
pledge.source.name Possible values can be retrieved from List Sources method. Required if source.id is not provided.
pledge.solicitation.id
pledge.solicitation.name
Honor / Memory
pledge.honorMemory.name
pledge.honorMemory.hmType
Donation Custom Fields
pledge.customFieldDataList.fieldId Donation custom fields can be retrieved from the List Custom Fields method.
pledge.customFieldDataList.fieldValue Donation custom fields can be retrieved from the List Custom Fields method.
pledge.customFieldDataList.fieldOptionId Donation custom fields can be retrieved from the List Custom Fields method.

Response Parameters

Name Required Description
pledgeId Yes The ID of the pledge record.

Error Codes

Code Text Description
51 CustomField id is invalid.
52 CustomField option value is required.
53 CustomField option id is required.
54 CustomField option id is invalid.
55 CustomField option id is duplicated.
56 CustomField id is duplicated.
10014 Source id or name is invalid.
10130 Address Type is invalid.
10133 Address country is invalid
10134 Address state is invalid
11003 Amount is required
11004 Donation date is required.
11005 Fund ID or Name is invalid
11006 Campaign ID or Name is invalid
11007 Purpose ID or Name is invalid