Partners

List all partners

get

Returns a list of all partners sorted by creation date (oldest first).

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Query parameters

IdstringOptional

Filter by one or more specific partner IDs (comma-separated).

CampaignIdintegerOptional

Filter partners joined to a specific campaign.

GroupIdintegerOptional

Filter by a specific partner group ID.

CountrystringOptional

Filter by country enum value. Possible values: US, UK, CANADA, AUSTRALIA, GERMANY, FRANCE, AFGHANISTAN, ALAND ISLANDS, ALBANIA, ALGERIA, AMERICANSAMOA, ANDORRA, ANGOLA, ANGUILLA, ANTARCTICA, ANTIGUABARBUDA, ARGENTINA, ARMENIA, ARUBA, AUSTRIA, AZERBAIJAN, BAHAMAS, BAHRAIN, BANGLADESH, BARBADOS, BELARUS, BELGIUM, BELIZE, BENIN, BERMUDA, BHUTAN, BOLIVIA, BOSNIAHERZEGOVINA, BOTSWANA, BRAZIL, BRITISHINDIANOCEANTERRITORY, BRUNEIDARUSSALAM, BULGARIA, BURKINAFASO, BURUNDI, CAMBODIA, CAMEROON, CAPVERDE, CAYMANISLANDS, CENTRALAFRICANREPUBLIC, CHAD, CHILE, CHINA, CHRISTMASISLAND, COCOSISLANDS, COLOMBIA, COMOROS, CONGO, DEMOCRATICREPUBLICCONGO, COOKISLANDS, COSTARICA, IVORYCOAST, CROATIA, CUBA, CYPRUS, CZECHREPUBLIC, DENMARK, DIJIBOUTI, DOMINICA, DOMINICANREPUBLIC, ECUADOR, EGYPT, ELSALVADOR, EQUATORIALGUINEA, ERITREA, ESTONIA, ETHIOPIA, FALKLANDISLANDS, FAROEISLANDS, FIJI, FINLAND, FRENCHGUIANA, FRENCHPOLYNESIA, FRENCHSOUTHERNTERRITORIES, GABON, GAMBIA, GEORGIA, GHANA, GIBRALTAR, GREECE, GREENLAND, GRENADA, GUADELOUPE, GUAM, GUATEMALA, GUERNSEY, GUINEA, GUINEABISSAU, GUYANA, HAITI, VATICAN, HONDURAS, HONGKONG, HUNGARY, ICELAND, INDIA, INDONESIA, IRAN, IRAQ, IRELAND, ISLE OF MAN, ISRAEL, ITALY, JAMAICA, JAPAN, JERSEY, JORDAN, KAZAKHSTAN, KENYA, KIRIBATI, SOUTHKOREA, KUWAIT, KYRGYZSTAN, LAOS, LATVIA, LEBANON, LESOTHO, LIBERIA, LIBYA, LICHTENSTEIN, LITHUANIA, LUXEMBOURG, MACAO, MACEDONIA, MADAGASCAR, MALAWI, MALAYSIA, MALDIVES, MALI, MALTA, MARSHALLISLANDS, MARTINIQUE, MAURITANIA, MAURITIUS, MAYOTTE, MEXICO, MICRONESIA, MOLDOVA, MONACO, MONGOLIA, MONTENEGRO, MONTSERRAT, MOROCCO, MOZAMBIQUE, MYANMAR, NAMIBIA, NAURU, NEPAL, NETHERLANDS, NETHERLANDSANTILLES, NEWCALEDONIA, NEWZEALAND, NICARAGUA, NIGER, NIGERIA, NIUE, NORFOLKISLAND, NORTHKOREA, NORTHERNMARIANAISLANDS, NORWAY, OMAN, PAKISTAN, PALAU, PALESTINIANTERRITORY, PANAMA, PAPUANEWGUINEA, PARAGUAY, PERU, PHILIPPINES, PITCAIRN, POLAND, PORTUGAL, PUERTORICO, QATAR, REUNION, ROMANIA, RUSSIA, RWANDA, SAINTHELENA, SAINTKITTSNEVIS, SAINTLUCIA, SAINTPIERREMIQUELON, SAINTVINCENTGRENADINES, SAMOA, SANMARINO, SAOTOME, SAUDIARABIA, SENEGAL, SERBIA, YUGOSLAVIA, SEYCHELLES, SIERRALEONE, SINGAPORE, SLOVAKIA, SLOVENIA, SOLOMONISLANDS, SOMALIA, SOUTHAFRICA, SPAIN, SRILANKA, SUDAN, SURINAME, SVALBARDJANMAYEN, SWAZILAND, SWEDEN, SWITZERLAND, SYRIA, TAIWAN, TAJIKISTAN, TANZANIA, THAILAND, TIMOR, TOGO, TOKELAU, TONGA, TRINIDADTOBAGO, TUNISIA, TURKEY, TURKMENISTAN, TURKSCAICOSISLANDS, TUVALU, UGANDA, UKRAINE, UAE, UNITED STATES MINOR OUTLYING ISLANDS, URUGUAY, UZBEKISTAN, VANUATU, VENEZUELA, VIETNAM, BRITISHVIRGINISLANDS, USVIRGINISLANDS, WALLISFUTUNA, WESTERNSAHARA, YEMEN, ZAMBIA, ZIMBABWE.

startDatestring · date-timeOptional

Filter by DateLastUpdated after this date (ISO 8601).

endDatestring · date-timeOptional

Filter by DateLastUpdated before this date (ISO 8601).

Statestring · enumOptional

Filter by partner account state.

Possible values:

RelationshipStatestringOptional

Filter by the partner's current relationship with your program. Possible values:

ACTIVE — The partner has an active relationship with you.
INACTIVE — The partner doesn't have a contractual relationship with you.

Responses

200

A list of partner objects.

application/json

get/Advertisers/{AccountSID}/MediaPartners

GET /Advertisers/{AccountSID}/MediaPartners HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A list of partner objects.

{
  "Partners": [
    {
      "Id": "2552842",
      "Name": "Wile E. Coyote Facebook",
      "Description": "Affiliate website partner.",
      "Website": "https://www.example-partner.com",
      "State": "ACTIVE",
      "Address": {
        "Country": "US",
        "Address1": "123 Main St",
        "City": "Santa Barbara",
        "State": "CA",
        "PostalCode": "93101"
      },
      "Phone": {
        "Country": "text",
        "Number": "text"
      },
      "Currency": "USD",
      "Timezone": "America/Los_Angeles",
      "IndirectTax": {
        "Country": "text",
        "Number": "text"
      },
      "PartnerType": "PUBLISHER",
      "PromotionalMethods": [
        {
          "Type": "text",
          "IsPrimary": true
        }
      ],
      "PromotionalCountries": [
        "US"
      ],
      "Properties": [
        {
          "Id": "2552842",
          "Name": "Wile E. Coyote Facebook",
          "Type": "SOCIAL",
          "Platform": "FACEBOOK",
          "Url": "https://www.facebook.com/example",
          "Doe": "2021-04-01T04:07:48-04:00",
          "Dlu": "2021-04-01T04:07:48-04:00"
        }
      ],
      "PromotionalCategories": [
        "Sports"
      ],
      "Programs": [
        {
          "Id": "text",
          "Name": "text",
          "ContractId": "text",
          "ContractName": "text",
          "JoinDate": "2026-07-16T11:28:47.139Z",
          "ExpirationDate": "2026-07-16T11:28:47.139Z",
          "Groups": [
            {
              "GroupId": "text",
              "GroupName": "text"
            }
          ]
        }
      ],
      "Contacts": [
        {
          "FirstName": "text",
          "LastName": "text",
          "Labels": [
            "text"
          ],
          "Email": "name@gmail.com",
          "Phones": [
            {
              "Type": "CELL",
              "Country": "text",
              "Number": "text"
            }
          ],
          "IsPrimary": true
        }
      ],
      "LinkedAccounts": [
        {
          "Id": "text",
          "Reason": "text",
          "Date": "2026-07-16T11:28:47.139Z"
        }
      ],
      "PartnerValues": {
        "Value1": "vip",
        "Value2": "north-america",
        "Value3": "tennis"
      },
      "AccountManager": "account.manager@example.com",
      "DateCreated": "2026-01-19T23:51:01-08:00",
      "DateLastUpdated": "2026-01-19T23:51:01-08:00",
      "CreatedBy": "admin@acme.com",
      "LastUpdatedBy": "admin@acme.com",
      "Uri": "/Advertisers/<AccountSID>/MediaPartners/2552842"
    }
  ]
}

Create a partner

post

Creates a new direct partner account and joins them to your program. Note that passwords must be at least 8 characters with one digit and one symbol.

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Body

AccountNamestringRequired

The display name for the partner's account.

Example: Wile E. Coyote Facebook

Websitestring · uriRequired

The partner's website URL.

Example: https://www.example-partner.com

AddressLine1stringRequired

Address line 1.

Example: 123 Main St

CitystringRequired

City for the partner's address.

Example: Santa Barbara

PostalCodestringRequired

ZIP or postal code.

Example: 93101

CountrystringRequired

Two-letter ISO 3166-1 alpha-2 country code. Possible values: US, UK, CANADA, AUSTRALIA, GERMANY, FRANCE, AFGHANISTAN, ALAND ISLANDS, ALBANIA, ALGERIA, AMERICANSAMOA, ANDORRA, ANGOLA, ANGUILLA, ANTARCTICA, ANTIGUABARBUDA, ARGENTINA, ARMENIA, ARUBA, AUSTRIA, AZERBAIJAN, BAHAMAS, BAHRAIN, BANGLADESH, BARBADOS, BELARUS, BELGIUM, BELIZE, BENIN, BERMUDA, BHUTAN, BOLIVIA, BOSNIAHERZEGOVINA, BOTSWANA, BRAZIL, BRITISHINDIANOCEANTERRITORY, BRUNEIDARUSSALAM, BULGARIA, BURKINAFASO, BURUNDI, CAMBODIA, CAMEROON, CAPVERDE, CAYMANISLANDS, CENTRALAFRICANREPUBLIC, CHAD, CHILE, CHINA, CHRISTMASISLAND, COCOSISLANDS, COLOMBIA, COMOROS, CONGO, DEMOCRATICREPUBLICCONGO, COOKISLANDS, COSTARICA, IVORYCOAST, CROATIA, CUBA, CYPRUS, CZECHREPUBLIC, DENMARK, DIJIBOUTI, DOMINICA, DOMINICANREPUBLIC, ECUADOR, EGYPT, ELSALVADOR, EQUATORIALGUINEA, ERITREA, ESTONIA, ETHIOPIA, FALKLANDISLANDS, FAROEISLANDS, FIJI, FINLAND, FRENCHGUIANA, FRENCHPOLYNESIA, FRENCHSOUTHERNTERRITORIES, GABON, GAMBIA, GEORGIA, GHANA, GIBRALTAR, GREECE, GREENLAND, GRENADA, GUADELOUPE, GUAM, GUATEMALA, GUERNSEY, GUINEA, GUINEABISSAU, GUYANA, HAITI, VATICAN, HONDURAS, HONGKONG, HUNGARY, ICELAND, INDIA, INDONESIA, IRAN, IRAQ, IRELAND, ISLE OF MAN, ISRAEL, ITALY, JAMAICA, JAPAN, JERSEY, JORDAN, KAZAKHSTAN, KENYA, KIRIBATI, SOUTHKOREA, KUWAIT, KYRGYZSTAN, LAOS, LATVIA, LEBANON, LESOTHO, LIBERIA, LIBYA, LICHTENSTEIN, LITHUANIA, LUXEMBOURG, MACAO, MACEDONIA, MADAGASCAR, MALAWI, MALAYSIA, MALDIVES, MALI, MALTA, MARSHALLISLANDS, MARTINIQUE, MAURITANIA, MAURITIUS, MAYOTTE, MEXICO, MICRONESIA, MOLDOVA, MONACO, MONGOLIA, MONTENEGRO, MONTSERRAT, MOROCCO, MOZAMBIQUE, MYANMAR, NAMIBIA, NAURU, NEPAL, NETHERLANDS, NETHERLANDSANTILLES, NEWCALEDONIA, NEWZEALAND, NICARAGUA, NIGER, NIGERIA, NIUE, NORFOLKISLAND, NORTHKOREA, NORTHERNMARIANAISLANDS, NORWAY, OMAN, PAKISTAN, PALAU, PALESTINIANTERRITORY, PANAMA, PAPUANEWGUINEA, PARAGUAY, PERU, PHILIPPINES, PITCAIRN, POLAND, PORTUGAL, PUERTORICO, QATAR, REUNION, ROMANIA, RUSSIA, RWANDA, SAINTHELENA, SAINTKITTSNEVIS, SAINTLUCIA, SAINTPIERREMIQUELON, SAINTVINCENTGRENADINES, SAMOA, SANMARINO, SAOTOME, SAUDIARABIA, SENEGAL, SERBIA, YUGOSLAVIA, SEYCHELLES, SIERRALEONE, SINGAPORE, SLOVAKIA, SLOVENIA, SOLOMONISLANDS, SOMALIA, SOUTHAFRICA, SPAIN, SRILANKA, SUDAN, SURINAME, SVALBARDJANMAYEN, SWAZILAND, SWEDEN, SWITZERLAND, SYRIA, TAIWAN, TAJIKISTAN, TANZANIA, THAILAND, TIMOR, TOGO, TOKELAU, TONGA, TRINIDADTOBAGO, TUNISIA, TURKEY, TURKMENISTAN, TURKSCAICOSISLANDS, TUVALU, UGANDA, UKRAINE, UAE, UNITED STATES MINOR OUTLYING ISLANDS, URUGUAY, UZBEKISTAN, VANUATU, VENEZUELA, VIETNAM, BRITISHVIRGINISLANDS, USVIRGINISLANDS, WALLISFUTUNA, WESTERNSAHARA, YEMEN, ZAMBIA, ZIMBABWE.

Example: US

PhoneCountrystringRequired

Two-letter ISO 3166-1 alpha-2 country code for the phone number.

Example: US

PhoneNumberstringRequired

The partner's contact phone number.

Example: 8051234567

PrimaryPromotionalMethodstring · enumRequired

The partner's primary method of promoting.

Possible values:

UsernamestringRequired

The username for the partner's primary user account.

Example: wile.coyote

FirstNamestringRequired

First name of the primary contact.

Example: Wile

LastNamestringRequired

Last name of the primary contact.

Example: Coyote

Passwordstring · passwordRequired

Password for the primary user account. Must be at least 8 characters with one digit and one symbol.

EmailAddressstring · emailRequired

Email address of the primary contact.

Example: wile.coyote@example.com

TemplateTermsIdintegerRequired

The unique ID of the contract template to assign to this partner.

Example: 99999

OrganizationTypestringOptional

Organization type for the partner.

Example: CORP

CountryStatestringOptional

State or region within the country.

CurrencystringRequired

Three-letter ISO 4217 currency code.

TimezonestringOptional

The partner's timezone.

DescriptionstringOptional

A description of the partner.

Responses

200

The partner account was created successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Uristring · uri-referenceOptional

The unique reference to the affected partner.

post/Advertisers/{AccountSID}/MediaPartners

POST /Advertisers/{AccountSID}/MediaPartners HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 511

"AccountName='Wile E. Coyote Facebook'&Website='https://www.example-partner.com'&AddressLine1='123 Main St'&City='Santa Barbara'&PostalCode='93101'&Country='US'&PhoneCountry='US'&PhoneNumber='8051234567'&PrimaryPromotionalMethod='EMAIL'&Username='wile.coyote'&FirstName='Wile'&LastName='Coyote'&Password='password'&EmailAddress='wile.coyote@example.com'&TemplateTermsId=99999&OrganizationType='CORP'&CountryState='text'&Currency='text'&Timezone='text'&Description='text'"

200

The partner account was created successfully.

{
  "Status": "text",
  "Uri": "../folder"
}

Retrieve a partner

get

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

PartnerIdintegerRequired

The unique identifier for the partner.

Responses

200

A single partner object.

application/json

IdstringOptional

The unique identifier for the partner.

Example: 2552842

NamestringOptional

The display name of the partner.

Example: Wile E. Coyote Facebook

DescriptionstringOptional

A description of the partner.

Example: Affiliate website partner.

Websitestring · uriOptional

The partner's website URL.

Example: https://www.example-partner.com

StatestringOptional

The current state of the partner's account.

Example: ACTIVE

CurrencystringOptional

Three-letter ISO 4217 currency code for the partner's payouts.

Example: USD

TimezonestringOptional

The timezone for the partner's account.

Example: America/Los_Angeles

PartnerTypestringOptional

Whether the partner is a direct or marketplace partner.

Example: PUBLISHER

PromotionalCountriesstring[]Optional

Country codes where the partner promotes.

Example: US

PromotionalCategoriesstring[]Optional

Categories the partner promotes in.

Example: Sports

AccountManagerstringOptional

The account manager assigned to this partner.

Example: account.manager@example.com

DateCreatedstring · date-timeOptional

The date and time the partner account was created.

Example: 2026-01-19T23:51:01-08:00

DateLastUpdatedstring · date-timeOptional

The date and time the partner account was last updated.

Example: 2026-01-19T23:51:01-08:00

CreatedBystringOptional

The user who created the partner account.

Example: admin@acme.com

LastUpdatedBystringOptional

The user who last updated the partner account.

Example: admin@acme.com

Uristring · uri-referenceOptional

The unique reference to this partner in the impact.com API.

Example: /Advertisers/<AccountSID>/MediaPartners/2552842

get/Advertisers/{AccountSID}/MediaPartners/{PartnerId}

GET /Advertisers/{AccountSID}/MediaPartners/{PartnerId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A single partner object.

{
  "Id": "2552842",
  "Name": "Wile E. Coyote Facebook",
  "Description": "Affiliate website partner.",
  "Website": "https://www.example-partner.com",
  "State": "ACTIVE",
  "Address": {
    "Country": "US",
    "Address1": "123 Main St",
    "City": "Santa Barbara",
    "State": "CA",
    "PostalCode": "93101"
  },
  "Phone": {
    "Country": "text",
    "Number": "text"
  },
  "Currency": "USD",
  "Timezone": "America/Los_Angeles",
  "IndirectTax": {
    "Country": "text",
    "Number": "text"
  },
  "PartnerType": "PUBLISHER",
  "PromotionalMethods": [
    {
      "Type": "text",
      "IsPrimary": true
    }
  ],
  "PromotionalCountries": [
    "US"
  ],
  "Properties": [
    {
      "Id": "2552842",
      "Name": "Wile E. Coyote Facebook",
      "Type": "SOCIAL",
      "Platform": "FACEBOOK",
      "Url": "https://www.facebook.com/example",
      "Doe": "2021-04-01T04:07:48-04:00",
      "Dlu": "2021-04-01T04:07:48-04:00"
    }
  ],
  "PromotionalCategories": [
    "Sports"
  ],
  "Programs": [
    {
      "Id": "text",
      "Name": "text",
      "ContractId": "text",
      "ContractName": "text",
      "JoinDate": "2026-07-16T11:28:47.139Z",
      "ExpirationDate": "2026-07-16T11:28:47.139Z",
      "Groups": [
        {
          "GroupId": "text",
          "GroupName": "text"
        }
      ]
    }
  ],
  "Contacts": [
    {
      "FirstName": "text",
      "LastName": "text",
      "Labels": [
        "text"
      ],
      "Email": "name@gmail.com",
      "Phones": [
        {
          "Type": "CELL",
          "Country": "text",
          "Number": "text"
        }
      ],
      "IsPrimary": true
    }
  ],
  "LinkedAccounts": [
    {
      "Id": "text",
      "Reason": "text",
      "Date": "2026-07-16T11:28:47.139Z"
    }
  ],
  "PartnerValues": {
    "Value1": "vip",
    "Value2": "north-america",
    "Value3": "tennis"
  },
  "AccountManager": "account.manager@example.com",
  "DateCreated": "2026-01-19T23:51:01-08:00",
  "DateLastUpdated": "2026-01-19T23:51:01-08:00",
  "CreatedBy": "admin@acme.com",
  "LastUpdatedBy": "admin@acme.com",
  "Uri": "/Advertisers/<AccountSID>/MediaPartners/2552842"
}

Update a partner

put

Updates specific partner tracking values (MPValue1, MPValue2, MPValue3).

Authorizations

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

PartnerIdintegerRequired

The unique identifier for the partner to update.

Body

MPValue1stringOptional

Custom tracking value 1.

Example: vip

MPValue2stringOptional

Custom tracking value 2.

Example: north-america

MPValue3stringOptional

Custom tracking value 3.

Example: tennis

Responses

200

The partner was updated successfully.

application/json

StatusstringOptional

Indicates whether the operation was successful.

Uristring · uri-referenceOptional

The unique reference to the affected partner.

put/Advertisers/{AccountSID}/MediaPartners/{PartnerId}

PUT /Advertisers/{AccountSID}/MediaPartners/{PartnerId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 65

"MPValue1='vip'&MPValue2='north-america'&MPValue3='tennis'"

200

The partner was updated successfully.

{
  "Status": "text",
  "Uri": "../folder"
}

PreviousPartners NextModels

Last updated 1 month ago