---
title: "Create an opportunity"
method: POST
path: "/v1/opportunities"
---

# Create an opportunity

`POST /v1/opportunities`

Creates a new opportunity record. The `$name` and `$stage` fields and the `$account` relationship are required.

After creation, Lightfield automatically generates an opportunity summary in the background. The `$opportunityStatus` field is read-only and cannot be set via the API. 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.

To avoid duplicates, we recommend a find-or-create pattern — use <u>[list filtering](/using-the-api/list-endpoints/#filtering)</u> to check if a record exists before creating.

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

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

## Headers

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

## Request body

- object
  - `fields` union, required — Field values for the new opportunity. System fields use a `$` prefix (e.g. `$name`, `$stage`); custom attributes use their bare slug. Required: `$name` (string) and `$stage` (option ID or label). Fields of type `SINGLE_SELECT` or `MULTI_SELECT` accept either an option ID or label from the field's `typeConfiguration.options` — call the <u>[definitions endpoint](/api/resources/opportunity/methods/definitions)</u> to discover available fields and options. See <u>[Fields and relationships](/using-the-api/fields-and-relationships/)</u> for value type details.
    - object
      - `$name` string, required — Display name of the opportunity.
      - `$stage` string, required — Pipeline stage (`SINGLE_SELECT`). Pass the option ID or label from the field definition.
    - object
  - `relationships` union, required — Relationships to set on the new opportunity. System relationships use a `$` prefix (e.g. `$account`, `$owner`); custom relationships use their bare slug. `$account` is required. Each value is a single entity ID or an array of IDs. Call the <u>[definitions endpoint](/api/resources/opportunity/methods/definitions)</u> to list available relationship keys.
    - object
      - `$account` union, required — ID of the account this opportunity belongs to.
        - string
        - string[]
      - `$owner` union — ID of the user who owns this opportunity.
        - string
        - string[]
      - `$createdBy` union — ID of the user who created this opportunity.
        - string
        - string[]
      - `$champion` union — ID of the contact who is the internal champion.
        - string
        - string[]
      - `$evaluator` union — ID of the contact who is the evaluator.
        - string
        - string[]
      - `$files` union — File ID(s) to attach to this opportunity. Files must be in `completed` status.
        - string
        - string[]
      - `$opportunity-slack-channel` union — Slack channel ID(s) to link to this opportunity. Pass Lightfield channel IDs (prefixed `chn_`); the channel must belong to the organization’s connected Slack workspace.
        - string
        - string[]
    - object

## Response `200`

OK

- OpportunityCreateResponse
  - `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

## Changes

- **2026-07-28** `93b6c5de5463` — 3 info
  - added the new optional request property `relationships/oneOf[subschema #1: OpportunityCreateRelationshipsTyped]/$files`
  - added the new optional request property `relationships/oneOf[subschema #1: OpportunityCreateRelationshipsTyped]/$opportunity-slack-channel`
  - added the non-success response with the status `501`
- **2026-05-21** `7b3cf2deef52` — 2 breaking, 1 warning, 3 info
  - the `fields` request property type/format changed from `object`/`` to ``/``
  - the `relationships` request property type/format changed from `object`/`` to ``/``
  - added the new `HTML` enum value to the `fields/additionalProperties/valueType` response property for the response status `200`
  - added `subschema #1: OpportunityCreateFieldsTyped, subschema #2: OpportunityCreateFieldsUntyped` to the `fields` request property `oneOf` list
  - …2 more
- **2026-04-17** `b8f139211ae6` — 4 breaking
  - removed `subschema #1: OpportunityCreateFieldsTyped, subschema #2: OpportunityCreateFieldsUntyped` from the `fields` request property `oneOf` list
  - removed `subschema #1: OpportunityCreateRelationshipsTyped, subschema #2: OpportunityCreateRelationshipsUntyped` from the `relationships` request property `oneOf` list
  - the `fields` request property type/format changed from ``/`` to `object`/``
  - the `relationships` request property type/format changed from ``/`` to `object`/``
- …earlier changes not shown

[Full history](https://skmtc.dev/lightfld/apis/api-reference/changes/v1/opportunities/post.md)

---

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