Skip to content
Aller au contenu
Charitips

API reference · Votes

Update a vote

PATCH/v1/votes/{voteId}

Update the externalId and/or uniqueExternalId fields

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • voteId#stringin pathrequired

Body

UpdateVoteDto
  • externalId#string

    An optional internal id of your system e.g orderId or customerId. Can be used to link a donation to an entity in your system. Votes can be queried using this field.

  • uniqueExternalId#string

    Similar to externalId but should be unique across all votes. Can be used to prevent duplicate votes.

Response

200 · Vote

No field is described in the spec.

  • voteId#stringalways returned

  • weight#number

  • status#VoteStatusalways returned

    PENDINGDONEPROCESSED

  • secret#stringalways returned

  • externalId#string

  • uniqueExternalId#string

  • castedAt#string (date-time)

  • validatedAt#string (date-time)

  • processedAt#string (date-time)

  • billingStatus#BillingStatusalways returned

    PENDINGBILLEDPAID

  • autoAssigned#boolean

  • sendingMode#CampaignSendingModealways returned

    MANUALEMAILPHYSICALSLACKPOSTAL

  • sendingDate#string (date-time)

  • sendingStatus#DonationSendingStatusalways returned

    PENDINGFAILEDDONE

  • lastReminderId#string

  • message#string

  • reminderMessage#string

  • from#string

  • language#Languagealways returned

    fren

  • sharedOn#SocialNetwork

    LINKEDININSTAGRAMFACEBOOKTWITTERWHATSAPP

  • accountId#stringalways returned

  • campaignId#stringalways returned

  • charityId#string

  • transactionId#string

  • donorId#string

  • createdAt#string (date-time)always returned

  • updatedAt#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"
    }
  • 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"
    }
  • 409Unique constraint failed on uniqueExternalId

    {
      "statusCode": 409,
      "message": "Unique constraint failed on uniqueExternalId"
    }
PATCH /v1/votes/<voteId>
curl -X PATCH https://api.sandbox.charitips.com/v1/votes/<voteId> \  -H "Authorization: Bearer $CHARITIPS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "externalId": "<externalId>",    "uniqueExternalId": "<uniqueExternalId>"  }'
Built from the spec and the API code

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.