Create a partner

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

Parameters

`AccountName` required

The name for the partner account that will appear in the platform and API. Different from the Username, which is what the partner will use to sign in to impact.com.

`Website` required

A URL to the partner's website.

`AddressLine1` required

The first address line is for the partner's physical address — usually an address number and street name combination.

`City` required

The city that the partner's address is in.

`PostalCode` required

The postal or ZIP code of the partner's address.

`Country` required

The country of the partner's address.

View possible country values

Possible enum 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`
`ELSALVADOR`
`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`

`PhoneCountry` required

The country of the partner's phone number.

`PromotionalMethods` required

A comma-separated list of the promotional methods for the partner. Minimum of 1 required.

Possible enum values
`CONTENT_REVIEWS`	Partners focused on producing editorial content related to promoting, comparing, and listing products or services.
`DEAL_COUPON`	Partners who aggregate or classify deals and promotions for consumer savings.
`LOYALTY_REWARDS`	Partners who incentivize transactions from consumers, employees, or businesses through a membership or benefits reward program.
`SOCIAL_INFLUENCER`	Individuals who market products and services to their own audience on social media platforms.
`NETWORK`	Partner platforms that arrange access to brand programs and provide tracking, reporting, and payment services.
`COMMERCE_SOLUTION`	E-commerce shopping tools or services that drive conversion optimization for brands.
`MEDIA_ARBITRAGE`	Search Engine, Social, or Programmatic marketers that manage keyword campaigns for brands, often on a performance basis.
`CROSS_AUDIENCE`	Businesses that publish offers, content, or complementary products to current customers or audiences (e.g., exit traffic, improved UX) to drive incremental revenue.

`Username` required

A username that the partner will use to sign in to impact.com.

`FirstName` required

The first name of the person who will use this partner account.

`LastName` required

The last name (or surname) of the person who will use this partner account.

`Password` required

A case-sensitive password that the partner will use to sign in to impact.com.

Minimum of eight (8) characters
Must have at least one (1) digit (e.g., 0-9)
Must have at least one (1) symbol. (e.g., !,@,#, etc.).

Remind the partner to change their password immediately after signing in for the first time.

`EmailAddress` required

The email address of the person who will use this partner account.

`InsertionOrderId` required

Also known as the TemplateId, this is the unique identifier of the contract that the partner will be joined with. This value can be found in the Contracts endpoint, or on the Insertion Order Name line of the PDF document of the terms. In the platform, go to:

[Contracts → Template Terms → Actions
→ View Terms -> Actions
→ Download PDF].

`TaxId` conditionally required

The indirect tax number associated with the individual or business that will use this partner account. This value is required if the Country value is AUSTRALIA, but optional otherwise.

`OrganizationType` conditionally required

The type of organization what will use this partner account. Available options will vary depending on the country that the business is registered.

Required if the Country value is US, Canada, or CHINA
Required if the Country value is UK, IRELAND, or AUSTRALIA and a TaxId value is supplied
Optional otherwise

Possible enum values
`NONP_GOV`	Non-Profit/Government, United States
`CORP`	C Corporation, United States
`SOLE_IND`	Individual/Sole Proprietor, United States
`LLC_LLP_LLS`	Limited Liability Company / Limited Liability Partnership / S Corporation, United States
`TRUST`	Trust company, United States
`SOLE_TRD`	Sole Trader, Non-US
`PARTNERS`	Partnership, Non-US
`LLC`	Limited Liability Company, Non-US
`LLP`	Limited Liability Partnership, Non-US
`COMPANY`	Company, Non-US
`GOVERNMENT`	Government, Non-US
`OTHER`	Other classification, All countries

`AddressLine2` optional

Additional address line (e.g., apartment, suite, building number) for the address of the person who will use this account.

`CountryState` optional

For US addresses, the state in the address of the person who will use this partner account.

`Currency` optional

The three-letter ISO 4217 currency code of the partner's default currency.

`Timezone` optional

The time zone of the partner's account in the tz database format.

`PrimaryPromotionalMethod` optional

Primary promotional method that the partner uses.

Possible enum values
`EMAIL`	Partner promotes via email.
`SEARCH`	Partner promotes via search results.
`LOYALTY`	Partner promotes via loyalty sub-affiliates.
`COUPON`	Partner promotes via coupons and promo codes.
`SYNDICATION_BLOG_NETWORKS`	Partner promotes via blogs, news sites, and other syndicated networks.
`CPA_NETWORK`	Partner promotes via a cost-per-action network.
`MOBILE`	Partner promotes via mobile apps and devices.
`CONTENT`	Partner promotes via their own content.
`SHOPPING`	Partner promotes via shopping platforms and websites.
`SOCIAL_MEDIA_INFLUENCER`	Partner promotes via social media as an influencer.
`SERVICE_PROVIDER`	Partner promotes as a service provider of an affiliate network.
`CONSUMER_SOFTWARE`	Partner promotes via consumer software.
`INCENTIVIZED`	Partner promotes as an incentivized affiliate.
`OFFLINE`	Partner promotes via offline methods, like TV and radio.
`OTHER`	Partner promotes via other methods not listed in impact.com.
`CASHBACK`	Partner promotes as a cashback partner, offering a percentage of their payouts to customers.

`PromotingCountries` optional

Comma-separated list of countries in two-letter ISO 3166-1 alpha 2 format that the partner promotes in.

`Description` optional

A short description of the partner.

`MPGroupIds` optional

Comma-separated list of the unique identifier of the partner groups that this partner will be a part of.

`MPValue1`, `MPValue2`, `MPValue3` optional

A custom value assigned to partners that can be appended as a query string parameter to all landing pages, depending on how both the Partner Tracking Template and Campaign Tracking Template are configured in:

[Settings → Gateway Tracking Settings]

This value is applied at the account level, meaning it remains the same across all of your campaigns (or programs) for partners. Learn more about Gateway Tracking Settings.

Returns

A successful call will return the status of the request and the URI to the newly created partner object. An unsuccessful call will return an error if any parameters are invalid or missing.

Example request

curl 'https://api.impact.com/Advertisers/<AccountSID>/MediaPartners' \
  -X POST \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'AccountName=Coyote Influencer' \
  -d 'Website=https://www.example.com' \
  -d 'AddressLine1=1234 Elm Street' \
  -d 'City=Anytown' \
  -d 'PostalCode=87101' \
  -d 'Country=US' \
  -d 'PhoneCountry=US' \
  -d 'PhoneNumber=12065550100' \
  -d 'PromotionalMethods=SOCIAL_MEDIA_INFLUENCER,CONTENT' \
  -d 'Username=Acme Coyote Influencer' \
  -d 'FirstName=Wile' \
  -d 'LastName=Coyote' \
  -d 'Password=TnTg0ezBang!' \
  -d '[email protected]' \
  -d 'InsertionOrderId=12345' \
  -d 'OrganizationType=SOLE_IND'

Example response

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/MediaPartners/123456"
}

Parameters

AccountName required

Website required

AddressLine1 required

City required

PostalCode required

Country required

PhoneCountry required

PromotionalMethods required

Username required

FirstName required

LastName required

Password required

EmailAddress required

InsertionOrderId required

TaxId conditionally required

OrganizationType conditionally required

AddressLine2 optional

CountryState optional

Currency optional

Timezone optional

PrimaryPromotionalMethod optional

PromotingCountries optional

Description optional

MPGroupIds optional

MPValue1, MPValue2, MPValue3 optional