Sign in

v1

latestOpenAPI 3.1.12026-07-14355311.4 MB
Opportunity

Create Opportunity

Create a new 'Opportunity' record.

post/Opportunity

Headers

X-Skip-Duplicate-Check'true' | 'false'

Skip duplicate check.

X-Duplicate-Source-Idstring

A record ID of the entity that is being duplicated.

Request body

idstring

An ID.

namestring

A one-line string.

amountnumber

A currency amount.

amountCurrency'USD' | 'EUR'

A code.

amountConvertednumber nullable

A currency amount converted to the default currency.

amountWeightedConvertednumber nullable
accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

contactsIdsstring[] nullable

IDs of records of the Contact type.

contactsNamesobject nullable

An {ID => record name} map.

contactsColumnsobject nullable

An {ID => object} map. Relationship column values.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

stage'Prospecting' | 'Qualification' | 'Proposal' | 'Negotiation' | 'Closed Won' | 'Closed Lost'
lastStagestring
probabilityinteger nullable
leadSource'Call' | 'Email' | 'Existing Customer' | 'Partner' | 'Public Relations' | 'Web Site' | 'Campaign' | 'Other' nullable
closeDatestring date

A date.

descriptionstring nullable

A multi-line text.

campaignIdstring nullable

An ID of the record of the Campaign type.

campaignNamestring nullable

A foreign record name.

originalLeadIdstring nullable

An ID of the record of the Lead type.

originalLeadNamestring nullable

A foreign record name.

contactRole'Decision Maker' | 'Evaluator' | 'Influencer' nullable
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

streamUpdatedAtstring nullable

A timestamp in UTC.

Example request

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}

Response

Success.

idstring

An ID.

namestring

A one-line string.

amountnumber

A currency amount.

amountCurrency'USD' | 'EUR'

A code.

amountConvertednumber nullable

A currency amount converted to the default currency.

amountWeightedConvertednumber nullable
accountIdstring nullable

An ID of the record of the Account type.

accountNamestring nullable

A foreign record name.

contactsIdsstring[] nullable

IDs of records of the Contact type.

contactsNamesobject nullable

An {ID => record name} map.

contactsColumnsobject nullable

An {ID => object} map. Relationship column values.

contactIdstring nullable

An ID of the record of the Contact type.

contactNamestring nullable

A foreign record name.

stage'Prospecting' | 'Qualification' | 'Proposal' | 'Negotiation' | 'Closed Won' | 'Closed Lost'
lastStagestring
probabilityinteger nullable
leadSource'Call' | 'Email' | 'Existing Customer' | 'Partner' | 'Public Relations' | 'Web Site' | 'Campaign' | 'Other' nullable
closeDatestring date

A date.

descriptionstring nullable

A multi-line text.

campaignIdstring nullable

An ID of the record of the Campaign type.

campaignNamestring nullable

A foreign record name.

originalLeadIdstring nullable

An ID of the record of the Lead type.

originalLeadNamestring nullable

A foreign record name.

contactRole'Decision Maker' | 'Evaluator' | 'Influencer' nullable
createdAtstring nullable

A timestamp in UTC.

modifiedAtstring nullable

A timestamp in UTC.

createdByIdstring nullable

An ID of the record of the User type.

createdByNamestring nullable

A foreign record name.

modifiedByIdstring nullable

An ID of the record of the User type.

modifiedByNamestring nullable

A foreign record name.

assignedUserIdstring nullable

An ID of the record of the User type.

assignedUserNamestring nullable

A foreign record name.

teamsIdsstring[] nullable

IDs of records of the Team type.

teamsNamesobject nullable

An {ID => record name} map.

streamUpdatedAtstring nullable

A timestamp in UTC.

Example response

{
  "createdAt": "2026-11-29 12:34:56",
  "modifiedAt": "2026-11-29 12:34:56",
  "streamUpdatedAt": "2026-11-29 12:34:56"
}