Sign in

v1

latestOpenAPI 3.0.3Apache 2.02026-07-1352108391.8 KB
Companies

Create company

Create company

post/crm/companies

Query parameters

rawboolean

Include raw response. Mostly used for debugging purposes

Headers

x-apideck-consumer-idstring required

ID of the consumer which you want to get or push data from

x-apideck-app-idstring required

The ID of your Unify application

x-apideck-service-idstring

Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.

Request body

idstring

Unique identifier for the company

namestring nullable required

Name of the company

interaction_countinteger nullable

Number of interactions

owner_idstring nullable

Owner ID

imagestring nullable

The Image URL of the company

descriptionstring nullable

A description of the company

vat_numberstring nullable

The VAT number of the company

currency'UNKNOWN_CURRENCY' | 'AED' | 'AFN' | 'ALL' | 'AMD' | 'ANG' | 'AOA' | 'ARS' | 'AUD' | 'AWG' | 'AZN' | 'BAM' | 'BBD' | 'BDT' | 'BGN' | 'BHD' | 'BIF' | 'BMD' | 'BND' | 'BOB' | 'BOV' | 'BRL' | 'BSD' | 'BTN' | 'BWP' | 'BYR' | 'BZD' | 'CAD' | 'CDF' | 'CHE' | 'CHF' | 'CHW' | 'CLF' | 'CLP' | 'CNY' | 'COP' | 'COU' | 'CRC' | 'CUC' | 'CUP' | 'CVE' | 'CZK' | 'DJF' | 'DKK' | 'DOP' | 'DZD' | 'EGP' | 'ERN' | 'ETB' | 'EUR' | 'FJD' | 'FKP' | 'GBP' | 'GEL' | 'GHS' | 'GIP' | 'GMD' | 'GNF' | 'GTQ' | 'GYD' | 'HKD' | 'HNL' | 'HRK' | 'HTG' | 'HUF' | 'IDR' | 'ILS' | 'INR' | 'IQD' | 'IRR' | 'ISK' | 'JMD' | 'JOD' | 'JPY' | 'KES' | 'KGS' | 'KHR' | 'KMF' | 'KPW' | 'KRW' | 'KWD' | 'KYD' | 'KZT' | 'LAK' | 'LBP' | 'LKR' | 'LRD' | 'LSL' | 'LTL' | 'LVL' | 'LYD' | 'MAD' | 'MDL' | 'MGA' | 'MKD' | 'MMK' | 'MNT' | 'MOP' | 'MRO' | 'MUR' | 'MVR' | 'MWK' | 'MXN' | 'MXV' | 'MYR' | 'MZN' | 'NAD' | 'NGN' | 'NIO' | 'NOK' | 'NPR' | 'NZD' | 'OMR' | 'PAB' | 'PEN' | 'PGK' | 'PHP' | 'PKR' | 'PLN' | 'PYG' | 'QAR' | 'RON' | 'RSD' | 'RUB' | 'RWF' | 'SAR' | 'SBD' | 'SCR' | 'SDG' | 'SEK' | 'SGD' | 'SHP' | 'SLL' | 'SOS' | 'SRD' | 'SSP' | 'STD' | 'SVC' | 'SYP' | 'SZL' | 'THB' | 'TJS' | 'TMT' | 'TND' | 'TOP' | 'TRC' | 'TRY' | 'TTD' | 'TWD' | 'TZS' | 'UAH' | 'UGX' | 'USD' | 'USN' | 'USS' | 'UYI' | 'UYU' | 'UZS' | 'VEF' | 'VND' | 'VUV' | 'WST' | 'XAF' | 'XAG' | 'XAU' | 'XBA' | 'XBB' | 'XBC' | 'XBD' | 'XCD' | 'XDR' | 'XOF' | 'XPD' | 'XPF' | 'XPT' | 'XTS' | 'XXX' | 'YER' | 'ZAR' | 'ZMK' | 'ZMW' | 'BTC' | 'ETH' nullable

Indicates the associated currency for an amount of money. Values correspond to ISO 4217.

statusstring nullable

The status of the company

faxstring nullable

The fax number of the company

annual_revenuestring nullable

The annual revenue of the company

number_of_employeesstring nullable

Number of employees

industrystring nullable

The industry represents the type of business the company is in.

ownershipstring nullable

The ownership indicates the type of ownership of the company.

sales_tax_numberstring nullable

A sales tax number is a unique number that identifies a company for tax purposes.

payee_numberstring nullable

A payee number is a unique number that identifies a payee for tax purposes.

abn_or_tfnstring nullable

An ABN is necessary for operating a business, while a TFN (Tax File Number) is required for any person working in Australia.

abn_branchstring nullable

An ABN Branch (also known as a GST Branch) is used if part of your business needs to account for GST separately from its parent entity.

acnstring nullable

The Australian Company Number (ACN) is a nine digit number with the last digit being a check digit calculated using a modified modulus 10 calculation. ASIC has adopted a convention of always printing and displaying the ACN in the format XXX XXX XXX; three blocks of three characters, each block separated by a blank.

first_namestring nullable

The first name of the person.

last_namestring nullable

The last name of the person.

parent_idstring nullable

Parent ID

tagsstring[] nullable
read_onlyboolean nullable

Whether the company is read-only or not

last_activity_atstring date-time nullable

Last activity date

deletedboolean

Whether the company is deleted or not

salutationstring nullable

A formal salutation for the person. For example, 'Mr', 'Mrs'

birthdaystring date nullable

The date of birth of the person.

custom_mappingsCustomMappings nullable

When custom mappings are configured on the resource, the result is included here.

updated_bystring nullable

Updated by user ID

created_bystring nullable

Created by user ID

updated_atstring date-time nullable

Last updated date

created_atstring date-time nullable

Creation date

Example request

{
  "id": "12345",
  "name": "SpaceX",
  "interaction_count": 1,
  "owner_id": "12345",
  "image": "https://www.spacex.com/static/images/share.jpg",
  "description": "Space Exploration Technologies Corp. is an American aerospace manufacturer, space transportation services and communications company headquartered in Hawthorne, California.",
  "vat_number": "BE0689615164",
  "currency": "USD",
  "status": "Open",
  "fax": "+12129876543",
  "annual_revenue": "+$35m",
  "number_of_employees": "500-1000",
  "industry": "Apparel",
  "ownership": "Public",
  "sales_tax_number": "12456EN",
  "payee_number": "78932EN",
  "abn_or_tfn": "46 115 614 695",
  "abn_branch": "123",
  "acn": "XXX XXX XXX",
  "first_name": "Elon",
  "last_name": "Musk",
  "parent_id": "22345",
  "bank_accounts": [
    {
      "bank_name": "Chase Bank",
      "account_number": "123465",
      "account_name": "Main Operating Account",
      "account_type": "credit_card",
      "iban": "GB33BUKB20201555555555",
      "bic": "CHASUS33",
      "routing_number": "021000021",
      "bsb_number": "062-001",
      "branch_identifier": "001",
      "bank_code": "BNH",
      "currency": "USD",
      "country": "US"
    }
  ],
  "websites": [
    {
      "id": "12345",
      "url": "http://example.com",
      "type": "primary"
    }
  ],
  "addresses": [
    {
      "id": "123",
      "type": "primary",
      "string": "25 Spring Street, Blackburn, VIC 3130",
      "name": "HQ US",
      "line1": "Main street",
      "line2": "apt #",
      "line3": "Suite #",
      "line4": "delivery instructions",
      "line5": "Attention: Finance Dept",
      "street_number": "25",
      "city": "San Francisco",
      "state": "CA",
      "postal_code": "94104",
      "country": "US",
      "latitude": "40.759211",
      "longitude": "-73.984638",
      "county": "Santa Clara",
      "contact_name": "Elon Musk",
      "salutation": "Mr",
      "phone_number": "111-111-1111",
      "fax": "122-111-1111",
      "email": "elon@musk.com",
      "website": "https://elonmusk.com",
      "notes": "Address notes or delivery instructions.",
      "row_version": "1-12345"
    }
  ],
  "social_links": [
    {
      "id": "12345",
      "url": "https://www.twitter.com/apideck",
      "type": "twitter"
    }
  ],
  "phone_numbers": [
    {
      "id": "12345",
      "country_code": "1",
      "area_code": "323",
      "number": "111-111-1111",
      "extension": "105",
      "type": "primary"
    }
  ],
  "emails": [
    {
      "id": "123",
      "email": "elon@musk.com",
      "type": "primary"
    }
  ],
  "row_type": {
    "id": "12345",
    "name": "Customer Account"
  },
  "custom_fields": [
    {
      "id": "2389328923893298",
      "name": "employee_level",
      "description": "Employee Level",
      "value": "Uses Salesforce and Marketo"
    }
  ],
  "tags": [
    "New"
  ],
  "last_activity_at": "2020-09-30T07:43:32.000Z",
  "salutation": "Mr",
  "birthday": "2000-08-12",
  "updated_by": "12345",
  "created_by": "12345",
  "updated_at": "2020-09-30T07:43:32.000Z",
  "created_at": "2020-09-30T07:43:32.000Z",
  "pass_through": [
    {
      "extend_paths": [
        {
          "path": "$.nested.property",
          "value": {
            "TaxClassificationRef": {
              "value": "EUC-99990201-V1-00020000"
            }
          }
        }
      ]
    }
  ]
}

Response

Company created

status_codeinteger required

HTTP Response Status Code

statusstring required

HTTP Response Status

servicestring required

Apideck ID of service provider

resourcestring required

Unified API resource name

operationstring required

Operation performed

_rawRaw nullable

Raw response from the integration when raw=true query param is provided

Example response

{
  "status_code": 200,
  "status": "OK",
  "service": "zoho-crm",
  "resource": "companies",
  "operation": "add",
  "data": {
    "id": "12345"
  }
}