Company
Create company
- Introduction
- API Reference
- GETList call outcomes
- GETList company categories
- GETList contract types
- GETList custom fields
- GETList industries
- GETList lead sources
- GETList loss reasons
- GETList market sectors
- POSTCreate opportunity
- PATCHUpdate opportunity
- GETList opportunities
- GETGet opportunity
- DELDelete opportunity
- GETList opp stages
Call Outcome
Company Category
Contract Type
Custom Field
Industry
Lead Source
Loss Reason
Market Sector
Opportunity
Opp Stage
Company
Create company
POST
/
api
/
2023-01
/
companies
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Authorization
string
*
Authorization
Required
string
object
company
object
company
object
name
string
*
name
Required
string
Add Example Value
description
string
description
string
Add Example Value
phone
string
phone
string
Add Example Value
website
string
website
string
Add Example Value
address
object
address
object
street_address
string
street_address
string
Add Example Value
street_address2
string
street_address2
string
Add Example Value
city
string
city
string
Add Example Value
state
string
state
string
Add Example Value
zip
string
zip
string
Add Example Value
country
enum<string>
country
enum<string>
Add Example Value
company_category_id
string
company_category_id
string
Add Example Value
industry_id
string
industry_id
string
Add Example Value
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.",
"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"
},
"company_category_id": "773",
"industry_id": "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.",
"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"
},
"company_category": {
"id": "773",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Developer"
},
"industry": {
"id": "785",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Hospitality"
},
"import": {
"id": "456",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"custom_fields": {}
}
}
Headers
Authorization
string
requiredBody
application/json
company
object
company.name
string
requiredcompany.description
string
company.phone
string
company.website
string
company.address
object
company.address.street_address
string
company.address.street_address2
string
company.address.city
string
company.address.state
string
company.address.zip
string
company.address.country
enum<string>
Available options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
company.company_category_id
string
company.industry_id
string
Response
201 - application/json
company
object
requiredcompany.id
string
requiredcompany.created_at
string
requiredcompany.updated_at
string
requiredcompany.description
string
requiredcompany.name
string
requiredcompany.phone
string
requiredcompany.website
string
requiredcompany.address
object
requiredcompany.address.street_address
string
requiredcompany.address.street_address2
string
requiredcompany.address.city
string
requiredcompany.address.state
string
company.address.zip
string
requiredcompany.address.country
enum<string>
requiredAvailable options:
AU
, CA
, GB
, IS
, NZ
, UK
, US
company.created_by
object
requiredcompany.created_by.id
string
requiredcompany.created_by.created_at
string
requiredcompany.created_by.updated_at
string
requiredcompany.created_by.first_name
string
requiredcompany.created_by.last_name
string
requiredcompany.created_by.name
string
requiredcompany.created_by.email
string
requiredcompany.company_category
object | null
requiredcompany.company_category.id
string
requiredcompany.company_category.created_at
string
requiredcompany.company_category.updated_at
string
requiredcompany.company_category.name
string
requiredcompany.industry
object | null
requiredcompany.industry.id
string
requiredcompany.industry.created_at
string
requiredcompany.industry.updated_at
string
requiredcompany.industry.name
string
requiredcompany.import
object | null
requiredcompany.import.id
string
requiredcompany.import.created_at
string
requiredcompany.import.updated_at
string
requiredcompany.import.name
string
requiredcompany.custom_fields
object
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.",
"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"
},
"company_category_id": "773",
"industry_id": "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.",
"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"
},
"company_category": {
"id": "773",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Developer"
},
"industry": {
"id": "785",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "Hospitality"
},
"import": {
"id": "456",
"created_at": "2023-02-14T18:13:00Z",
"updated_at": "2023-04-03T20:16:30Z",
"name": "<string>"
},
"custom_fields": {}
}
}