Skip to main content
POST
Create opportunity

Authorizations

Authorization
string
header
required

Partner OAuth2 flows for integration API access tokens. Claude MCP custom connectors use authorization code with PKCE S256.

FlowAuthorization Code
Authorization URL
/api/v1/oauth/authorize
Token URL
/api/v1/oauth/token
FlowClient Credentials
Token URL
/api/v1/oauth/token
Scopes1
opportunities:write
Create and update opportunities.

Headers

X-Organization-Id
string<uuid>

Active organization UUID. Required for authenticated requests when the principal has access to multiple organizations.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Query Parameters

organizationId
string<uuid>

Read-only convenience alias for X-Organization-Id. Legacy subscriberId query param is also accepted.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$

Body

application/json
partnerId
string<uuid>
required

Partner account UUID (UI "Partner Name"). Required — the partner this opportunity is attributed to.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
name
string
required
Required string length: 1 - 120
stageName
string
required
accountId
string<uuid>

Account the deal is with (the prospect or customer). Optional; use listAccounts or createAccount to find it.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
buyingGroupId
string<uuid>

Optional. Must belong to accountId (or partnerId for legacy data). No group is assigned when omitted.

Pattern: ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}$
crmId
string
Pattern: \b[0-9A-Za-z]{15,18}\b
description
string
amount
string
closeDate
string<date>
ownerEmail
string<email>
sfOwner
string

Response

Created opportunity.

opportunity
object
required