Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Donation Matching Plan

fetchDonationMatchingPlan

Fetch specified Donation Matching Plan

get/donation-matching-plans/{donation_matching_plan}

Path parameters

donation_matching_planinteger required
Example:23847

Primary identifier of Donation Matching Plan

Response

Success

idinteger

Primary identifier of record

campaign_idinteger

Primary identifier of associated Campaign

currency_codestring

Currency in which the Donation Matching Plan matches donations. The currency cannot be modified after the DonationMatchingPlan is created.

matching_limit_amountnumber nullable

Total amount in the Donation Matching Plan currency the sponsor is willing to match. 0 means unlimited.

started_atstring date-time required

Date/time of the beginning of the sponsor's matching period

ended_atstring date-time nullable

Date/time of the end of the sponsor's matching period. The value must be after the started_at value.

business_namestring required

Name of the sponsor. Will be displayed in feed items when matching donations

timezone_identifierstring required

Sponsor timezone

matched_amountinteger

Total amount the sponsor has currently matched, in the currency of the Donation Matching Plan

asset_idinteger nullable

Primary identifier of sponsor thumbnail Asset which will be displayed in Feed Items

created_atstring date-time

Date/time of initial record creation

updated_atstring date-time

Date/time of last record update

Example response

{
  "id": 23847,
  "campaign_id": 227362,
  "currency_code": "USD",
  "matching_limit_amount": 5000,
  "started_at": "2021-04-23T10:25:03Z",
  "ended_at": "2021-04-24T10:25:03Z",
  "business_name": "Sponsor Name",
  "timezone_identifier": "Europe/Paris",
  "matched_amount": 4200,
  "asset_id": 1145,
  "created_at": "2021-04-23T08:23:21Z",
  "updated_at": "2021-04-23T10:25:03Z"
}