Skip to content
Aller au contenu
Charitips

API reference · Campaigns

Get a donation matching

GET/v1/campaigns/{campaignId}/donation-matching

Get campaign donation matching configuration

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • campaignId#stringin pathrequired

Response

200 · DonationMatching

No field is described in the spec.

  • donationMatchingId#stringalways returned

  • rate#numberalways returned

  • maximumBudget#integer (int64)

  • maximumDonationBudget#integer (int64)

  • maximumDonorBudget#integer (int64)

  • status#DonationMatchingStatusalways returned

    ENABLEDDISABLED

  • campaignId#stringalways returned

  • createdAt#string (date-time)always returned

  • updatedAt#string (date-time)always returned

Errors

  • 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"
    }
GET /v1/campaigns/<campaignId>/donation-matching
curl -X GET https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/donation-matching \  -H "Authorization: Bearer $CHARITIPS_TOKEN"
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.