API ReferenceCompanies
Update a company
Updates a company's details. Only the provided fields are changed. Requires the `companies:write` scope (`contacts:write` is also accepted for keys issued before it existed).
Authorization
bearerAuth AuthorizationBearer <token>
Workspace API key, e.g. rl_live_….
In: header
Path Parameters
id*string
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
name?string
website?string|null
industry?string|null
notes?string|null
externalId?string|null
Response Body
application/json
application/json
curl -X PATCH "https://example.com/v1/public/companies/string" \ -H "Content-Type: application/json" \ -d '{}'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "name": "string", "website": "string", "industry": "string", "notes": "string", "externalId": "string", "createdAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z"}{ "error": "string"}List companies GET
Lists the workspace's companies, newest first. Requires the `companies:read` scope (`contacts:read` is also accepted for keys issued before it existed).
Create a company POST
Creates a company. Requires the `companies:write` scope (`contacts:write` is also accepted for keys issued before it existed).