Skip to main content
PUT
/
public-api
/
v1
/
companies
/
{id}
Update Company
curl --request PUT \
  --url https://app.cometly.com/public-api/v1/companies/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "domain": "<string>",
  "name": "<string>"
}
'
{
  "id": 123,
  "domain": "<string>",
  "name": "<string>",
  "message": "<string>"
}

Documentation Index

Fetch the complete documentation index at: https://docs.cometly.com/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

This endpoint updates an existing company using sparse PUT semantics. Any field you include is replaced with the value you provide; any field you omit is left untouched.

​
Path Parameters

​
id
integer
required
The unique identifier of the company to update.

​
Request Body

At least one of domain or name must be provided.
​
domain
string
New domain for the company. Omit to leave the existing domain untouched. Maximum 255 characters.
​
name
string
New name for the company. Omit to leave the existing name untouched. Maximum 255 characters.

​
Response

​
Success Response

Returns the full company object after the update.
​
id
integer
The unique identifier of the company.
​
domain
string
The domain currently associated with this company.
​
name
string
The name currently associated with this company.

​
Error Response

​
message
string
Error description explaining what went wrong.

​
Example Requests

curl -X PUT "https://app.cometly.com/public-api/v1/companies/12345" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{
    "domain": "acme.io",
    "name": "Acme Inc"
  }'

​
Status Codes

Status CodeDescription
200Company successfully updated
401Missing or invalid API key
403API key doesn’t have permission or subscription is inactive
404Company not found
422Invalid parameters provided (check error message for details)
429Too many requests - rate limit exceeded. See Rate Limiting

​
Notes

  • Rate Limit: This endpoint has a limit of 60 requests per minute per Space. See Rate Limiting for details.
  • Sparse PUT semantics: Only the fields you include in the request body are modified. Other columns are left untouched.
  • At least one field is required: A request with neither domain nor name is rejected with a 422 error.