Programs

Endpoints for listing, retrieving, and fetching logos for the brand programs you've joined.

List all joined programs

get

Returns the list of programs you have signed up for.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

Query parameters

InsertionOrderStatusstring · enumOptional

Filter the result to programs whose contract has the specified status.

Possible values:

Responses

200

application/json

get

/Mediapartners/{AccountSID}/Campaigns

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Campaigns' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: application/json'

200

{
  "Campaigns": [
    {
      "AdvertiserId": "1804207",
      "AdvertiserName": "Acme Corporation",
      "AdvertiserUrl": "https://www.acmecorporation.io",
      "CampaignId": "10306",
      "CampaignName": "Wayne Enterprises",
      "CampaignUrl": "http://www.wayne.limited",
      "CampaignDescription": "Wayne Enterprises delivers innovative automotive tech and premium sports equipment.",
      "Type": "Performance",
      "ShippingRegions": [
        "SOUTHAFRICA",
        "UK",
        "US"
      ],
      "CampaignLogoUri": "/Mediapartners/<AccountSID>/Campaigns/10306/Logo",
      "PublicTermsUri": "/Mediapartners/<AccountSID>/Campaigns/10306/PublicTerms",
      "ContractStatus": "Active",
      "ContractUri": "/Mediapartners/<AccountSID>/Campaigns/10306/Contracts/Active",
      "TrackingLink": "https://example.sjv.io/c/1924609/650971/10306",
      "HasStandDownPolicy": "true",
      "AllowsDeeplinking": "true",
      "DeeplinkDomains": [
        "impact.com",
        "*.impact.com"
      ],
      "Uri": "/Mediapartners/<AccountSID>/Campaigns/10306"
    }
  ]
}

Retrieve a program

get

Returns the details of a single program you've joined.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

CampaignIdstringRequired

Unique identifier for the program.

Responses

200

application/json

AdvertiserIdstringOptional

Unique identifier of the brand (advertiser) running this program.

Example: 1804207

AdvertiserNamestringOptional

Display name of the brand.

Example: Acme Corporation

AdvertiserUrlstringOptional

URL of the brand's main website.

Example: https://www.acmecorporation.io

CampaignIdstringOptional

Unique identifier of the program (the URL path still uses "Campaigns" for backwards compatibility).

Example: 10306

CampaignNamestringOptional

Display name of the program.

Example: Wayne Enterprises

CampaignUrlstringOptional

URL of the program's landing site.

Example: http://www.wayne.limited

CampaignDescriptionstringOptional

Description of the program supplied by the brand.

Example: Wayne Enterprises delivers innovative automotive tech and premium sports equipment.

Typestring · enumOptional

The classification of the campaign. This indicates the specific program type you're joined to. Look for Retail Media Seller to identify programs that require unique link generation workflows.

Example: PerformancePossible values:

CampaignLogoUristringOptional

API resource path to retrieve the program's logo image.

Example: /Mediapartners/<AccountSID>/Campaigns/10306/Logo

PublicTermsUristringOptional

API resource path to the public terms in the program's contract.

Example: /Mediapartners/<AccountSID>/Campaigns/10306/PublicTerms

ContractStatusstring · enumOptional

Current state of your contract with this program.

Example: ActivePossible values:

ContractUristringOptional

API resource path to your active contract with this program (see the Partner Contracts API).

Example: /Mediapartners/<AccountSID>/Campaigns/10306/Contracts/Active

TrackingLinkstringOptional

A ready-to-use tracking link for this program. Generate additional links via the Partner Tracking Links API.

Example: https://example.sjv.io/c/1924609/650971/10306

HasStandDownPolicystring · enumOptional

String boolean indicating whether the brand enforces a stand-down policy (rules around bidding restrictions or trademark use).

Example: truePossible values:

AllowsDeeplinkingstring · enumOptional

String boolean indicating whether deep linking is enabled for this program.

Example: truePossible values:

DeeplinkDomainsstring[]Optional

Domains the brand permits deep linking to. Wildcards (e.g., *.impact.com) include all subdomains.

Example: ["impact.com","*.impact.com"]

UristringOptional

API resource path for this program.

Example: /Mediapartners/<AccountSID>/Campaigns/10306

404

No program exists with the supplied CampaignId, or you haven't joined it.

get

/Mediapartners/{AccountSID}/Campaigns/{CampaignId}

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Campaigns/{CampaignId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: application/json'

{
  "AdvertiserId": "1804207",
  "AdvertiserName": "Acme Corporation",
  "AdvertiserUrl": "https://www.acmecorporation.io",
  "CampaignId": "10306",
  "CampaignName": "Wayne Enterprises",
  "CampaignUrl": "http://www.wayne.limited",
  "CampaignDescription": "Wayne Enterprises delivers innovative automotive tech and premium sports equipment.",
  "Type": "Performance",
  "ShippingRegions": [
    "SOUTHAFRICA",
    "UK",
    "US"
  ],
  "CampaignLogoUri": "/Mediapartners/<AccountSID>/Campaigns/10306/Logo",
  "PublicTermsUri": "/Mediapartners/<AccountSID>/Campaigns/10306/PublicTerms",
  "ContractStatus": "Active",
  "ContractUri": "/Mediapartners/<AccountSID>/Campaigns/10306/Contracts/Active",
  "TrackingLink": "https://example.sjv.io/c/1924609/650971/10306",
  "HasStandDownPolicy": "true",
  "AllowsDeeplinking": "true",
  "DeeplinkDomains": [
    "impact.com",
    "*.impact.com"
  ],
  "Uri": "/Mediapartners/<AccountSID>/Campaigns/10306"
}

Retrieve program logo

get

Returns the program's logo as a binary image. Use the Accept request header to choose the format — image/gif (default), image/png, or image/jpeg.

Authorizations

AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters

AccountSIDstringRequired

Unique identifier for the partner account.

CampaignIdstringRequired

Unique identifier for the program.

Responses

200

Binary data of the requested logo.

string · binaryOptional

404

No logo exists for this program.

get

/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Logo

curl

curl -L \
  --url 'https://api.impact.com/Mediapartners/{AccountSID}/Campaigns/{CampaignId}/Logo' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: image/png'

binary

PreviousPrograms NextModels

Last updated 6 days ago