Skip to content
Aller au contenu
Charitips

API reference · Campaigns

Update a donation matching

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

Update campaign donation matching

Requires a Bearer access token.

Parameters

This field has no description in the spec.

  • campaignId#stringin pathrequired

Body

UpdateDonationMatchingDto

No field is described in the spec.

  • rate#numberminimum 0.5maximum 5

  • maximumBudget#numberintegerminimum 1

  • maximumDonationBudget#numberintegerminimum 1

  • maximumDonorBudget#numberintegerminimum 1

  • status#object

    ENABLEDDISABLED

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"
    }
PATCH /v1/campaigns/<campaignId>/donation-matching
curl -X PATCH https://api.sandbox.charitips.com/v1/campaigns/<campaignId>/donation-matching \  -H "Authorization: Bearer $CHARITIPS_TOKEN" \  -H "Content-Type: application/json" \  -d '{    "rate": 1,    "maximumBudget": 2000,    "status": "ENABLED"  }'
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.