Skip to main content
POST/companies/

Create company

You can create a company.

AttributesTypeRequiredDescription
custom_idstringnoThe unique identifier for the company which is provided by the client.
addressstringnoA company’s address.
citystringnoA company city of residence.
countrystringnoA company country of residence.
created_atstringnoA creation date of a company.
descriptionstringnoA description of a company.
emailstring(email)noA company’s email address.
namestringyesA company name.
phone_numbersstring(list)noA list of phone numbers.
postal_codestringnoA postal code according to the address of your company..
regionstringnoA company region of residence.
sizeintegernoAn approximate size of your company.
tagsstringnoA list of tags associated with a company
updated_atstringnoA date of last company update.

Request​

curl -X POST -H "Authorization: Token <your_64_char_api_key>" -H "Content-Type: application/json"
-H "Accept: */*; version=2" -d '{
"name": "1Company from API",
"description": "Company created by API request",
"email": "company@email.com",
"country": "United States",
"city": "Beverly Hills",
"postal_code": "90210",
"phone_numbers": [13102990912, 123456789]
}' "https://<your_app_subdomain>.user.com/api/public/companies/"

Response​

{
"id": 1666,
"name": "1Company from API",
"description": "Company created by API request",
"email": "company@email.com",
"country": "United States",
"region": null,
"city": "Beverly Hills",
"address": null,
"postal_code": "90210",
"approx_employees": null,
"created_at": "2017-07-06T15:39:25.513985Z",
"updated_at": "2017-07-06T15:39:25.514009Z",
"phone_numbers": [
"13102990912",
"13123456789"
],
"company_id": null,
"employees": [123, 432, 543]
}