Company Information

Get Company Information

get

Retrieves the details of this account. The account is determined by the API keys you use.

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Responses

200

An account object.

application/json

CompanyNamestringOptional

Brand name for the account; usually the legal name of the company.

Example: Acme Corporation

Websitestring · uriOptional

Official website URL for the brand or company.

Example: https://www.example.com

PrimaryPhoneNumberstringOptional

Primary domestic contact number for the account.

Example: 1235550100

PrimaryPhoneNumberCountrystringOptional

Two-letter ISO 3166-1 alpha-2 country code representing the country of the primary phone number.

Example: US

TimezonestringOptional

Timezone used for the account.

Example: (GMT -08:00) Pacific Time (US & Canada); Tijuana

CurrencystringOptional

Three-letter ISO 4217 code representing the account's default currency.

Example: USD

RegisteredForIndirectTaxstringOptional

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

Example: true

IndirectTaxNumberstringOptional

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

Example: 123456789

OrganizationTypestring · enumOptional

Organization type for the account.

Example: CORPPossible values:

EinSsnForeignTaxIdstringOptional

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.

Example: 12-3456789

Uristring · uri-referenceOptional

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

Example: /Advertisers/<AccountSID>/CompanyInformation

SecondaryPhoneNumberstringOptional

A secondary domestic contact phone number for the account.

Example: 3215550100

SecondaryPhoneNumberCountrystringOptional

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

Example: US

MinimumContactRatingstringOptional

Minimum amount of star rating (1 lowest, 5 highest) a partner must have to see contact information for the account.

Example: 1

get/Advertisers/{AccountSID}/CompanyInformation

GET /Advertisers/{AccountSID}/CompanyInformation HTTP/1.1
Host: api.impact.com
Accept: */*

200

An account object.

{
  "CompanyName": "Acme Corporation",
  "Website": "https://www.example.com",
  "PrimaryPhoneNumber": "1235550100",
  "PrimaryPhoneNumberCountry": "US",
  "Timezone": "(GMT -08:00) Pacific Time (US & Canada); Tijuana",
  "Currency": "USD",
  "RegisteredForIndirectTax": "true",
  "IndirectTaxNumber": "123456789",
  "OrganizationType": "CORP",
  "EinSsnForeignTaxId": "12-3456789",
  "CorporateAddress": {
    "AddressLine1": "1640 Riverside Dr.",
    "AddressLine2": "Suite 400",
    "City": "Hill Valley",
    "State": "CALIFORNIA",
    "PostalCode": "90210",
    "Country": "US"
  },
  "BillingAddress": {
    "AddressLine1": "1640 Riverside Dr.",
    "AddressLine2": "Suite 400",
    "City": "Hill Valley",
    "State": "CALIFORNIA",
    "PostalCode": "90210",
    "Country": "US"
  },
  "FinancialContact": {
    "UserId": "1234567",
    "Name": "Road Runner",
    "Email": "finance@example.com",
    "WorkPhoneNumber": "2065550100",
    "WorkPhoneNumberCountry": "US",
    "CellPhoneNumber": "2065550133",
    "CellPhoneNumberCountry": "US"
  },
  "Uri": "/Advertisers/<AccountSID>/CompanyInformation",
  "Industry": {
    "IndustryId": "833",
    "IndustryName": "Miscellaneous Retail Stores, Not Elsewhere Classified"
  },
  "SecondaryPhoneNumber": "3215550100",
  "SecondaryPhoneNumberCountry": "US",
  "MinimumContactRating": "1",
  "TechnicalContact": {
    "UserId": "1234567",
    "Name": "Road Runner",
    "Email": "finance@example.com",
    "WorkPhoneNumber": "2065550100",
    "WorkPhoneNumberCountry": "US",
    "CellPhoneNumber": "2065550133",
    "CellPhoneNumberCountry": "US"
  },
  "SecurityContact": {
    "UserId": "1234567",
    "Name": "Road Runner",
    "Email": "finance@example.com",
    "WorkPhoneNumber": "2065550100",
    "WorkPhoneNumberCountry": "US",
    "CellPhoneNumber": "2065550133",
    "CellPhoneNumberCountry": "US"
  },
  "CommercialContact": {
    "UserId": "1234567",
    "Name": "Road Runner",
    "Email": "finance@example.com",
    "WorkPhoneNumber": "2065550100",
    "WorkPhoneNumberCountry": "US",
    "CellPhoneNumber": "2065550133",
    "CellPhoneNumberCountry": "US"
  }
}

Update Company Information

put

Updates this account by setting the values of the parameters passed. Any parameters not provided will be left unchanged.

Note: The following parameters cannot be updated via API: Timezone, Currency, RegisteredForIndirectTax, IndirectTaxNumber. The following parameters can only be updated in the platform: Industry, FinancialContact, TechnicalContact, SecurityContact, CommercialContact.

The corporate address fields (CorporateAddressLine1, CorporateAddressLine2, CorporateAddressCity, CorporateAddressPostalCode, CorporateAddressCountry) update the corporate address. The billing address fields (BillingAddressLine1, BillingAddressLine2, BillingAddressCity, BillingAddressPostalCode, BillingAddressCountry) update the billing address. These are returned as nested CorporateAddress and BillingAddress objects by the GET endpoint.

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

Body

CompanyNamestringOptional

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

Example: Acme Corporation

WebsitestringOptional

The official company website URL for the account.

Example: https://www.example.com

PrimaryPhoneNumberstringOptional

The primary domestic contact number for the account.

Example: 1235550100

PrimaryPhoneNumberCountrystringOptional

Two-letter country code. See ISO 3166-1 alpha-2. Required if PrimaryPhoneNumber is provided.

Example: US

OrganizationTypestring · enumOptional

Organization type for the account.

Example: CORPPossible values:

EinSsnForeignTaxIdstringOptional

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.

Example: 12-3456789

CorporateAddressLine1stringOptional

Address line 1 (address number, street name)

Example: 1640 Riverside Dr.

CorporateAddressLine2stringOptional

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

Example: Suite 400

CorporateAddressCitystringOptional

City, district, suburb, town, or village

Example: Hill Valley

CorporateAddressPostalCodestringOptional

ZIP or postal code

Example: 90210

CorporateAddressCountrystringOptional

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

Example: US

BillingAddressLine1stringOptional

Address line 1 (address number, street name)

Example: 112 1/2 Beacon St.

BillingAddressLine2stringOptional

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

Example: Floor 2

BillingAddressCitystringOptional

City, district, suburb, town, or village

Example: Boston

BillingAddressPostalCodestringOptional

ZIP or postal code

Example: 02116

BillingAddressCountrystringOptional

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

Example: US

SecondaryPhoneNumberstringOptional

A secondary domestic contact phone number for the account.

Example: 3215550100

SecondaryPhoneNumberCountrystringOptional

Two-letter country code. See ISO 3166-1 alpha-2. Required if SecondaryPhoneNumber is provided.

Example: US

Responses

200

The request was successful.

application/json

StatusstringOptional

Indicates whether the update was successful.

Example: OK

Uristring · uri-referenceOptional

The unique reference to the updated resource.

Example: /Advertisers/<AccountSID>/CompanyInformation

put/Advertisers/{AccountSID}/CompanyInformation

PUT /Advertisers/{AccountSID}/CompanyInformation HTTP/1.1
Host: api.impact.com
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 623

"CompanyName='Acme Corporation'&Website='https://www.example.com'&PrimaryPhoneNumber='1235550100'&PrimaryPhoneNumberCountry='US'&OrganizationType='CORP'&EinSsnForeignTaxId='12-3456789'&CorporateAddressLine1='1640 Riverside Dr.'&CorporateAddressLine2='Suite 400'&CorporateAddressCity='Hill Valley'&CorporateAddressPostalCode='90210'&CorporateAddressCountry='US'&BillingAddressLine1='112 1/2 Beacon St.'&BillingAddressLine2='Floor 2'&BillingAddressCity='Boston'&BillingAddressPostalCode='02116'&BillingAddressCountry='US'&SecondaryPhoneNumber='3215550100'&SecondaryPhoneNumberCountry='US'"

200

The request was successful.

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

PreviousAccounts NextLegal Entities

Last updated 6 hours ago