Companies
Create a company
AuthorizationBearer <token>
In: header
namestring
domains?array<string>
Domains owned by the company. The first entry is the primary and is what the favicon and the domain field resolve to. A domain may belong to only one company per account.
domain?string
Single-domain shorthand, equivalent to sending a one-item domains array. Ignored when domains is supplied.
address?string
notes?string
company_note?
Optional notes created under the new company. Requires an API key bound to a member. A note that fails to create is skipped; the company is still created and only the notes that succeeded are returned.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://app.sparrowdesk.com/v1/companies" \ -H "Content-Type: application/json" \ -d '{ "name": "string" }'{
"data": {
"id": 0,
"name": "string",
"domains": [
"string"
],
"domain": "string",
"logo": "string",
"industry": "string",
"phone": "string",
"address": "string",
"notes": "string",
"other_details": {},
"total_contacts_linked": 0,
"created_at": 0,
"updated_at": 0,
"company_note": [
{
"id": 0,
"title": "string",
"description": "string",
"attachments": [
{
"id": 0,
"url": "string",
"file_name": "string",
"content_type": "string",
"size": 0,
"status": "string"
}
]
}
]
}
}{
"error": {
"message": "Invalid request data"
}
}{
"error": {
"message": "Company with this name already exists"
}
}{
"error": {
"message": "Error while creating company"
}
}