v19

latestOpenAPI 3.1.1raw.githubusercontent.com2026-08-017489931.2 KB

Update an opportunity

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

Rate limit category: Write

post/v1/opportunities/{id}

Path parameters

idstring required

Unique identifier of the opportunity to update.

Headers

Lightfield-Version'2026-03-01' required

Required API version header. Requests may error without it.

Request body

Response

idstring required

Unique identifier for the entity.

createdAtstring required

ISO 8601 timestamp of when the entity was created.

updatedAtstring nullable required

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

httpLinkstring nullable required

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

externalIdstring nullable

External identifier for the entity, or null if unset.

fieldsobject required

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

relationshipsobject required

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