Create company

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

Create company

Request Params

KeyDatatypeRequiredDescription
rawbooleanInclude raw response. Mostly used for debugging purposes

Request Body

{"name"=>"Company--{{$randomInt}}--{{$randomBsNoun}}", "owner_id"=>"{{primaryOwnerId}}", "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", "bank_accounts"=>[{"iban"=>"BE85731045583406", "bic"=>"KREDBEBB"}], "websites"=>[{"url"=>"{{$randomUrl}}", "type"=>"primary"}], "addresses"=>[{"type"=>"primary", "line1"=>"{{$randomStreetAddress}}", "line2"=>"{{$randomDepartment}}", "city"=>"{{$randomCity}}", "state"=>"CA", "postal_code"=>"94104", "country"=>"US", "latitude"=>"{{$randomLatitude}}", "longitude"=>"{{$randomLongitude}}"}, {"type"=>"shipping", "line1"=>"{{$randomStreetAddress}}", "line2"=>"{{$randomDepartment}}", "city"=>"{{$randomCity}}", "state"=>"CA", "postal_code"=>"94104", "country"=>"US", "latitude"=>"{{$randomLatitude}}", "longitude"=>"{{$randomLongitude}}"}], "social_links"=>[{"url"=>"https://twitter.com/apideck-io", "type"=>"twitter"}], "phone_numbers"=>[{"number"=>"{{$randomPhoneNumber}}", "type"=>"primary"}, {"number"=>"{{$randomPhoneNumber}}", "type"=>"fax"}], "emails"=>[{"type"=>"primary", "email"=>"{{$randomEmail}}"}], "row_type"=>{"id"=>"12345", "name"=>"Customer Account"}, "tags"=>["{{$randomBsNoun}}", "{{$randomBsNoun}}"], "read_only"=>false, "salutation"=>"Mr", "birthday"=>"2000-08-12"}

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":"zoho-crm","resource":"companies","operation":"add","data":{"id":"12345"}}