POST /api/fundraise/pledges — vivenu-api

latestOpenAPI 3.0.32026-08-215925112.0 MB

36be0dca14e7

api

fundraise

Create a Pledge

post/api/fundraise/pledges

Request body

amountnumber required

The amount of the pledge

campaignIdstring

The ID of the campaign of the pledge

fundIdstring required

The ID of the fund of the pledge

customerIdstring required

The ID of the customer of the pledge

salesChannelIdstring

The ID of the sales channel of the pledge

notesstring

The notes of the pledge

targetDatestring date-time

An ISO timestamp indicating when the pledge is planned to be fulfilled.

externalIdstring

The external ID of the pledge

pledgedAtstring date-time

An ISO timestamp indicating when the pledge was pledged. (esp. helpful for pledges from external integrations)

Response

Created

_idstring required

The ID of the Pledge

amountnumber required

The amount of the pledge

currency'EUR' | 'USD' | 'GBP' | 'AUD' | 'CHF' | 'THB' | 'ILS' | 'COP' | 'MXN' | 'DKK' | 'NOK' | 'SEK' | 'QAR' | 'CAD' | 'ISK' | 'GTQ' | 'INR' | 'DOP' | 'SGD' | 'PLN' | 'SAR' | 'TTD' | 'ZAR' | 'KYD' | 'HKD' | 'CZK' | 'KRW' | 'JPY' | 'NZD' | 'AED' | 'MAD' | 'TWD' | 'BRL' | 'BWP' | 'NAD' | 'KES' | 'SCR' | 'TRY' | 'SZL' | 'LSL' | 'TZS' | 'UGX' | 'ZMW' | 'ZWG' | 'GHS' | 'NGN' | 'SLE' | 'LRD' | 'XOF' | 'XAF' | 'GEL' | 'IDR' | 'ARS' | 'CRC' | 'HUF' | 'EGP' | 'MYR' | 'VND' | 'PHP' | 'MWK' required

The currency of the pledge (will be automatically set using the seller's currency)