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 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:update

Rate limit category: Write

Path ParametersExpand Collapse

id: string

Unique identifier of the opportunity to update.

Body ParametersJSONExpand Collapse

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

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

One of the following:

Typed object { "$name", "$stage" }

"$name": optional string

Display name of the opportunity.

"$stage": optional string

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

Untyped = map[string or number or boolean or 3 more]

One of the following:

string

number

boolean

array of string

Address object { city, country, latitude, 5 more }

city: optional string

City name.

country: optional string

2-letter ISO 3166-1 alpha-2 country code.

latitude: optional number

Latitude coordinate.

longitude: optional number

Longitude coordinate.

postalCode: optional string

Postal or ZIP code.

state: optional string

State or province.

street: optional string

Street address line 1.

street2: optional string

Street address line 2.

FullName object { firstName, lastName }

firstName: optional string

The contact’s first name.

lastName: optional string

The contact’s last name.

relationships: optional object { "$champion", "$evaluator", "$owner" } or map[object { add, remove, replace } ]

Relationship operations to apply. System relationships use a $ prefix (e.g. $owner, $champion). Each value is an operation object with add, remove, or replace.

One of the following:

Typed object { "$champion", "$evaluator", "$owner" }

"$champion": optional object { add, remove, replace }

Operation to modify the internal champion.

add: optional string or array of string

Entity ID(s) to add to the relationship.

One of the following:

string

array of string

remove: optional string or array of string

Entity ID(s) to remove from the relationship.

One of the following:

string

array of string

replace: optional string or array of string

Entity ID(s) to set as the entire relationship, replacing all existing associations.

One of the following:

string

array of string

"$evaluator": optional object { add, remove, replace }

Operation to modify the evaluator.

add: optional string or array of string

Entity ID(s) to add to the relationship.

One of the following:

string

array of string

remove: optional string or array of string

Entity ID(s) to remove from the relationship.

One of the following:

string

array of string

replace: optional string or array of string

Entity ID(s) to set as the entire relationship, replacing all existing associations.

One of the following:

string

array of string

"$owner": optional object { add, remove, replace }

Operation to modify the opportunity owner.

add: optional string or array of string

Entity ID(s) to add to the relationship.

One of the following:

string

array of string

remove: optional string or array of string

Entity ID(s) to remove from the relationship.

One of the following:

string

array of string

replace: optional string or array of string

Entity ID(s) to set as the entire relationship, replacing all existing associations.

One of the following:

string

array of string

Untyped = map[object { add, remove, replace } ]

add: optional string or array of string

Entity ID(s) to add to the relationship.

One of the following:

string

array of string

remove: optional string or array of string

Entity ID(s) to remove from the relationship.

One of the following:

string

array of string

replace: optional string or array of string

Entity ID(s) to set as the entire relationship, replacing all existing associations.

One of the following:

string

array of string

ReturnsExpand Collapse

OpportunityUpdateResponse object { id, createdAt, fields, 4 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 3 more

The field value, or null if unset.

One of the following:

string

number

boolean

array of string

Address object { city, country, latitude, 5 more }

city: optional string

City name.

country: optional string

2-letter ISO 3166-1 alpha-2 country code.

latitude: optional number

Latitude coordinate.

longitude: optional number

Longitude coordinate.

postalCode: optional string

Postal or ZIP code.

state: optional string

State or province.

street: optional string

Street address line 1.

street2: optional string

Street address line 2.

FullName object { firstName, lastName }

firstName: optional string

The contact’s first name.

lastName: optional string

The contact’s last name.

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

The data type of the field.

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.

updatedAt: string

ISO 8601 timestamp of when the entity was last updated, or null.

externalId: optional string

External identifier for the entity, or null if unset.

Update an opportunity

curl https://api.lightfield.app/v1/opportunities/$ID \
    -H 'Content-Type: application/json' \
    -H 'Lightfield-Version: 2026-03-01' \
    -H "Authorization: Bearer $API_KEY" \
    -d '{}'

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

Returns Examples

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