Company

Update the company profile

Changing profile fields recomposes the classifier context; setting context directly overrides it until the next profile edit. Relevance scores for new mentions follow at once.

patch/v1/company

Request

  • Base URL: https://api.mentio.dev
  • URL: https://api.mentio.dev/v1/company
  • Auth: HTTP bearer

Request body

namestring
descriptionstring
useCasesstring[]

Replaces the whole list.

websitestring uri nullable

The company website; null clears it.

competitorsstring[]

Replaces the whole list; [] clears it.

guidelinesstring nullable

Free-text rules for the classifier; null clears them.

contextstring

Overrides the composed context until the next profile edit.

Response

The updated profile

namestring required

Brand or company name, as the classifier should call it.

descriptionstring required

What the company does, one paragraph.

useCasesstring[] required

What people use the product for.

websitestring nullable required

The company website, as set up during onboarding.

competitorsstring[] required

Competitors by name, so the classifier reads a rival's mention as such; usually the same names as your competitor keywords.

guidelinesstring nullable required

Free-text rules for the classifier: what counts as relevant for you and what never does ("posts about our API, never job listings"). The second biggest lever after the description.

contextstring required

The text the classifier reads. Composed from the fields above unless you override it.

Changes

No recorded changes to this operation across all 1 revision of this API.