API reference · Votes
Cast a vote
POST/v1/votes/{voteId}/cast
Link a donation with a given Charity.
Requires a Bearer access token.
Parameters
This field has no description in the spec.
voteId#stringin pathrequired
Body
CastVoteDtocharityId#stringrequiredUUIDId of the chosen Charity.
Response
200 · VoteNo field is described in the spec.
voteId#stringalways returnedweight#numberstatus#VoteStatusalways returnedPENDINGDONEPROCESSEDsecret#stringalways returnedexternalId#stringuniqueExternalId#stringcastedAt#string (date-time)validatedAt#string (date-time)processedAt#string (date-time)billingStatus#BillingStatusalways returnedPENDINGBILLEDPAIDautoAssigned#booleansendingMode#CampaignSendingModealways returnedMANUALEMAILPHYSICALSLACKPOSTALsendingDate#string (date-time)sendingStatus#DonationSendingStatusalways returnedPENDINGFAILEDDONElastReminderId#stringmessage#stringreminderMessage#stringfrom#stringlanguage#Languagealways returnedfrenaccountId#stringalways returnedcampaignId#stringalways returnedcharityId#stringtransactionId#stringdonorId#stringcreatedAt#string (date-time)always returnedupdatedAt#string (date-time)always returned
Errors
400A field is missing, has the wrong type, or is not part of the request schema.
Every request with a body or query is validated.
{ "statusCode": 400, "message": [ "amount must not be less than 1", "property foo should not exist" ], "error": "Bad Request" }401Unauthorized
Missing, expired or invalid access token.
{ "statusCode": 401, "message": "Unauthorized" }403Campaign has ended.
{ "statusCode": 403, "message": "Campaign has ended.", "error": "Forbidden" }403Account not validated
{ "statusCode": 403, "message": "Account not validated", "error": "Forbidden" }403Account closed
{ "message": "Account closed", "code": "ACCOUNT_CLOSED" }403Forbidden
Your credentials cannot perform this action on this resource. An id from another account answers 404 in the path, 400 in the body or the query.
{ "statusCode": 403, "message": "Forbidden" }404Not Found
No resource with this id on your account: the API answers as if it did not exist.
{ "statusCode": 404, "message": "Not Found" }409Vote already casted
{ "statusCode": 409, "message": "Vote already casted", "error": "Conflict" }
curl -X POST https://api.sandbox.charitips.com/v1/votes/<voteId>/cast \ -H "Authorization: Bearer $CHARITIPS_TOKEN" \ -H "Content-Type: application/json" \ -d '{ "charityId": "<charityId>" }'Request bodies are written for this docs and checked against the API's validation; ids in angle brackets are placeholders. Response values are placeholders built from the schema.