Sign in

v1

latestOpenAPI 3.0.02026-08-062903562.2 MB
Campaign Channel

createCampaignChannel

Create Channel for specified Campaign

post/campaigns/{campaign}/channels

Path parameters

campaigninteger required
Example:227362

The specified Campaign ID

Request body

campaign_idinteger

Primary identifier of associated Campaign

channel_name'DoubletheDonation' | 'Facebook' | 'Instagram' | 'MetaCapi' | 'MetaFrapi' | 'Zapier' required

Name of Integration Channel

created_atstring date-time

Date/time of initial record creation

idinteger

Primary identifier of record

statusboolean required

Whether the campaign channel is enabled.

processingboolean

Whether a MetaFrapi job is in progress for the associated campaign

updated_atstring date-time

Date/time of last record update

Example request

{
  "campaign_id": 423,
  "channel_name": "Facebook",
  "created_at": "2021-04-23T08:23:21Z",
  "id": 73625,
  "status": true,
  "metadata": {
    "employer_match_on_donation_page": true,
    "employer_match_on_thankyou_page": true,
    "employer_match_preselect": true
  },
  "updated_at": "2021-04-23T10:25:03Z"
}

Response

Success

campaign_idinteger

Primary identifier of associated Campaign

channel_name'DoubletheDonation' | 'Facebook' | 'Instagram' | 'MetaCapi' | 'MetaFrapi' | 'Zapier' required

Name of Integration Channel

created_atstring date-time

Date/time of initial record creation

idinteger

Primary identifier of record

statusboolean required

Whether the campaign channel is enabled.

processingboolean

Whether a MetaFrapi job is in progress for the associated campaign

updated_atstring date-time

Date/time of last record update

Example response

{
  "campaign_id": 423,
  "channel_name": "Facebook",
  "created_at": "2021-04-23T08:23:21Z",
  "id": 73625,
  "status": true,
  "metadata": {
    "employer_match_on_donation_page": true,
    "employer_match_on_thankyou_page": true,
    "employer_match_preselect": true
  },
  "updated_at": "2021-04-23T10:25:03Z"
}