Company
Create company
Call Outcome
Company Category
Contract Type
Custom Field
Delivery Method
Industry
Lead Source
Loss Reason
Market Sector
Project Stages
Task List
Tender Type
Webhook Message
Company
Create company
POST
/
api
/
2023-01
/
companies
curl --request POST \
--url https://api.buildr.com/api/2023-01/companies \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"company": {
"name": "ACME Corp.",
"category": "client",
"description": "A long time partner",
"phone": "555-555-5555",
"website": "https://www.example.com",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"industry_ids": [
"785"
]
}
}'
{
"company": {
"id": "753",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"description": "A long time partner",
"name": "ACME Corp.",
"category": "client",
"phone": "555-555-5555",
"website": "https://www.example.com",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"created_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"import": {
"id": "456",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"industries": [
{
"id": "785",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Hospitality"
}
],
"custom_fields": {}
}
}
Headers
Body
application/json
Example:
"ACME Corp."
Example:
"client"
Example:
"A long time partner"
Example:
"555-555-5555"
Example:
"https://www.example.com"
Example:
"123 Main St"
Example:
"Apt 1"
Example:
"Los Angeles"
Example:
"CA"
Example:
"90001"
Available options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
Example:
"US"
Response
201 - application/json
Created Response
Example:
"753"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"A long time partner"
Example:
"ACME Corp."
Available options:
client
, design
, engineering
, finance
, trade_partner
, other
Example:
"client"
Example:
"555-555-5555"
Example:
"https://www.example.com"
Example:
"123 Main St"
Example:
"Apt 1"
Example:
"Los Angeles"
Example:
"90001"
Available options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
Example:
"US"
Example:
"CA"
Example:
"953"
Example:
"2023-02-14T18:13:00Z"
Example:
"2023-04-03T20:16:30Z"
Example:
"Russell"
Example:
"Westbrook"
Example:
"Russell Westbrook"
Example:
"russell.westbrook@example.com"
curl --request POST \
--url https://api.buildr.com/api/2023-01/companies \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '{
"company": {
"name": "ACME Corp.",
"category": "client",
"description": "A long time partner",
"phone": "555-555-5555",
"website": "https://www.example.com",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"industry_ids": [
"785"
]
}
}'
{
"company": {
"id": "753",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"description": "A long time partner",
"name": "ACME Corp.",
"category": "client",
"phone": "555-555-5555",
"website": "https://www.example.com",
"address": {
"street_address": "123 Main St",
"street_address2": "Apt 1",
"city": "Los Angeles",
"state": "CA",
"zip": "90001",
"country": "US"
},
"created_by": {
"id": "953",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"first_name": "Russell",
"last_name": "Westbrook",
"name": "Russell Westbrook",
"email": "russell.westbrook@example.com"
},
"import": {
"id": "456",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"industries": [
{
"id": "785",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Hospitality"
}
],
"custom_fields": {}
}
}