Skip to main content
POST
Create a Deal from an Opportunity

Authorizations

Authorization
string
header
required

Bearer Token necessary to use API

Scopes

public.opportunity:write
Bearer
public.deal:write
Bearer
public.opportunity:write
OAuth2

Opportunity (Write)

public.deal:write
OAuth2

Deal (Write)

Headers

Idempotency-Key
string

A unique key, such as a UUID, that makes it safe to retry this request. The first successful (2xx) response for a key is stored for 24 hours and returned unchanged, including its request_id, for later requests with the same key, without running the request again. Keys are unique per operator, case-insensitive and trimmed of surrounding whitespace. Failed requests are not stored, so they can be retried with the same key. While a request with the same key is still in progress, another one returns 409 Conflict with code idempotency_conflict. The request body and path are not compared, so use a new key for each request. For more, see the documentation page.

Path Parameters

opportunity_id
string
required

The ID of the opportunity

Pattern: ^opp_

Query Parameters

expand
string[]

This endpoint supports expandable responses. For more, see the documentation page.

fields
string[]

Returns only the listed fields, such as id,status,site.name. Identifiers and constant fields such as object are always returned. A field inside an expandable association also needs it in expand, unless the collapsed association returns it, such as site.id. For more, see the documentation page.

Body

application/json

Create Deal from Opportunity Request

stage
object
required

Pipeline stage the new deal starts in.

name
string

The name of the deal. Defaults to the contact's name, or email if the contact has no name, followed by "Deal".

assignee
object | null

Staff member responsible for the new deal.

note
string | null

Free-text note for the deal. Displayed under 'Deal value estimate' in Backoffice.

metadata
object | null

Set of key-value pairs for storing additional information on the deal. Learn more about metadata.

Response

deal created from the opportunity

Single Deal

deal
object
required

Deal

meta
object
required