Create Company

POST {{baseUrl}}/hris/companies?raw=false

Create Company

Request Params

KeyDatatypeRequiredDescription
rawbooleanInclude raw response. Mostly used for debugging purposes

Request Body

{"legal_name"=>"SpaceX", "display_name"=>"SpaceX", "subdomain"=>"company", "status"=>"active", "company_number"=>"123456-AB", "currency"=>"USD", "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", "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"}, {"id"=>"123", "type"=>"primary", "string"=>"25 Spring Street, Blackburn, VIC 3130", "name"=>"HQ US", "line1"=>"Main street", "line2"=>"apt #", "line3"=>"Suite #", "line4"=>"delivery instructions", "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"}], "phone_numbers"=>[{"number"=>"111-111-1111", "id"=>"12345", "country_code"=>"1", "area_code"=>"323", "extension"=>"105", "type"=>"primary"}, {"number"=>"111-111-1111", "id"=>"12345", "country_code"=>"1", "area_code"=>"323", "extension"=>"105", "type"=>"primary"}], "emails"=>[{"email"=>"elon@musk.com", "id"=>"123", "type"=>"primary"}, {"email"=>"elon@musk.com", "id"=>"123", "type"=>"primary"}], "websites"=>[{"url"=>"http://example.com", "id"=>"12345", "type"=>"primary"}, {"url"=>"http://example.com", "id"=>"12345", "type"=>"primary"}], "debtor_id"=>"12345"}

HEADERS

KeyDatatypeRequiredDescription
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-idstringProvide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"status_code":200,"status":"OK","service":"undefined","resource":"Companies","operation":"add","data":{"id":"12345"}}