Skip to main content

Create Opportunity

POST 
/v1/crm/opportunity/create

Requires the standard__opportunity_pipeline_id field (get a valid pipeline id from the List Pipelines endpoint) and standard__opportunity_name. The opportunity stage (standard__opportunity_calculated_stage_id) cannot be set directly; it is calculated from the opportunity field values. To place a deal in a stage, set standard__opportunity_probability (a float from 0 to 1) so the opportunity matches that stage filter (see the pipeline stages); standard__opportunity_status is read-only and derived from probability (0 = Closed Lost, 1 = Closed Won, anything else = Open), and probability defaults to 0.1 when omitted. standard__opportunity_amount is a currency value. Discover the exact standard__ field external IDs via the field schema for object type Opportunity. ownerId defaults to the calling user, so a service-account caller that omits it creates an opportunity with no owner, which owner-scoped list and query calls then cannot see; such a caller can set the owner explicitly by putting a user id, or that user's email address, in crmObject.ownerId, and a value resolving to no user fails with INVALID_ARGUMENT. A user-token caller behaves differently: ownerId is resolved as a user id only, an email is not accepted, and anything that fails to resolve falls back to the calling user with no error.

Request​

Responses​

A successful response.