> ## Documentation Index > Fetch the complete documentation index at: https://docs.heliyos.ai/llms.txt > Use this file to discover all available pages before exploring further. # Update a label group > Changes a group's name, description, active state or labels. Send at least one field. `labels`, when sent, replaces the group's labels completely. To keep a label, send it with its current `_id`. A label sent with a new id is a new label, even if its name matches one being removed. Reactivating a paused group (`isActive` from `false` to `true`) can change its `color`, so that it stays distinct from the other active groups. > [!NOTE] > > In the Heliyos MCP server: [`heliyos_labels_update`](https://docs.heliyos.ai/mcp/tools/labels#heliyos-labels-update). ## OpenAPI ````yaml /api-reference/openapi.json patch /v1/platform/classification-labels/{id} openapi: 3.0.3 info: title: Heliyos API version: 1.0.0 description: >- The REST API for Heliyos, the AI operating system for revenue. Every request is scoped to the workspace that owns the API key. Responses are JSON in a `{ meta, data }` envelope; errors use `{ message, error: { code, message, details } }`. contact: name: Heliyos support email: soham@heliyos.ai url: https://www.heliyos.ai servers: - url: https://api-prod.heliyos.ai description: Production security: - bearerAuth: [] tags: - name: Workspace description: >- The workspace your API key belongs to, and the log of credits it has used. Every other call in this API is scoped to this workspace. - name: Schemas description: >- Objects are your record types: companies, people, deal pipelines and any custom objects you add. Each object has fields, and a field's type decides what its records can hold. - name: Records description: >- Records are the rows of an object (base schema): companies, people, deals and custom objects. A record holds field values keyed by the object's field keys and links to other records. - name: Timeline description: >- The AI-written timeline of a company, person or deal: summary entries Heliyos writes on a schedule. For the exact change history see Activities, and for emails and meetings see Interactions. - name: Activities description: >- The change history of records and tasks: who created, changed or deleted what, and when. People, workers and the system each appear as the actor on the changes they make. - name: Interactions description: >- Email threads and meetings synced from connected mailboxes and calendars, linked to the people and companies they involve. - name: Notes description: >- Free-text notes, optionally linked to records, tasks and interactions. Notes show up on the timeline of every record they are linked to, and workers read them as customer memory. - name: Tasks description: >- Work items for people and workers, optionally linked to records. A task can be assigned to people, to workers, or both, and workers can be started on it directly. - name: Workers and runs description: >- Workers are the AI teammates of your workspace (the API calls them agents). Define what each one does and what starts it, ask Heliyos to do work, and follow every run, its steps and the reviews it waits on. - name: Reviews description: >- Reviews keep the team in control of consequential work. When a worker wants to send an email, change a deal, book a meeting, act in a connected app or needs a person's answer, the action waits as a review until someone approves or rejects it. - name: Scouts description: >- Scouts watch companies and the web for events such as funding rounds, product launches, leadership changes or press coverage, and record each finding as a signal. A workspace Scout defines what to look for; company Scouts are its copies running on individual companies. - name: Signals description: >- Signals are what Scouts find: one event, such as a funding round or a new executive, with a summary, its sources and the company it is about. New signals are unread until you mark them read. - name: Watchlist description: >- The watchlist is the set of companies your workers monitor. Each watched company uses one Watcher from your plan: the workers keep it enriched, pull in its emails and meetings, and run Scouts on it. - name: Knowledge base description: >- What your workers know about the business: the business context, four fixed texts (products, pain points, value proposition, qualification criteria) and any custom entries your team adds. Workers read it on their next run. Files your workers read live under Files, with kind `knowledge_base`. - name: Files description: >- Knowledge base files that workers read, and files attached to records, tasks and other resources. The API calls them attachments. Uploading takes three calls: get an upload URL, send the bytes to it, then create the file. - name: Labels description: >- Label groups that sort your email threads, for example Intent or Pricing questions. Heliyos files each classified thread under a group, and each group holds the more specific labels it brings together. The API calls them classification labels. - name: Team description: >- The people in your workspace and their roles: joined members and pending invitations. Inviting someone sends them an email. - name: Notification settings description: >- Which workspace events send notification emails, how often, and to whom. There is one settings document per workspace, shared by everyone in it. paths: /v1/platform/classification-labels/{id}: patch: tags: - Labels summary: Update a label group description: >- Changes a group's name, description, active state or labels. Send at least one field. `labels`, when sent, replaces the group's labels completely. To keep a label, send it with its current `_id`. A label sent with a new id is a new label, even if its name matches one being removed. Reactivating a paused group (`isActive` from `false` to `true`) can change its `color`, so that it stays distinct from the other active groups. operationId: updateClassificationLabels parameters: - name: id in: path required: true schema: type: string pattern: ^[0-9a-fA-F]{24}$ description: The label group's id. example: 6729d0a1b2c3d4e5f6a7b8c9 requestBody: required: true content: application/json: schema: type: object properties: name: type: string minLength: 1 maxLength: 200 description: >- A new name, 1 to 200 characters, not used by another group in the workspace (case-sensitive). example: Pricing and billing description: type: string minLength: 1 maxLength: 1000 description: A new description, 1 to 1,000 characters. isActive: type: boolean description: >- `false` pauses the group without deleting it. `true` reactivates it. labels: type: array items: type: object required: - _id - name properties: _id: type: string description: >- The label's current id to keep it, or a new 24-character hexadecimal id for a new label. Ids starting with `temp_` are accepted only to keep existing labels that have one. example: 6729d1e2f3a4b5c6d7e8f901 name: type: string description: The label's name, 1 to 100 characters. example: Discount request maxItems: 500 description: >- The complete new set of labels, up to 500, with names unique within the group (ignoring case). Replaces the current labels. additionalProperties: false minProperties: 1 example: name: Pricing and billing labels: - _id: 6729d1e2f3a4b5c6d7e8f901 name: Discount request - _id: 6729d1e2f3a4b5c6d7e8f903 name: Invoice question responses: '200': description: The updated label group. content: application/json: schema: type: object required: - meta - data properties: meta: type: object required: - message properties: message: type: string description: A human-readable summary of the result. data: $ref: '#/components/schemas/LabelGroup' example: meta: message: Classification labels updated successfully data: _id: 6729d0a1b2c3d4e5f6a7b8c9 organizationId: 66a0f1e2d3c4b5a697887766 name: Pricing and billing description: >- Emails asking about prices, discounts, quotes or billing terms. isActive: true color: teal labels: - _id: 6729d1e2f3a4b5c6d7e8f901 name: Discount request - _id: 6729d1e2f3a4b5c6d7e8f903 name: Invoice question createdBy: 66a0f1e2d3c4b5a697881111 createdAt: '2026-11-04T09:30:00.000Z' updatedAt: '2026-11-05T14:10:00.000Z' '400': description: >- VALIDATION_FAILED: no field sent, a field is invalid, or two labels share a name (ignoring case). content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '401': description: Unauthenticated content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '403': description: Forbidden content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '404': description: 'NOT_FOUND: no label group with this id in the workspace.' content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '409': description: >- CONFLICT: another group in the workspace already has this name. Nothing is written. content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' '429': description: Rate limited content: application/json: schema: $ref: '#/components/schemas/ErrorEnvelope' components: schemas: LabelGroup: type: object properties: _id: $ref: '#/components/schemas/ObjectId' organizationId: allOf: - $ref: '#/components/schemas/ObjectId' description: The workspace the group belongs to. name: type: string description: The group's name, unique in the workspace. description: type: string description: >- What the group covers. Heliyos reads it when it classifies email threads. isActive: type: boolean description: '`true` for an active group, `false` for a paused one.' color: type: string description: >- The colour family the group's chip renders in, chosen by Heliyos: one of `red`, `orange`, `amber`, `olive`, `green`, `teal`, `blue`, `purple`, `pink`, `gray`. Groups created before these families existed can hold an older colour name. Absent on some older groups. example: teal labels: type: array description: The labels in the group. items: $ref: '#/components/schemas/LabelValue' createdBy: allOf: - $ref: '#/components/schemas/ObjectId' description: Id of the user (or the API key's owner) who created the group. createdAt: $ref: '#/components/schemas/Timestamp' updatedAt: $ref: '#/components/schemas/Timestamp' ErrorEnvelope: type: object required: - message - error properties: message: type: string description: Same as error.message. error: type: object required: - code - message properties: code: type: string enum: - VALIDATION_FAILED - UNAUTHENTICATED - FORBIDDEN_ACTION - NOT_FOUND - RATE_LIMITED - CONFLICT - INTERNAL message: type: string details: {} ObjectId: type: string pattern: ^[0-9a-fA-F]{24}$ description: A 24-character hexadecimal id. example: 66f1a8c3e4b0a1b2c3d4e5f6 LabelValue: type: object description: One label inside a group. properties: _id: type: string description: >- The label's id: a 24-character hexadecimal id, or `temp_` followed by digits on labels made by older versions of Heliyos. example: 6729d1e2f3a4b5c6d7e8f901 name: type: string description: >- The label's name, 1 to 100 characters, unique within its group (case-insensitive). example: Discount request Timestamp: type: string format: date-time description: An ISO 8601 date-time in UTC. example: '2026-11-04T09:30:00.000Z' securitySchemes: bearerAuth: type: http scheme: bearer description: >- A workspace API key, sent as `Authorization: Bearer heliyos_...`. Create one in Heliyos under Settings → API keys. A key acts as a workspace admin in the one workspace it was created in. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.