Ctrlk
Help CenterContact Support

Partners

List All Partners

get

Returns a list of all your partners, sorted by creation date. The list can be filtered by various parameters such as Campaign, Group, Country, and State.

Path parameters
AccountSIDstringRequired
Query parameters
IdstringOptional

Filter by one or more specific partner IDs, provided as a comma-separated list.

CampaignIdintegerOptional

Filter to list only partners joined to the specified campaign (program).

GroupIdintegerOptional

Filter to list only partners that are part of a specific partner group.

CountrystringOptional

Filter to list only partners from a specific country. 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 partners whose DateLastUpdated occurs after this date (ISO 8601).

endDatestring · date-timeOptional

Filter by partners whose DateLastUpdated occurs before this date (ISO 8601).

Statestring · enumOptional

Filter by the state of the partner account.

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 paginated list of partner objects.

application/json
get
/Advertisers/{AccountSID}/MediaPartners
200

A paginated list of partner objects.

Create a Direct Partner

post

Creates a new direct partner account, which automatically joins your program with a specified active contract.

Path parameters
AccountSIDstringRequired
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.

EmailAddressstring · emailRequired

Email address of the primary contact.

Example: [email protected]
TemplateTermsIdintegerRequired

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

Example: 99999
CurrencystringRequired

3-letter ISO 4217 currency code.

TaxIdstringOptional

Tax identification number for the partner.

OrganizationTypestring · enumOptional

Organization type for the partner.

Example: CORPPossible values:
AddressLine2stringOptional

Address line 2.

CountryStatestringOptional

State or region within the country.

TimezonestringOptional

The partner's timezone.

PromotingCountriesstringOptional

Comma-separated list of 2-letter ISO 3166-1 alpha 2 country codes.

DescriptionstringOptional

A description of the partner.

MPGroupIDsstringOptional

Comma-separated list of partner group IDs to add the partner to.

MPValue1stringOptional

Custom tracking value 1.

MPValue2stringOptional

Custom tracking value 2.

MPValue3stringOptional

Custom tracking value 3.

Responses
200

The partner account was created successfully.

application/json
StatusstringOptional

Indicates whether the operation was successful.

Example: OK
Uristring · uri-referenceOptional

The unique reference to the affected partner.

post
/Advertisers/{AccountSID}/MediaPartners
200

The partner account was created successfully.

Get Partner Details

get

Retrieves the details of an existing partner by their unique ID.

Path parameters
AccountSIDstringRequired
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
Statestring · enumOptional

The current state of the partner's account.

Possible values:
CurrencystringOptional

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

Example: USD
TimezonestringOptional

The partner's timezone.

Example: America/Los_Angeles
PartnerTypestring · enumOptional

Whether the partner is a direct or marketplace partner.

Possible values:
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.

DateCreatedstring · date-timeOptional

The date and time the partner account was created.

DateLastUpdatedstring · date-timeOptional

The date and time the partner account was last updated.

CreatedBystringOptional

The user who created the partner account.

LastUpdatedBystringOptional

The user who last updated the partner account.

Uristring · uri-referenceOptional

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

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

A single partner object.

Update Partner Values

put

Updates the custom MPValue{i} fields for a specified partner. These values can be used in tracking links.

Path parameters
AccountSIDstringRequired
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.

Example: OK
Uristring · uri-referenceOptional

The unique reference to the affected partner.

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

The partner was updated successfully.

PreviousPartnersNextModels

Last updated