Companies

Update a company

Changed on

Updates the specified company by setting the values of the parameters passed. Any parameters not provided will be left unchanged. The request is idempotent when an Idempotency-Key header is supplied.

patch/companies/{id}

Request

  • Base URL: https://api.cavuno.com/v1
  • URL: https://api.cavuno.com/v1/companies/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

The company's opaque object id: the id field returned by the company endpoints (e.g. p17xq4c2b9r5gz3e8j0r6t4k7m2n9d5w). This is NOT the slug or display name; passing a slug like antler returns 404. To look up a company by name or slug, use GET /v1/companies, POST /v1/companies/search, or POST /v1/companies/find-or-create and read the returned id.

Request body

websitestring nullable

Public company website URL. Normalized to a canonical apex domain when stored. Pass null or "" to clear the stored value; omitted means unchanged.

summarystring nullable

One-line summary of the company. Up to 280 characters. Pass null or "" to clear the stored value; omitted means unchanged.

descriptionstring nullable

Long-form description of the company, as HTML. Up to 25,000 characters. The HTML is sanitized on write: tags and attributes outside the supported formatting set (paragraphs, headings, lists, links, inline emphasis) are removed. Plain text without HTML tags is converted to paragraphs. Pass null or "" to clear the stored value; omitted means unchanged.

xUrlstring nullable

X (Twitter) profile URL or handle. Stored as the canonical handle. Pass null or "" to clear the stored value; omitted means unchanged.

linkedinUrlstring nullable

LinkedIn company page URL. Pass null or "" to clear the stored value; omitted means unchanged.

facebookUrlstring nullable

Facebook company page URL. Pass null or "" to clear the stored value; omitted means unchanged.

instagramUrlstring nullable

Instagram profile URL or handle. Pass null or "" to clear the stored value; omitted means unchanged.

marketsstring[]

Canonical market slugs assigned to the company. Pass an empty array to clear all markets.

namestring

The company's display name.

slugstring

URL-friendly slug for the company.

Response

Successful response.

idstring required

Unique identifier for the object. Use this value as the {id} path parameter for the company endpoints (e.g. GET /v1/companies/{id}).

object'company' required

String representing the object's type. Objects of the same type share the same value.

namestring required

Display name of the company.

slugstring required

URL-friendly slug for the company.

websitestring nullable required

Public company website URL, or null if not set.

logoUrlstring nullable required

URL of the company logo, or null if no logo is set.

summarystring nullable required

One-line summary of the company, or null if not set.

marketsstring[] required

Canonical market slugs assigned to the company.

xUrlstring nullable required

X (Twitter) profile URL, or null if not set.

linkedinUrlstring nullable required

LinkedIn page URL, or null if not set.

facebookUrlstring nullable required

Facebook page URL, or null if not set.

instagramUrlstring nullable required

Instagram profile URL, or null if not set.

createdAtstring required

Time at which the company was created. ISO 8601 datetime.

updatedAtstring nullable required

Time at which the company was last updated, or null if it has never been updated. ISO 8601 datetime.

revisioninteger required

Public Company lifecycle revision. Historical rows may be 0 until rollout backfill.

descriptionstring nullable required

Long-form description of the company (HTML), or null if not set.

canBackfillboolean nullable required

Whether automated backfill of jobs from this company is supported, or null if not yet evaluated.

jobCountnumber required

Total number of jobs at this company across all statuses.

publishedJobCountnumber required

Number of currently-published jobs at this company.

Changes

  • c34152c38176Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status