Create an opportunity

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</u> to check if a record exists before creating.

Required scope: opportunities:create

Rate limit category: Write