openapi: 3.1.0
info:
  title: Brand Accounts API
  version: v11
  description: "Manage your impact.com brand account settings. This includes company metadata (Company Information) \nand associated payment/tax-related information (Legal Entities).\n"
servers:
- url: https://api.impact.com
paths:
  /Advertisers/{AccountSID}/CompanyInformation:
    get:
      operationId: getCompanyInformation
      tags:
      - Company Information
      summary: Get Company Information
      description: Retrieves the details of this account. The account is determined by the API keys you use.
      parameters:
      - name: AccountSID
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Returns an account object.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
    put:
      operationId: updateCompanyInformation
      tags:
      - Company Information
      summary: Update Company Information
      description: '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.'
      parameters:
      - name: AccountSID
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/x-www-form-urlencoded:
            schema:
              type: object
              properties:
                CompanyName:
                  type: string
                  description: The name used for the account, usually the legal name.
                  example: Acme Corporation
                Website:
                  type: string
                  description: The official company website URL.
                  example: https://www.example.com
                PrimaryPhoneNumber:
                  type: string
                  description: The primary domestic contact number for the account.
                  example: '1235550100'
                PrimaryPhoneNumberCountry:
                  type: string
                  description: Two-letter country code ISO 3166-1 alpha-2. Required if PrimaryPhoneNumber is provided.
                  example: US
                OrganizationType:
                  type: string
                  description: Organization type for the account. Available options will vary depending on the country that the business is registered in.
                  enum:
                  - NONP_GOV
                  - CORP
                  - SOLE_IND
                  - LLC_LLP_LLS
                  - TRUST
                  - SOLE_TRD
                  - PARTNERS
                  - LLC
                  - LLP
                  - COMPANY
                  - GOVERNMENT
                  - OTHER
                  example: CORP
                EinSsnForeignTaxId:
                  type: string
                  description: 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
                CorporateAddressLine1:
                  type: string
                  description: Address line 1 (address number, street name)
                  example: 1640 Riverside Dr.
                CorporateAddressLine2:
                  type: string
                  description: Address line 2 (building, unit, suite, etc. number)
                  example: Suite 400
                CorporateAddressCity:
                  type: string
                  description: City, district, suburb, town, or village
                  example: Hill Valley
                CorporateAddressPostalCode:
                  type: string
                  description: ZIP or postal code
                  example: '90210'
                CorporateAddressCountry:
                  type: string
                  description: Two-letter country code. See ISO 3166-1 alpha-2.
                  example: US
                BillingAddressLine1:
                  type: string
                  description: Address line 1 (address number, street name)
                  example: 112 1/2 Beacon St.
                BillingAddressLine2:
                  type: string
                  description: Address line 2 (building, unit, suite, etc. number)
                  example: Floor 2
                BillingAddressCity:
                  type: string
                  description: City, district, suburb, town, or village
                  example: Boston
                BillingAddressPostalCode:
                  type: string
                  description: ZIP or postal code
                  example: '02116'
                BillingAddressCountry:
                  type: string
                  description: Two-letter country code. See ISO 3166-1 alpha-2.
                  example: US
                SecondaryPhoneNumber:
                  type: string
                  description: A secondary domestic contact phone number for the account.
                  example: '3215550100'
                SecondaryPhoneNumberCountry:
                  type: string
                  description: Two-letter country code. See ISO 3166-1 alpha-2. Required if SecondaryPhoneNumber is provided.
                  example: US
      responses:
        '200':
          description: Returns the status of the request and the URI.
          content:
            application/json:
              schema:
                type: object
                properties:
                  Status:
                    type: string
                    description: Indicates whether the update was successful.
                  Uri:
                    type: string
                    format: uri-reference
                    description: The unique reference to the updated resource.
components:
  schemas:
    Account:
      type: object
      properties:
        CompanyName:
          type: string
          example: Acme Corporation
          description: Brand name for the account; usually the legal name of the company.
        Industry:
          type: object
          properties:
            IndustryId:
              type: string
              description: Unique identifier for the selected industry.
              example: '544'
            IndustryName:
              type: string
              description: The display name for the selected industry.
              example: Retail Trade
          description: The industry that the account most closely associates with.
        Website:
          type: string
          format: uri
          example: https://www.example.com
          description: Official website URL for the brand or company.
        PrimaryPhoneNumber:
          type: string
          example: '1235550100'
          description: Primary domestic contact number for the account.
        PrimaryPhoneNumberCountry:
          type: string
          example: US
          description: Two-letter ISO 3166-1 alpha-2 country code representing the country of the primary phone number.
        SecondaryPhoneNumber:
          type: string
          example: '3215550100'
          description: A secondary domestic contact phone number for the account.
        SecondaryPhoneNumberCountry:
          type: string
          example: US
          description: Two-letter country code. See ISO 3166-1 alpha-2.
        MinimumContactRating:
          type: string
          example: '1'
          description: Minimum amount of star rating (1 lowest, 5 highest) a partner must have to see contact information for the account.
        Timezone:
          type: string
          example: (GMT -08:00) Pacific Time (US & Canada); Tijuana
          description: Timezone used for the account.
        Currency:
          type: string
          example: USD
          description: Three-letter ISO 4217 code representing the account's default currency appearing in the dashboard, finances, and reports.
        RegisteredForIndirectTax:
          type: string
          example: 'false'
          description: Whether the account is registered for indirect tax, such as VAT, GST, or HST.
        IndirectTaxNumber:
          type: string
          example: '123456789'
          description: Unique identifier used for VAT, GST, or HST registration.
        OrganizationType:
          type: string
          example: CORP
          description: Organization type for the account. Available options will vary depending on the country that the business is registered in.
        EinSsnForeignTaxId:
          type: string
          example: 12-3456789
          description: 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:
          $ref: '#/components/schemas/Address'
          description: The primary address for the account.
        BillingAddress:
          $ref: '#/components/schemas/Address'
          description: The billing address for the account.
        FinancialContact:
          $ref: '#/components/schemas/Contact'
          description: A financial contact for the account (e.g., CFO).
        TechnicalContact:
          $ref: '#/components/schemas/Contact'
          description: A technical contact for the account (e.g., CTO).
        SecurityContact:
          $ref: '#/components/schemas/Contact'
          description: This person is your company's point of contact for compliance and security policy matters. They handle security- and compliance-related issues for your business.
        CommercialContact:
          $ref: '#/components/schemas/Contact'
          description: A commercial or marketing contact for the account (e.g., CMO).
        Uri:
          type: string
          format: uri-reference
          example: /Advertisers/<AccountSID>/CompanyInformation
          description: The unique reference to this object in the impact.com API.
    Address:
      type: object
      properties:
        AddressLine1:
          type: string
          description: Address line 1 (address number, street name)
          example: 1640 Riverside Dr.
        AddressLine2:
          type: string
          description: Address line 2 (building, unit, suite, etc. number)
          example: Suite 400
        City:
          type: string
          description: City, district, suburb, town, or village
          example: Hill Valley
        State:
          type: string
          description: State or territory
          example: CALIFORNIA
        PostalCode:
          type: string
          description: ZIP or postal code
          example: '90210'
        Country:
          type: string
          description: Two-letter country code. See ISO 3166-1 alpha-2.
          example: US
    Contact:
      type: object
      properties:
        UserId:
          type: string
          example: '1234567'
          description: Unique impact.com member account ID for the user.
        Name:
          type: string
          example: Road Runner
          description: The contact's full name.
        Email:
          type: string
          format: email
          example: finance@example.com
          description: The contact's email address.
        WorkPhoneNumber:
          type: string
          example: '2065550100'
          description: The contact's work phone number.
        WorkPhoneNumberCountry:
          type: string
          example: US
          description: Two-letter country code for the work phone number. See ISO 3166-1 alpha-2.
        CellPhoneNumber:
          type: string
          example: '2065550133'
          description: The contact's cell phone number.
        CellPhoneNumberCountry:
          type: string
          example: US
          description: Two-letter country code for the cell phone number. See ISO 3166-1 alpha-2.
