Company

Update the company profile

Changing profile fields rebuilds the classifier's context. Setting context yourself replaces it until the next profile change. New mentions are scored with the change right away.

patch/v1/company

Request

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

Request body

namestring
descriptionstring
useCasesstring[]

Sets the full new list.

websitestring uri nullable

The company's website. Null removes it.

competitorsstring[]

Sets the full new list. An empty list clears it.

guidelinesstring nullable

Rules for the classifier in your own words. Null removes them.

contextstring

Replaces the built context until the next profile change.

Response

The profile after the change

namestring required

The name of your brand or company, as the classifier should use it.

descriptionstring required

A paragraph on what the company does.

useCasesstring[] required

Typical uses of the product.

websitestring nullable required

The company's website, as entered during onboarding.

competitorsstring[] required

Names of competitors, so the classifier knows when a post is about one of them. Often the same names as your competitor keywords.

guidelinesstring nullable required

Rules for the classifier in your own words, saying what is relevant to you and what never is, for example "questions about our SDK, never job ads". After the description, this has the most effect on scores.

contextstring required

Classifier input. Built from the other fields unless you write it yourself.

Changes

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