Ctrlk
Help CenterContact Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Company Information

Get Company Information

get

Retrieves the details of the brand account, determined by the API keys used for authentication.

Path parameters
AccountSIDstringRequired

The unique identifier for the account.

Responses
200

An object containing the account's company information.

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.

Example: US
SecondaryPhoneNumberstringOptional

A secondary domestic contact phone number for the account.

Example: 3215550100
SecondaryPhoneNumberCountrystringOptional

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

Example: US
MinimumContactRatingstringOptional

Minimum star rating (1-5) a partner must have to see contact information.

Example: 1
TimezonestringOptional

Timezone used for the account.

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

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

Example: USD
RegisteredForIndirectTaxstringOptional

Whether the account is registered for indirect tax.

Example: true
IndirectTaxNumberstringOptional

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

Example: 123456789
OrganizationTypestring · enumOptional

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

Example: CORPPossible values:
EinSsnForeignTaxIdstringOptional

Employer Identification Number, Social Security Number, or a foreign Tax ID.

Example: 12-3456789
Uristring · uri-referenceOptional

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

Example: /Advertisers/<AccountSID>/CompanyInformation
get/Advertisers/{AccountSID}/CompanyInformation
200

An object containing the account's company information.

Update Company Information

put

Updates the 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

Fields available for updating company information.

CompanyNamestringOptional

The name used for the account.

Example: Acme Corporation
Websitestring · uriOptional

The official company website URL.

Example: https://www.example.com
PrimaryPhoneNumberstringOptional

The primary domestic contact number.

Example: 1235550100
PrimaryPhoneNumberCountrystringOptional

Two-letter country code for the primary phone number (required if PrimaryPhoneNumber is provided).

Example: US
SecondaryPhoneNumberstringOptional

A secondary domestic contact phone number.

Example: 3215550100
SecondaryPhoneNumberCountrystringOptional

Two-letter country code for the secondary phone number (required if SecondaryPhoneNumber is provided).

Example: US
OrganizationTypestring · enumOptional

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

Example: CORPPossible values:
EinSsnForeignTaxIdstringOptional

EIN, SSN, or foreign Tax ID.

Example: 12-3456789
CorporateAddressLine1stringOptional

Address line 1 for the corporate address.

Example: 1640 Riverside Dr.
CorporateAddressLine2stringOptional

Address line 2 for the corporate address.

Example: Suite 400
CorporateAddressCitystringOptional

City for the corporate address.

Example: Hill Valley
CorporateAddressPostalCodestringOptional

Postal code for the corporate address.

Example: 90210
CorporateAddressCountrystringOptional

Two-letter country code for the corporate address.

Example: US
BillingAddressLine1stringOptional

Address line 1 for the billing address.

Example: 112 1/2 Beacon St.
BillingAddressLine2stringOptional

Address line 2 for the billing address.

Example: Floor 2
BillingAddressCitystringOptional

City for the billing address.

Example: Boston
BillingAddressPostalCodestringOptional

Postal code for the billing address.

Example: 02116
BillingAddressCountrystringOptional

Two-letter country code for the billing address.

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
200

The request was successful.

PreviousAccountsNextLegal Entities

Last updated