API Reference

Opportunity

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

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 and $note relationships are also read-only — manage them via the $opportunity relationship on the task, or the $account/$opportunity note relationships instead.

Supports idempotency via the Idempotency-Key header.

Required scope: opportunities:create

Rate limit category: Write

Body ParametersJSONExpand Collapse

fields: object { "$name", "$stage" } or map[string or number or boolean or 2 more]

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 definitions endpoint to discover available fields and options. See Fields and relationships for value type details.

Accepts one of the following:

UnionMember0 = object { "$name", "$stage" }

"$name": string

Display name of the opportunity.

"$stage": string

Pipeline stage (SINGLE_SELECT). Pass the option ID or label from the field definition.

UnionMember1 = map[string or number or boolean or 2 more]

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = array of string or number or boolean or 2 more

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = array of unknown

UnionMember4 = map[unknown]

UnionMember4 = map[string or number or boolean or 2 more]

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = array of unknown

UnionMember4 = map[unknown]

relationships: object { "$account", "$champion", "$createdBy", 2 more } or map[string or array of string]

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 definitions endpoint to list available relationship keys.

Accepts one of the following:

UnionMember0 = object { "$account", "$champion", "$createdBy", 2 more }

"$account": string or array of string

ID of the account this opportunity belongs to.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

"$champion": optional string or array of string

ID of the contact who is the internal champion.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

"$createdBy": optional string or array of string

ID of the user who created this opportunity.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

"$evaluator": optional string or array of string

ID of the contact who is the evaluator.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

"$owner": optional string or array of string

ID of the user who owns this opportunity.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

UnionMember1 = map[string or array of string]

Accepts one of the following:

UnionMember0 = string

UnionMember1 = array of string

ReturnsExpand Collapse

OpportunityCreateResponse = object { id, createdAt, fields, 2 more }

id: string

Unique identifier for the entity.

createdAt: string

ISO 8601 timestamp of when the entity was created.

fields: map[object { value, valueType } ]

Map of field names to their typed values. System fields are prefixed with $ (e.g. $name, $email); custom attributes use their bare slug.

value: string or number or boolean or 2 more

The field value, or null if unset.

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = array of string or number or boolean or 2 more

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = array of unknown

UnionMember4 = map[unknown]

UnionMember4 = map[string or number or boolean or 2 more]

Accepts one of the following:

UnionMember0 = string

UnionMember1 = number

UnionMember2 = boolean

UnionMember3 = array of unknown

UnionMember4 = map[unknown]

valueType: "ADDRESS" or "CHECKBOX" or "CURRENCY" or 11 more

The data type of the field.

Accepts one of the following:

"ADDRESS"

"CHECKBOX"

"CURRENCY"

"DATETIME"

"EMAIL"

"FULL_NAME"

"MARKDOWN"

"MULTI_SELECT"

"NUMBER"

"SINGLE_SELECT"

"SOCIAL_HANDLE"

"TELEPHONE"

"TEXT"

"URL"

httpLink: string

URL to view the entity in the Lightfield web app, or null.

relationships: map[object { cardinality, objectType, values } ]

Map of relationship names to their associated entities. System relationships are prefixed with $ (e.g. $owner, $contact).

cardinality: string

Whether the relationship is has_one or has_many.

objectType: string

The type of the related object (e.g. account, contact).

values: array of string

IDs of the related entities.

Create an opportunity

HTTP

HTTP

Python

curl https://api.lightfield.app/v1/opportunities \
    -H 'Content-Type: application/json' \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY" \
    -d '{
          "fields": {
            "$name": "$name",
            "$stage": "$stage"
          },
          "relationships": {
            "$account": "string"
          }
        }'

200 example

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  }
}

Returns Examples

200 example

{
  "id": "id",
  "createdAt": "createdAt",
  "fields": {
    "foo": {
      "value": "string",
      "valueType": "ADDRESS"
    }
  },
  "httpLink": "httpLink",
  "relationships": {
    "foo": {
      "cardinality": "cardinality",
      "objectType": "objectType",
      "values": [
        "string"
      ]
    }
  }
}