API Reference
Start typing to search…

The account object

Attributes

CompanyName string

The name of the company.

PrimaryPromotionalMethod enum

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 enum

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.

Website string

The website listed for the partner.

PrimaryPhoneNumber string

Listed phone number to contact the partner.

PrimaryPhoneNumberCountry enum

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

SecondaryPhoneNumber string

Another listed phone number to contact the partner.

SecondaryPhoneNumberCountry enum

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

MinimumContactRating integer

The lowest rating you can assign to a Partner conversation.

Timezone string

Time zone of the partner's account, listed in the tz database format.

Currency currency

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

RegisteredForIndirectTax boolean

Whether the account is registered for indirect tax, such as VAT, GST, or HST.

IndirectTaxNumber string

Unique identifier used for VAT, GST, or HST registration.

OrganizationType enum

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

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

EinSsnForeignTaxId string

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.

CorporateAddress object

The primary address for the account.

View child attributes

AddressLine1 string

Address line 1 (address number, street name)

AddressLine2 string

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

City string

City, district, suburb, town, or village

State string

State or territory

PostalCode string

ZIP or postal code

Country enum

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

BillingAddress object

The billing address for the account.

View child attributes

AddressLine1 string

Address line 1 (address number, street name)

AddressLine2 string

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

City string

City, district, suburb, town, or village

State string

State or territory

PostalCode string

ZIP or postal code

Country enum

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

FinancialContact object

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.

TechnicalContact object

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.

CommercialContact object

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.

URI string

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

{
  "CompanyName": "ACME Inc",
  "PrimaryPromotionalMethod": "OTHER",
  "PromotionalMethods": "CASHBACK,OTHER",
  "Website": "",
  "PrimaryPhoneNumber": "123456789",
  "PrimaryPhoneNumberCountry": "AUSTRALIA",
  "SecondaryPhoneNumber": "",
  "SecondaryPhoneNumberCountry": "",
  "MinimumContactRating": "1",
  "Timezone": "(GMT -07:00) Mountain Standard Time",
  "Currency": "USD",
  "RegisteredForIndirectTax": "false",
  "IndirectTaxNumber": "",
  "OrganizationType": "SOLE_IND",
  "EinSsnForeignTaxId": "",
  "CorporateAddress": {
    "AddressLine1": "P Sherman",
    "AddressLine2": "42 Wallaby Way",
    "City": "Sydney",
    "State": "",
    "PostalCode": "7530",
    "Country": "AUSTRALIA"
  },
  "BillingAddress": {
    "AddressLine1": "P Sherman",
    "AddressLine2": "42 Wallaby Way",
    "City": "Sydney",
    "State": "",
    "PostalCode": "7530",
    "Country": "AUSTRALIA"
  },
  "FinancialContact": {
    "UserId": "",
    "Name": "",
    "Email": "",
    "WorkPhoneNumber": "",
    "WorkPhoneNumberCountry": "",
    "CellPhoneNumber": "",
    "CellPhoneNumberCountry": ""
  },
  "TechnicalContact": {
    "UserId": "",
    "Name": "",
    "Email": "",
    "WorkPhoneNumber": "",
    "WorkPhoneNumberCountry": "",
    "CellPhoneNumber": "",
    "CellPhoneNumberCountry": ""
  },
  "CommercialContact": {
    "UserId": "",
    "Name": "",
    "Email": "",
    "WorkPhoneNumber": "",
    "WorkPhoneNumberCountry": "",
    "CellPhoneNumber": "",
    "CellPhoneNumberCountry": ""
  },
  "Uri": "/Mediapartners/<AccountSID>/CompanyInformation"
}