PUT Update Company​
PUT
/companies/{id}
Update an existing company. The company name must remain unique across all companies. If the id is 0, the request is treated as a create operation. URL fields (website, linkedin_url, facebook_url, twitter_url) are auto-prefixed with https:// if no scheme is provided and validated as URLs.
Authorizations​
ApplicationPasswords
WordPress Application Passwords — use Basic auth with your WordPress username and an application password in the format: username:application_password
Type
API Key (header: Authorization)
Parameters​
Path Parameters
id*
The company ID to update. Pass 0 to create a new company instead.
Type
Requiredinteger
Request Body​
application/json
JSON
{
"name": "string",
"description": "string",
"email": "string",
"phone": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"type": "string",
"industry": "string",
"logo": "string",
"website": "string",
"linkedin_url": "string",
"facebook_url": "string",
"twitter_url": "string",
"owner_user_id": 0,
"employees_number": 0,
"status": "string"
}
Responses​
Company updated successfully.
application/json
JSON
{
"message": "string",
"company": {
"id": 0,
"name": "string",
"description": "string",
"email": "string",
"phone": "string",
"address_line_1": "string",
"address_line_2": "string",
"city": "string",
"state": "string",
"postal_code": "string",
"country": "string",
"type": "string",
"industry": "string",
"logo": "string",
"website": "string",
"linkedin_url": "string",
"facebook_url": "string",
"twitter_url": "string",
"owner_user_id": 0,
"employees_number": 0,
"status": "string",
"contacts_count": 0,
"created_at": "string",
"updated_at": "string",
"owner": {
"id": 0,
"first_name": "string",
"last_name": "string",
"email": "string"
}
}
}