PUT
a company
PUT
/user-api/v1/companies/:id
Path Parameters
Header | Value |
---|
Content-Type | application/json |
x-rolodex-api-key | f1e2d3c4b5a697... |
Query Parameters
Related data to include: custom_fields
, tags
, lists
, contacts
Endpoint Example
PUT
/user-api/v1/companies/company_67890?include=tags,custom_fields
Relationship fields (tags, lists, contacts, custom_fields) are replaced entirely with the provided values. To add to existing relationships, include all current values plus new ones.
Request
{
"arr_estimate": 1500000,
"number_of_employees": 65,
"is_starred": false,
"tags": ["tag_123", "tag_999"],
"custom_fields": [
{
"id": "field_123",
"value": "AI & Machine Learning"
}
]
}
Response
{
"data": {
"id": "company_67890",
"name": "TechStart Inc",
"description": "Innovative startup focused on AI solutions",
"headquarters_location": "Austin, TX",
"linkedin_slug": "techstart-inc",
"website_url": "https://techstart.com",
"x_slug": null,
"facebook_slug": null,
"instagram_slug": null,
"email": "hello@techstart.com",
"country_code": "+1",
"phone_number": "5559876543",
"arr_estimate": 1500000,
"number_of_employees": 65,
"is_starred": false,
"ignore_merge": false,
"last_team_interaction": null,
"team_members_connected": 0,
"created_at": "2025-01-15T10:30:00Z",
"updated_at": "2025-01-15T12:45:00Z"
}
}