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

# Update the company profile

`PATCH /v1/company`

## Request

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

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.

## Request body

- object: Omitted fields are untouched.
  - `name` string
  - `description` string
  - `useCases` string[]: Replaces the whole list.
  - `accounts` object
    - `x` string, nullable
    - `linkedin` string, nullable
  - `website` string, uri, nullable: The company website; null clears it.
  - `competitors` string[]: Replaces the whole list; [] clears it.
  - `guidelines` string, nullable: Free-text rules for the classifier; null clears them.
  - `context` string: Overrides the composed context until the next profile edit.

## Response `200`

The updated profile

- Company
  - `name` string, required: Brand or company name, as the classifier should call it.
  - `description` string, required: What the company does, one paragraph.
  - `useCases` string[], required: What people use the product for.
  - `accounts` object, required: Your own accounts, so your own posts are recognized.
    - `x` string, nullable, required: X handle without the @.
    - `linkedin` string, nullable, required: LinkedIn page slug or URL.
  - `website` string, nullable, required: The company website, as set up during onboarding.
  - `competitors` string[], required: Competitors by name, so the classifier reads a rival's mention as such; usually the same names as your competitor keywords.
  - `guidelines` string, 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.
  - `context` string, required: The text the classifier reads. Composed from the fields above unless you override it.

## Other responses

- `401`: Missing or invalid API key
- `404`: Workspace not found

---

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