---
title: "Update the company profile"
method: PATCH
path: "/v1/company"
tags: ["Company"]
---

# Update the company profile

`PATCH /v1/company`

## Request

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

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.

## Request body

- object: Fields you leave out stay as they are.
  - `name` string
  - `description` string
  - `useCases` string[]: Sets the full new list.
  - `accounts` object
    - `x` string, nullable
    - `linkedin` string, nullable
  - `website` string, uri, nullable: The company's website. Null removes it.
  - `competitors` string[]: Sets the full new list. An empty list clears it.
  - `guidelines` string, nullable: Rules for the classifier in your own words. Null removes them.
  - `context` string: Replaces the built context until the next profile change.

## Response `200`

The profile after the change

- Company
  - `name` string, required: The name of your brand or company, as the classifier should use it.
  - `description` string, required: A paragraph on what the company does.
  - `useCases` string[], required: Typical uses of the product.
  - `accounts` object, required: Your company's accounts, so posts from them are recognized as yours.
    - `x` string, nullable, required: Your X handle, without @.
    - `linkedin` string, nullable, required: Your LinkedIn page, as its slug or link.
  - `website` string, nullable, required: The company's website, as entered during onboarding.
  - `competitors` string[], required: Names of competitors, so the classifier knows when a post is about one of them. Often the same names as your competitor keywords.
  - `guidelines` string, 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.
  - `context` string, required: Classifier input. Built from the other fields unless you write it yourself.

## Other responses

- `401`: The API key is missing or not valid
- `404`: The workspace does not exist

---

[API](https://skmtc.dev/rumoro/apis/rumoro-api.md) · [All operations](https://skmtc.dev/rumoro/apis/rumoro-api/llms.txt) · [OpenAPI document](https://skmtc.dev/rumoro/apis/rumoro-api/revisions/9ef63ea894d1?raw)