---
title: "Update an opportunity"
method: POST
path: "/v1/opportunities/{id}"
---

# Update an opportunity

`POST /v1/opportunities/{id}`

Updates an existing opportunity by ID. Only included fields and relationships are modified.

The `$opportunityStatus` field is read-only and cannot be updated. The `$task`, `$note`, and `$meeting` relationships are also read-only — manage them via the `$opportunity` relationship on the task, the `$account`/`$opportunity` note relationships, or via the meeting's `$contact` attendees that belong to this opportunity's account.

Supports idempotency via the `Idempotency-Key` header.

**[Required scope](/using-the-api/scopes/):** `opportunities:update`

**[Rate limit category](/using-the-api/rate-limits/):** Write

## Path parameters

- `id` string, required — Unique identifier of the opportunity to update.

## Headers

- `Lightfield-Version` '2026-03-01', required

## Request body

- object
  - `fields` union — Field values to update — only provided fields are modified; omitted fields are left unchanged. System fields use a `$` prefix (e.g. `$name`, `$stage`); custom attributes use their bare slug. `SINGLE_SELECT` and `MULTI_SELECT` fields accept an option ID or label — call the <u>[definitions endpoint](/api/resources/opportunity/methods/definitions)</u> for available options. See <u>[Fields and relationships](/using-the-api/fields-and-relationships/)</u> for value type details.
    - object
      - `$name` string, nullable — Display name of the opportunity.
      - `$stage` string, nullable — Pipeline stage (`SINGLE_SELECT`). Pass the option ID or label from the field definition.
    - object
  - `relationships` union — Relationship operations to apply. System relationships use a `$` prefix (e.g. `$owner`, `$champion`). Each value is an operation object with `add`, `remove`, or `replace`.
    - object
      - `$owner` object — Operation to modify the opportunity owner.
        - `add` union — Entity ID(s) to add to the relationship.
          - string
          - string[]
        - `remove` union — Entity ID(s) to remove from the relationship.
          - string
          - string[]
        - `replace` union — Entity ID(s) to set as the relationship replacement, or null to clear supported relationships.
          - string
          - string[]
      - `$champion` object — Operation to modify the internal champion.
        - `add` union — Entity ID(s) to add to the relationship.
          - string
          - string[]
        - `remove` union — Entity ID(s) to remove from the relationship.
          - string
          - string[]
        - `replace` union — Entity ID(s) to set as the relationship replacement, or null to clear supported relationships.
          - string
          - string[]
      - `$evaluator` object — Operation to modify the evaluator.
        - `add` union — Entity ID(s) to add to the relationship.
          - string
          - string[]
        - `remove` union — Entity ID(s) to remove from the relationship.
          - string
          - string[]
        - `replace` union — Entity ID(s) to set as the relationship replacement, or null to clear supported relationships.
          - string
          - string[]
      - `$files` object — Operation to add or remove file attachments.
        - `add` union — File ID(s) to attach to this record.
          - string
          - string[]
        - `remove` union — File ID(s) to detach from this record.
          - string
          - string[]
      - `$opportunity-slack-channel` object — Operation to link or unlink Slack channels. Values are Lightfield channel IDs (prefixed `chn_`); linked channels must belong to the organization’s connected Slack workspace.
        - `add` union — Entity ID(s) to add to the relationship.
          - string
          - string[]
        - `remove` union — Entity ID(s) to remove from the relationship.
          - string
          - string[]
        - `replace` union — Entity ID(s) to set as the relationship replacement, or null to clear supported relationships.
          - string
          - string[]
    - object

## Response `200`

OK

- OpportunityUpdateResponse
  - `id` string, required — Unique identifier for the entity.
  - `createdAt` string, required — ISO 8601 timestamp of when the entity was created.
  - `updatedAt` string, nullable, required — ISO 8601 timestamp of when the entity was last updated, or null.
  - `httpLink` string, nullable, required — URL to view the entity in the Lightfield web app, or null.
  - `externalId` string, nullable — External identifier for the entity, or null if unset.
  - `fields` object, required — Map of field names to their typed values. System fields are prefixed with `$` (e.g. `$name`, `$email`); custom attributes use their bare slug.
  - `relationships` object, required — Map of relationship names to their associated entities. System relationships are prefixed with `$` (e.g. `$owner`, `$contact`).

## Other responses

- `400` — 400
- `401` — 401
- `403` — 403
- `404` — 404
- `409` — 409
- `415` — 415
- `422` — 422
- `429` — 429
- `500` — 500
- `501` — 501
- `503` — 503
- `504` — 504

---

[API](https://skmtc.net/lightfld/apis/api-reference.md) · [All operations](https://skmtc.net/lightfld/apis/api-reference/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/lightfld/api-reference/versions/93b6c5de5463/schema)