API Reference

Update an account

Updates a company's information by setting the values of the parameters passed. Any parameters not provided will be left unchanged. For example, if you pass the CompanyName parameter, that parameter will become the company's name, leaving all other parameters unchanged. Changing your company name updates your marketplace listing with your new name, and will become the new name for the partner account.

🚧

Note

These parameters cannot be updated via API, but can be updated in the impact.com UI:

  • FinancialContact
  • TechnicalContact
  • CommercialContact

Parameters

BillingAddress optional

The billing address for the account.

View child attributes

BillingAddressLine1 string

Address line 1 (address number, street name)

BillingAddressLine2 string

Address line 2 (building, unit, suite, etc. number)

BillingAddressCity string

City, district, suburb, town, or village

BillingAddressState string

State or territory

BillingAddressPostalCode string

ZIP or postal code

BillingAddressCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

CommercialContact optional

A commercial or marketing contact for the account (e.g., CMO).

View child attributes

UserId string

Unique impact.com member account ID for the user.

Name string

The contact's full name.

Email string

The contact's email address.

WorkPhoneNumber string

The contact's work phone number.

WorkPhoneNumberCountry enum

Two-letter country code.See ISO 3166-1 alpha-2.

CellPhoneNumber string

The contact's cell phone number.

CellPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

CompanyName optional

The name used for the account, which is usually the legal name for the associated company.

ContentInterests optional

Add tags that describe your content and interests, to improve recommendations. Make sure the list is comma separated with no spaces.

CorporateAddress optional

The primary address for the account.

View child attributes

CorporateAddressLine1 string

Address line 1 (address number, street name)

CorporateAddressLine2 string

Address line 2 (building, unit, suite, etc. number)

CorporateAddressCity string

City, district, suburb, town, or village

CorporateAddressState string

State or territory

CorporateAddressPostalCode string

ZIP or postal code

CorporateAddressCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

DateOfBirth optional

Date of Birth in the ISO 8601 format, for example 2024-03-18T10:30:00+11:00.

Description optional

Tell brands about yourself or your company and your content.

Education optional

The highest education level you've attained.

View possible enum values
Possible enum values
Bachelors_DegreeEducation is Bachelor's Degree
PhDEducation is PhD
Masters_DegreeEducation is Master's Degree
High_SchoolEducation is High School
Some_high_schoolEducation is Some high school
Some_collegeEducation is Some college
OtherEducation is Other not listed in impact.com
NoneEducation is Preferred not to share

EinSsnForeignTaxId optional

Employer Identification Number for the account, or in some cases, the Social Security Number (SSN) of the company owner, or a Tax ID number for non-US companies.

Ethnicity optional

Your ethnicity information.

View possible enum values
Possible enum values
African_AmericanEthnicity is African American
American_IndianEthnicity is American Indian
AsianEthnicity is Asian
BlackEthnicity is Black
HispanicEthnicity is Hispanic
LatinoEthnicity is Latino
Middle_EasternEthnicity is Middle Eastern
MultiracialEthnicity is Multiracial
Native_HawaiianEthnicity is Native Hawaiian
Pacific_IslanderEthnicity is Pacific Islander
South_AsianEthnicity is South Asian
WhiteEthnicity is White
OtherEthnicity is not listed in impact.com
NoneEthnicity is Preferred not to share

FinancialContact optional

A financial contact for the account (e.g., CFO).

View child attributes

UserId string

Unique impact.com member account ID for the user.

Name string

The contact's full name.

Email string

The contact's email address.

WorkPhoneNumber string

Financial contact's work phone number.

WorkPhoneNumberCountry enum

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

CellPhoneNumber string

Financial contact's cellphone number.

CellPhoneNumberCountry enum<

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

Gender optional

Your gender information.

View possible enum values
Possible enum values
FemaleGender is Female
MaleGender is Male
TransgenderGender is Transgender
Non-binaryGender is Non-binary
GenderqueerGender is Genderqueer
NoneGender is Preferred not to share

HouseholdIncome optional

Information about your household income.

View possible enum values
Possible enum values
35K< $35,000
Over_35K$35,000 - $50,000
Over_50K$50,000 - $75,000
Over_75K$75,000 - $100,000
Over_100K$100,000+
NonePreferred not to share

Logo optional

Add your logo or profile photo.

MinimumContactRating optional

The lowest rating you can assign to a Partner conversation.

OrganizationType optional

Organization type for the account. Available options will vary depending on the country that the business is registered in.

View possible enum values
Possible enum values
NONP_GOVNon-Profit/Government, United States
CORPC Corporation, United States
SOLE_INDIndividual/Sole Proprietor, United States
LLC_LLP_LLSLimited Liability Company / Limited Liability Partnership / S Corporation, United States
TRUSTTrust company, United States
SOLE_TRDSole Trader, Non-US
PARTNERSPartnership, Non-US
LLCLimited Liability Company, Non-US
LLPLimited Liability Partnership, Non-US
COMPANYCompany, Non-US
GOVERNMENTGovernment, Non-US
OTHEROther classification, All countries

ParentalStatus optional

Add some details about your parental status.

View possible enum values
Possible enum values
MomParental Status is Mom
DadParental Status is Dad
GrandfatherParental Status is Grandfather
GrandmotherParental Status is Grandmother
OtherParental Status is Not Applicable
NoneParental Status is Preferred not to share

PrimaryPhoneNumber optional

Listed phone number to contact the partner.

PrimaryPhoneNumberCountry optional

Two-letter ISO 3166-1 alpha-2 country code of the partner's address.

Pronouns optional

Add your preferred pronouns.

View possible enum values
Possible enum values
he_himPronouns are he/him
she_herPronouns are she/her
they_themPronouns are they/them
ey_emPronouns are ey/em
ne_nemPronouns are ne/nem
ve_verPronouns are ve/ver
xe_xemPronouns are xe/xem
xie_xemPronouns are xie/xem
ze_zirPronouns are ze/zir
NonePreferred not to share

RelationshipStatus optional

Your relationship status.

View possible enum values
Possible enum values
MarriedRelationship Status is Married
Not_MarriedRelationship Status is Not Married
SeparatedRelationship Status is Separated
WidowedRelationship Status is Widowed
DivorcedRelationship Status is Divorced
NoneRelationship Status is Preferred not to share

SecondaryPhoneNumber optional

Another listed phone number to contact the partner.

SecondaryPhoneNumberCountry optional

Two-letter ISO 3166-1 alpha-2 country code of the partner's address.

ShippingAddress optional

Add your shipping address if you receive products as gifts or compensation from brands.

View possible object values
Possible enum values
AddressLine1Address line 1 (address number, street name)
AddressLine2Address line 2 (building, unit, suite, etc. number)
CityCity, district, suburb, town, or village
StateState or territory
PostalCodeZip or postal code
CountryTwo-letter country code. See ISO 3166-1 alpha-2

PrimaryPromotionalMethod optional

Partner's primary promotional method, specified by the partner.

View possible enum values
Possible enum values
EMAILPartner promotes via email.
SEARCHPartner promotes via search results.
LOYALTYPartner promotes via loyalty sub-affiliates.
COUPONPartner promotes via coupons and promo codes.
SYNDICATION_BLOG_NETWORKSPartner promotes via blogs, news sites, and other syndicated networks.
CPA_NETWORKPartner promotes via a cost-per-action network.
MOBILEPartner promotes via mobile apps and devices.
CONTENTPartner promotes via their own content.
SHOPPINGPartner promotes via shopping platforms and websites.
SOCIAL_MEDIA_INFLUENCERPartner promotes via social media as an influencer.
SERVICE_PROVIDERPartner promotes as a service provider of an affiliate network.
CONSUMER_SOFTWAREPartner promotes via consumer software.
INCENTIVIZEDPartner promotes as an incentivized affiliate.
OFFLINEPartner promotes via offline methods, like TV and radio.
OTHERPartner promotes via other methods not listed in impact.com.
CASHBACKPartner promotes as a cashback partner, offering a percentage of their payouts to customers.

PromotionalMethod optional

Partner's promotional method, specified by the partner.

View possible enum values
Possible enum values
EMAILPartner promotes via email.
SEARCHPartner promotes via search results.
LOYALTYPartner promotes via loyalty sub-affiliates.
COUPONPartner promotes via coupons and promo codes.
SYNDICATION_BLOG_NETWORKSPartner promotes via blogs, news sites, and other syndicated networks.
CPA_NETWORKPartner promotes via a cost-per-action network.
MOBILEPartner promotes via mobile apps and devices.
CONTENTPartner promotes via their own content.
SHOPPINGPartner promotes via shopping platforms and websites.
SOCIAL_MEDIA_INFLUENCERPartner promotes via social media as an influencer.
SERVICE_PROVIDERPartner promotes as a service provider of an affiliate network.
CONSUMER_SOFTWAREPartner promotes via consumer software.
INCENTIVIZEDPartner promotes as an incentivized affiliate.
OFFLINEPartner promotes via offline methods, like TV and radio.
OTHERPartner promotes via other methods not listed in impact.com.
CASHBACKPartner promotes as a cashback partner, offering a percentage of their payouts to customers.

TechnicalContact optional

A technical contact for the account (e.g., CTO).

View child attributes

UserId string

Unique impact.com member account ID for the user.

Name string

The contact's full name.

Email string

The contact's email address.

WorkPhoneNumber string

The contact's work phone number.

WorkPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

CellPhoneNumber string

The contact's cell phone number.

CellPhoneNumberCountry enum

Two-letter country code. See ISO 3166-1 alpha-2.

Website optional

The website listed for the partner.

Example request

curl 'https://api.impact.com/Mediapartners/<AccountSID>/CompanyInformation' \
  -X PUT \
  -u '<AccountSID>:<AuthToken>' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -d 'CompanyName=Acme Corporation' \
  -d 'Website=https://example.com' \
  -d 'PrimaryPhoneNumber=123456789' \
  -d 'PrimaryPhoneNumberCountry=US' \
  -d 'SecondaryPhoneNumber=012345678' \
  -d 'OrganizationType=CORP' \
  -d 'EinSsnForeginTaxId=123456789' \
  -d 'CorporateAddressLine1=42 Wallaby Way' \
  -d 'CorporateAddressCity=Sydney' \
  -d 'BillingAddressLine1=742 Evergreen Terrace' \
  -d 'BillingAddressCity=Springfield'

Example response

{
  "Status": "OK",
  "Uri": "/Mediapartners/<AccountSID>/CompanyInformation/"
}