The partner object

The partners object holds information about a partner account in your program. You can create, retrieve, and update a partner, as well as list all partners, which can include active, inactive, and expired partners.

Attributes

`Id` string

A unique identifier for the partner's impact.com account.

`Name` string

The partner's name.

`Description` string

The partner's provided description of their platform or business.

`Website` string

The partner's website.

`State` enum

The current state of the partner's account.

Possible enum values
`ACTIVE`	The partner is active on impact.com.
`EXPIRED`	The partner account has expired.
`PENDING`	The partner is pending approval from impact.com.
`DECLINED`	The partner is declined from impact.com.
`SUSPENDED`	The partner is suspended from impact.com.
`DEACTIVATED`	The partner has been deactivated from impact.com.
`CLOSING`	The partner is closing their impact.com account.
`CLOSED`	The partner has closed their impact.com account.
`NOT_APPLICABLE`	The state of the partner account isn't applicable.

`Address` object

An object that contains attributes describing the partner's physical address.

Show child attributes

Address.Country string

The country enum value of where the partner's address is in.

View possible country values

Possible enum values
`US`
`UK`
`CANADA`
`AUSTRALIA`
`GERMANY`
`FRANCE`
`AFGHANISTAN`
`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`
`ISRAEL`
`ITALY`
`JAMAICA`
`JAPAN`
`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`
`YOGOSLAVIA`
`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`
`URUGUAY`
`UZBEKISTAN`
`VANUATU`
`VENEZUELA`
`VIETNAM`
`BRITISHVIRGINISLANDS`
`USVIRGINISLANDS`
`WALLISFUTUNA`
`WESTERNSAHARA`
`YEMEN`
`ZAMBIA`
`ZIMBABWE`

Address.Address1 string

The first line of the partner's address.

Address.Address2 string

The second line of the partner's address.

Address.City string

The city in the partner's address.

Address.State string

Name of the state, city state, or country (for non-US) in the partner's address.

Address.PostalCode string

Postal or ZIP code in the partner's address.

`Phone` object

An object that contains attributes that describe the partner's telephone contact information.

Show child attributes

Phone.Country string

The country enum value of the partner's phone number.

View possible country values

Possible enum values
`US`
`UK`
`CANADA`
`AUSTRALIA`
`GERMANY`
`FRANCE`
`AFGHANISTAN`
`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`
`ISRAEL`
`ITALY`
`JAMAICA`
`JAPAN`
`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`
`YOGOSLAVIA`
`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`
`URUGUAY`
`UZBEKISTAN`
`VANUATU`
`VENEZUELA`
`VIETNAM`
`BRITISHVIRGINISLANDS`
`USVIRGINISLANDS`
`WALLISFUTUNA`
`WESTERNSAHARA`
`YEMEN`
`ZAMBIA`
`ZIMBABWE`

Phone.Number string

The partner's telephone number.

`Currency` currency

The three-letter ISO 4217 currency code attributed to the partner's selected default currency.

`Timezone` enum

The tz database time zone attributed ot the partner's selected default timezone.

`IndirectTax` object

An object that contains attributes that describe the partner's indirect tax information.

Show child attributes

IndirectTax.Country string

The country enum value of where the partner is registered for indirect tax.

View possible country values

Possible enum values
`US`
`UK`
`CANADA`
`AUSTRALIA`
`GERMANY`
`FRANCE`
`AFGHANISTAN`
`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`
`ISRAEL`
`ITALY`
`JAMAICA`
`JAPAN`
`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`
`YOGOSLAVIA`
`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`
`URUGUAY`
`UZBEKISTAN`
`VANUATU`
`VENEZUELA`
`VIETNAM`
`BRITISHVIRGINISLANDS`
`USVIRGINISLANDS`
`WALLISFUTUNA`
`WESTERNSAHARA`
`YEMEN`
`ZAMBIA`
`ZIMBABWE`

IndirectTax.Number string

The partner's indirect tax number.

`PartnerType` enum

The type of the partner, which is established by how they join your program.

Possible enum values
`DIRECT`	Partner joined your program directly.
`MARKETPLACE`	Partner joined your program via the impact.com Marketplace.

`PromotionalMethods` array of objects

The methods that this partner uses to promote.

Show child attributes

PromotionalMethods.Type enum

The promotional method type.

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.

PromotionalMethods.IsPrimary boolean

Establishes whether a promotional method is considered the primary method (true) or not (false).

`PromotionalCountries` array of enums

A comma-separated list of country enum values of where the partner promotes.

View possible country values

Possible enum values
`US`
`UK`
`CANADA`
`AUSTRALIA`
`GERMANY`
`FRANCE`
`AFGHANISTAN`
`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`
`ISRAEL`
`ITALY`
`JAMAICA`
`JAPAN`
`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`
`YOGOSLAVIA`
`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`
`URUGUAY`
`UZBEKISTAN`
`VANUATU`
`VENEZUELA`
`VIETNAM`
`BRITISHVIRGINISLANDS`
`USVIRGINISLANDS`
`WALLISFUTUNA`
`WESTERNSAHARA`
`YEMEN`
`ZAMBIA`
`ZIMBABWE`

`Properties` array of objects

An object that contains attributes that describe the partner's promotional properties.

Show child attributes

Properties.Id string

A unique identifier for the promotional property, within the context of this partner's account.

Properties.Name string

The name of the partner's promotional property, as provided by the partner themselves.

Properties.Type enum

The type of the partner's promotional property, as selected by the partner themselves.

Possible enum values
`WEBSITE`	Indicates the media property is a website.
`MOBILE`	Indicates the media property is a mobile app.
`SOCIAL`	Indicates the media property is a social media profile.

Properties.Platform enum

Depending on the selected Type, this describes the platform of the partner's promotional property (when available).

Possible enum values (Social)
`FACEBOOK`	Indicates the promotional property type is a profile or group on Facebook.
`TWITTER`	Indicates the promotional property type is a Twitter account.
`INSTAGRAM`	Indicates the promotional property type is a personal or business profile on Instagram.
`PINTEREST`	Indicates the promotional property type is a Pinterest account.
`LINKEDIN`	Indicates the promotional property type is a profile on LinkedIn.
`YOUTUBE`	Indicates the promotional property type is a YouTube channel.
`TIKTOK`	Indicates the promotional property type is a TikTok profile.
`TWITCH`	Indicates the promotional property type is a Twitch channel.
`WECHAT`	Indicates the promotional property type is a WeChat account.
`WEIBO`	Indicates the promotional property is a microblog on a Weibo service in China.

Possible enum values (Mobile)
`IOS`	An iOS mobile app.
`Android`	An Android mobile app.

Properties.Url string

The URL to the partner's promotional promotional property.

Properties.Doe string

D.O.E (Date Of Entry) — the ISO 8416 format of the date and time the partner added the promotional property.

Properties.Dlu string

D.L.U (Date Last Updated) — the ISO 8416 format of the date and time the partner last updated the promotional property.

`PromotionalCategories` array

A list of promotional categories impact.com applies to a partner based on brands they've partnered with in the past.

`Programs` array of objects

An array of objects describing the program(s) the partner has joined and promoting.

Show child attributes

Programs.Id string

The unique identifier for the program the partner has joined.

Programs.Name string

The name of the program the partner has joined.

Programs.ContractId string

The unique identifier for the contract the partner has signed as a part of joining the program.

Programs.ContractName string

The name of the contract the partner has signed as a part of joining the program.

Programs.JoinDate string

The date and time (in ISO 8416 format) when the partner signed the contract, joining the program.

Programs.ExpirationDate string

The date and time (in ISO 8416 format) when the partner's contract will expire, if explicitly set.

Programs.Groups array of objects

An array of objects describing the partner groups this partner belongs to

Show child attributes

Programs.Groups.GroupId string

The unique identifier for the group the partner is a member of.

Programs.Groups.GroupName string

The name of the group the partner is a member of.

`Contacts` array of objects

An array of objects that contain attributes that describe the partner's contact information.

Show child attributes

Contacts.FirstName string

The provided first name of the partner's contact.

Contacts.LastName string

The provided first name of the partner's contact.

Contacts.Labels string

Any internal labels applied to the partner's contact.

Contacts.Phones array of objects

An array of objects that describe the telephone information for a partner's contact.

Show child attributes

Contacts.Phones.Type enum

The type of telephone: CELL or WORK.

Contacts.Phones.Country string

The two-letter ISO 3166 alpha-2 country code for the provided telephone number.

Contacts.Phones.Number string

The provided telephone number.

Contacts.IsPrimary boolean

Establishes whether a contacts object is considered the primary contact method (true) or not (false).

`LinkedAccounts` array of objects

An array of objects that contain attributes that describe any linked impact.com accounts.

Show child attributes

LinkedAccounts.Id string

The unique identifier for the impact.com account that is linked.

LinkedAccounts.Reason string

The provided reason for why the account was linked.

LinkedAccounts.Date string

The date and time (in ISO 8416 format) when the account was linked.

`PartnerValues` object

An object that contains attributes describing the partner's assigned values. See Query string parameters for tracking templates to learn more — these are the {mp_value} parameters.

Show child attributes

PartnerValues.Value1 string

A custom value assigned to the partner used for tracking.

PartnerValues.Value2 string

A custom value assigned to the partner used for tracking.

PartnerValues.Value3 string

A custom value assigned to the partner used for tracking.

`AccountManager` string

The name of the user in your brand account that is assigned to manage this partner.

`DateCreated` datetime

The date and time (in ISO 8416 format) when the account was created.

`DateLastUpdated` datetime

The date and time (in ISO 8416 format) when the account was last updated.

`CreatedBy` string

The username of the impact.com user who created the partner account.

`LastUpdatedBy` string

The username of the impact.com user who last updated the partner account.

`Uri`

Unique resource identifier for the specific partner in the impact.com API.

Example object

{
  "Id": "10000",
  "Name": "Wile E. Coyote Partner",
  "Description": "Wile E. Coyote is the top influencer for Acme products! ",
  "Website": "example.com",
  "State": "ACTIVE",
  "Address": {
    "Country": "US",
    "Address1": "1640 Riverside Dr.",
    "Address2": "",
    "City": "Hill Valley",
    "State": "CA",
    "PostalCode": "90210"
  },
  "Phone": {
    "Country": "US",
    "Number": "18055550100"
  },
  "Currency": "USD",
  "Timezone": "America/Los_Angeles",
  "IndirectTax": {
    "Country": "",
    "Number": ""
  },
  "PartnerType": "MARKETPLACE",
  "PromotionalMethods": [
    {
      "Type": "COUPON",
      "IsPrimary": false
    },
    {
      "Type": "OFFLINE",
      "IsPrimary": false
    },
    {
      "Type": "SEARCH",
      "IsPrimary": false
    },
    {
      "Type": "SHOPPING",
      "IsPrimary": true
    }
  ],
  "PromotionalCountries": [
    "SOUTHAFRICA",
    "GERMANY",
    "JAPAN",
    "US",
    "SPAIN"
  ],
  "Properties": [
    {
      "Id": "271",
      "Name": "example.com",
      "Type": "WEBSITE",
      "Platform": "",
      "Url": "https://www.example.com",
      "Doe": "2010-05-24T13:58:57-04:00",
      "Dlu": "2020-03-05T11:57:20-05:00"
    },
    {
      "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": [
    "Auctions",
    "Handmade Goods",
    "Creative Digital Assets",
    "Flowers",
    "Gifts & Stationery",
    "Gourmet",
    "Wine & Spirits",
    "Food & Drink"
  ],
  "Programs": [
    {
      "Id": "1000",
      "Name": "Acme Brands",
      "ContractId": "12345",
      "ContractName": "Acme Public Terms ",
      "JoinDate": "2019-06-19T08:41:09-04:00",
      "Groups": [
        {
          "GroupId": "98765",
          "GroupName": "Influencers"
        }
      ]
    }
  ],
  "Contacts": [
    {
      "FirstName": "Wile",
      "LastName": "Coyote",
      "Labels": [],
      "Email": "[email protected]",
      "Phones": [
        {
          "Type": "CELL",
          "Country": "US",
          "Number": "18055550100"
        }
      ],
      "IsPrimary": true
    },
  ],
  "LinkedAccounts": [
    {
      "Id": "10001",
      "Reason": "Road Runner Partners",
      "Date": "2021-04-01T04:30:17-04:00"
    },
  ],
  "PartnerValues": {
    "Value1": "OFFLINE",
    "Value2": "",
    "Value3": ""
  },
  "AccountManager": "",
  "DateCreated": "2009-10-14T10:43:37-04:00",
  "DateLastUpdated": "2021-04-01T08:32:13-04:00",
  "CreatedBy": "unknown_user",
  "LastUpdatedBy": "Wile E. Coyote",
  "Uri": "/Advertisers/<AccountSID>/MediaPartners/10000.json"
}

Attributes

Id string

Name string

Description string

Website string

State enum

Address object

Address.Country string

Address.Address1 string

Address.Address2 string

Address.City string

Address.State string

Address.PostalCode string

Phone object

Phone.Country string

Phone.Number string

Currency currency

Timezone enum

IndirectTax object

IndirectTax.Country string

IndirectTax.Number string

PartnerType enum

PromotionalMethods array of objects

PromotionalMethods.Type enum

PromotionalMethods.IsPrimary boolean

PromotionalCountries array of enums

Properties array of objects

Properties.Id string

Properties.Name string

Properties.Type enum

Properties.Platform enum

Properties.Url string

Properties.Doe string

Properties.Dlu string

PromotionalCategories array

Programs array of objects

Programs.Id string

Programs.Name string

Programs.ContractId string

Programs.ContractName string

Programs.JoinDate string

Programs.ExpirationDate string

Programs.Groups array of objects

Programs.Groups.GroupId string

Programs.Groups.GroupName string

Contacts array of objects

Contacts.FirstName string

Contacts.LastName string

Contacts.Labels string

Contacts.Phones array of objects

Contacts.Phones.Type enum

Contacts.Phones.Country string

Contacts.Phones.Number string

Contacts.IsPrimary boolean

LinkedAccounts array of objects

LinkedAccounts.Id string

LinkedAccounts.Reason string

LinkedAccounts.Date string

PartnerValues object

PartnerValues.Value1 string

PartnerValues.Value2 string

PartnerValues.Value3 string

AccountManager string

DateCreated datetime

DateLastUpdated datetime

CreatedBy string

LastUpdatedBy string

Uri

Example object

`Id` string

`Name` string

`Description` string

`Website` string

`State` enum

`Address` object

`Phone` object

`Currency` currency

`Timezone` enum

`IndirectTax` object

`PartnerType` enum

`PromotionalMethods` array of objects

`PromotionalCountries` array of enums

`Properties` array of objects

`PromotionalCategories` array

`Programs` array of objects

`Contacts` array of objects

`LinkedAccounts` array of objects

`PartnerValues` object

`AccountManager` string

`DateCreated` datetime

`DateLastUpdated` datetime

`CreatedBy` string

`LastUpdatedBy` string

`Uri`