Opportunity

An opportunity for a sale or pending deal. Requires the Opportunities SKU to be enabled in order to have access. Please contact support for more assistance.

amount
integer or null

The amount the opportunity is worth.

amountPrecise
string or null <= 15 characters

The precise amount that the opportunity is worth.

closeDate
string or null <date-time>

The date the opportunity is expected to close.

createdAt
string or null <date-time>

The date the opportunity was created.

currencyType
string or null <= 255 characters

The ISO code of the currency this opportunity is in.

custom1
string or null <= 32000 characters

The value of the opportunity's first custom field.

custom2
string or null <= 32000 characters

The value of the opportunity's second custom field.

custom3
string or null <= 32000 characters

The value of the opportunity's third custom field.

custom4
string or null <= 32000 characters

The value of the opportunity's fourth custom field.

custom5
string or null <= 32000 characters

The value of the opportunity's fifth custom field.

custom6
string or null <= 32000 characters

The value of the opportunity's sixth custom field.

custom7
string or null <= 32000 characters

The value of the opportunity's seventh custom field.

custom8
string or null <= 32000 characters

The value of the opportunity's eighth custom field.

custom9
string or null <= 32000 characters

The value of the opportunity's ninth custom field.

custom10
string or null <= 32000 characters

The value of the opportunity's 10th custom field.

custom11
string or null <= 32000 characters

The value of the opportunity's 11th custom field.

custom12
string or null <= 32000 characters

The value of the opportunity's 12th custom field.

custom13
string or null <= 32000 characters

The value of the opportunity's 13th custom field.

custom14
string or null <= 32000 characters

The value of the opportunity's 14th custom field.

custom15
string or null <= 32000 characters

The value of the opportunity's 15th custom field.

custom16
string or null <= 32000 characters

The value of the opportunity's 16th custom field.

custom17
string or null <= 32000 characters

The value of the opportunity's 17th custom field.

custom18
string or null <= 32000 characters

The value of the opportunity's 18th custom field.

custom19
string or null <= 32000 characters

The value of the opportunity's 19th custom field.

custom20
string or null <= 32000 characters

The value of the opportunity's 20th custom field.

custom21
string or null <= 32000 characters

The value of the opportunity's 21st custom field.

custom22
string or null <= 32000 characters

The value of the opportunity's 22nd custom field.

custom23
string or null <= 32000 characters

The value of the opportunity's 23rd custom field.

custom24
string or null <= 32000 characters

The value of the opportunity's 24th custom field.

custom25
string or null <= 32000 characters

The value of the opportunity's 25th custom field.

custom26
string or null <= 32000 characters

The value of the opportunity's 26th custom field.

custom27
string or null <= 32000 characters

The value of the opportunity's 27th custom field.

custom28
string or null <= 32000 characters

The value of the opportunity's 28th custom field.

custom29
string or null <= 32000 characters

The value of the opportunity's 29th custom field.

custom30
string or null <= 32000 characters

The value of the opportunity's 30th custom field.

custom31
string or null <= 32000 characters

The value of the opportunity's 31st custom field.

custom32
string or null <= 32000 characters

The value of the opportunity's 32nd custom field.

custom33
string or null <= 32000 characters

The value of the opportunity's 33rd custom field.

custom34
string or null <= 32000 characters

The value of the opportunity's 34th custom field.

custom35
string or null <= 32000 characters

The value of the opportunity's 35th custom field.

custom36
string or null <= 32000 characters

The value of the opportunity's 36th custom field.

custom37
string or null <= 32000 characters

The value of the opportunity's 37th custom field.

custom38
string or null <= 32000 characters

The value of the opportunity's 38th custom field.

custom39
string or null <= 32000 characters

The value of the opportunity's 39th custom field.

custom40
string or null <= 32000 characters

The value of the opportunity's 40th custom field.

custom41
string or null <= 32000 characters

The value of the opportunity's 41st custom field.

custom42
string or null <= 32000 characters

The value of the opportunity's 42nd custom field.

custom43
string or null <= 32000 characters

The value of the opportunity's 43rd custom field.

custom44
string or null <= 32000 characters

The value of the opportunity's 44th custom field.

custom45
string or null <= 32000 characters

The value of the opportunity's 45th custom field.

custom46
string or null <= 32000 characters

The value of the opportunity's 46th custom field.

custom47
string or null <= 32000 characters

The value of the opportunity's 47th custom field.

custom48
string or null <= 32000 characters

The value of the opportunity's 48th custom field.

custom49
string or null <= 32000 characters

The value of the opportunity's 49th custom field.

custom50
string or null <= 32000 characters

The value of the opportunity's 50th custom field.

custom51
string or null <= 32000 characters

The value of the opportunity's 51st custom field.

custom52
string or null <= 32000 characters

The value of the opportunity's 52nd custom field.

custom53
string or null <= 32000 characters

The value of the opportunity's 53rd custom field.

custom54
string or null <= 32000 characters

The value of the opportunity's 54th custom field.

custom55
string or null <= 32000 characters

The value of the opportunity's 55th custom field.

custom56
string or null <= 32000 characters

The value of the opportunity's 56th custom field.

custom57
string or null <= 32000 characters

The value of the opportunity's 57th custom field.

custom58
string or null <= 32000 characters

The value of the opportunity's 58th custom field.

custom59
string or null <= 32000 characters

The value of the opportunity's 59th custom field.

custom60
string or null <= 32000 characters

The value of the opportunity's 60th custom field.

custom61
string or null <= 32000 characters

The value of the opportunity's 61st custom field.

custom62
string or null <= 32000 characters

The value of the opportunity's 62nd custom field.

custom63
string or null <= 32000 characters

The value of the opportunity's 63rd custom field.

custom64
string or null <= 32000 characters

The value of the opportunity's 64th custom field.

custom65
string or null <= 32000 characters

The value of the opportunity's 65th custom field.

custom66
string or null <= 32000 characters

The value of the opportunity's 66th custom field.

custom67
string or null <= 32000 characters

The value of the opportunity's 67th custom field.

custom68
string or null <= 32000 characters

The value of the opportunity's 68th custom field.

custom69
string or null <= 32000 characters

The value of the opportunity's 69th custom field.

custom70
string or null <= 32000 characters

The value of the opportunity's 70th custom field.

custom71
string or null <= 32000 characters

The value of the opportunity's 71st custom field.

custom72
string or null <= 32000 characters

The value of the opportunity's 72nd custom field.

custom73
string or null <= 32000 characters

The value of the opportunity's 73rd custom field.

custom74
string or null <= 32000 characters

The value of the opportunity's 74th custom field.

custom75
string or null <= 32000 characters

The value of the opportunity's 75th custom field.

custom76
string or null <= 32000 characters

The value of the opportunity's 76th custom field.

custom77
string or null <= 32000 characters

The value of the opportunity's 77th custom field.

custom78
string or null <= 32000 characters

The value of the opportunity's 78th custom field.

custom79
string or null <= 32000 characters

The value of the opportunity's 79th custom field.

custom80
string or null <= 32000 characters

The value of the opportunity's 80th custom field.

custom81
string or null <= 32000 characters

The value of the opportunity's 81st custom field.

custom82
string or null <= 32000 characters

The value of the opportunity's 82nd custom field.

custom83
string or null <= 32000 characters

The value of the opportunity's 83rd custom field.

custom84
string or null <= 32000 characters

The value of the opportunity's 84th custom field.

custom85
string or null <= 32000 characters

The value of the opportunity's 85th custom field.

custom86
string or null <= 32000 characters

The value of the opportunity's 86th custom field.

custom87
string or null <= 32000 characters

The value of the opportunity's 87th custom field.

custom88
string or null <= 32000 characters

The value of the opportunity's 88th custom field.

custom89
string or null <= 32000 characters

The value of the opportunity's 89th custom field.

custom90
string or null <= 32000 characters

The value of the opportunity's 90th custom field.

custom91
string or null <= 32000 characters

The value of the opportunity's 91st custom field.

custom92
string or null <= 32000 characters

The value of the opportunity's 92nd custom field.

custom93
string or null <= 32000 characters

The value of the opportunity's 93rd custom field.

custom94
string or null <= 32000 characters

The value of the opportunity's 94th custom field.

custom95
string or null <= 32000 characters

The value of the opportunity's 95th custom field.

custom96
string or null <= 32000 characters

The value of the opportunity's 96th custom field.

custom97
string or null <= 32000 characters

The value of the opportunity's 97th custom field.

custom98
string or null <= 32000 characters

The value of the opportunity's 98th custom field.

custom99
string or null <= 32000 characters

The value of the opportunity's 99th custom field.

custom100
string or null <= 32000 characters

The value of the opportunity's 100th custom field.

custom101
string or null <= 32000 characters

The value of the opportunity’s 101st custom field.

custom102
string or null <= 32000 characters

The value of the opportunity’s 102nd custom field.

custom103
string or null <= 32000 characters

The value of the opportunity’s 103rd custom field.

custom104
string or null <= 32000 characters

The value of the opportunity’s 104th custom field.

custom105
string or null <= 32000 characters

The value of the opportunity’s 105th custom field.

custom106
string or null <= 32000 characters

The value of the opportunity’s 106th custom field.

custom107
string or null <= 32000 characters

The value of the opportunity’s 107th custom field.

custom108
string or null <= 32000 characters

The value of the opportunity’s 108th custom field.

custom109
string or null <= 32000 characters

The value of the opportunity’s 109th custom field.

custom110
string or null <= 32000 characters

The value of the opportunity’s 110th custom field.

custom111
string or null <= 32000 characters

The value of the opportunity’s 111th custom field.

custom112
string or null <= 32000 characters

The value of the opportunity’s 112th custom field.

custom113
string or null <= 32000 characters

The value of the opportunity’s 113th custom field.

custom114
string or null <= 32000 characters

The value of the opportunity’s 114th custom field.

custom115
string or null <= 32000 characters

The value of the opportunity’s 115th custom field.

custom116
string or null <= 32000 characters

The value of the opportunity’s 116th custom field.

custom117
string or null <= 32000 characters

The value of the opportunity’s 117th custom field.

custom118
string or null <= 32000 characters

The value of the opportunity’s 118th custom field.

custom119
string or null <= 32000 characters

The value of the opportunity’s 119th custom field.

custom120
string or null <= 32000 characters

The value of the opportunity’s 120th custom field.

custom121
string or null <= 32000 characters

The value of the opportunity’s 121st custom field.

custom122
string or null <= 32000 characters

The value of the opportunity’s 122nd custom field.

custom123
string or null <= 32000 characters

The value of the opportunity’s 123rd custom field.

custom124
string or null <= 32000 characters

The value of the opportunity’s 124th custom field.

custom125
string or null <= 32000 characters

The value of the opportunity’s 125th custom field.

custom126
string or null <= 32000 characters

The value of the opportunity’s 126th custom field.

custom127
string or null <= 32000 characters

The value of the opportunity’s 127th custom field.

custom128
string or null <= 32000 characters

The value of the opportunity’s 128th custom field.

custom129
string or null <= 32000 characters

The value of the opportunity’s 129th custom field.

custom130
string or null <= 32000 characters

The value of the opportunity’s 130th custom field.

custom131
string or null <= 32000 characters

The value of the opportunity’s 131st custom field.

custom132
string or null <= 32000 characters

The value of the opportunity’s 132nd custom field.

custom133
string or null <= 32000 characters

The value of the opportunity’s 133rd custom field.

custom134
string or null <= 32000 characters

The value of the opportunity’s 134th custom field.

custom135
string or null <= 32000 characters

The value of the opportunity’s 135th custom field.

custom136
string or null <= 32000 characters

The value of the opportunity’s 136th custom field.

custom137
string or null <= 32000 characters

The value of the opportunity’s 137th custom field.

custom138
string or null <= 32000 characters

The value of the opportunity’s 138th custom field.

custom139
string or null <= 32000 characters

The value of the opportunity’s 139th custom field.

custom140
string or null <= 32000 characters

The value of the opportunity’s 140th custom field.

custom141
string or null <= 32000 characters

The value of the opportunity’s 141st custom field.

custom142
string or null <= 32000 characters

The value of the opportunity’s 142nd custom field.

custom143
string or null <= 32000 characters

The value of the opportunity’s 143rd custom field.

custom144
string or null <= 32000 characters

The value of the opportunity’s 144th custom field.

custom145
string or null <= 32000 characters

The value of the opportunity’s 145th custom field.

custom146
string or null <= 32000 characters

The value of the opportunity’s 146th custom field.

custom147
string or null <= 32000 characters

The value of the opportunity’s 147th custom field.

custom148
string or null <= 32000 characters

The value of the opportunity’s 148th custom field.

custom149
string or null <= 32000 characters

The value of the opportunity’s 149th custom field.

custom150
string or null <= 32000 characters

The value of the opportunity’s 150th custom field.

customId
string or null <= 255 characters

A custom ID for the opportunity, often referencing an ID in an external system.

description
string or null <= 65535 characters

A description of the opportunity.

externalCreatedAt
string or null <date-time>

The date the opportunity was created in the external system.

forecastCategory
string or null <= 32000 characters

The category or classification used to predict the likelihood of closing an opportunity.

leadSource
string or null <= 32000 characters

Source of this opportunity, such as Advertisement or Trade Show

lostReason
string or null <= 32000 characters

The reason why an opportunity or deal was lost.

mapLink
string or null <= 255 characters

A link to the SamePlan MAP (Mutual Action Plan) associated with this opportunity.

mapNextSteps
string or null <= 255 characters

The next event in the timeline that has yet to be completed for the SamePlan MAP (Mutual Action Plan).

mapStatus
string or null <= 255 characters

The status of the SamePlan MAP (Mutual Action Plan) based on how well both parties are trending towards the plan.

name
string or null <= 255 characters

The name of the opportunity.

nextStep
string or null <= 65535 characters

The next step to take for the opportunity.

opportunityType
string or null <= 255 characters

The type of opportunity.

probability
integer or null

The chances of the opportunity succeeding, represented as a percentage.

prospectingRepId
string or null <= 255 characters

The ID of the sales rep that prospects the opportunity.

recordType
string or null <= 32000 characters

The type or category of the record, such as Opportunity, Lead, or Deal, used to classify and organize different stages in the sales process

sharingTeamId
string or null <= 255 characters

The ID of the sharing team associated with this object. Access is currently in beta.

tags
Array of strings or null

Tags associated with the opportunity.

touchedAt
string or null <date-time>

The last time an event happened for an opportunity.

trashedAt
string or null <date-time>

The date a prospect was soft deleted.

updatedAt
string or null <date-time>

The date the opportunity was last updated.

{
  • "amount": 0,
  • "amountPrecise": "string",
  • "closeDate": "2019-08-24T14:15:22Z",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "currencyType": "string",
  • "custom1": "string",
  • "custom2": "string",
  • "custom3": "string",
  • "custom4": "string",
  • "custom5": "string",
  • "custom6": "string",
  • "custom7": "string",
  • "custom8": "string",
  • "custom9": "string",
  • "custom10": "string",
  • "custom11": "string",
  • "custom12": "string",
  • "custom13": "string",
  • "custom14": "string",
  • "custom15": "string",
  • "custom16": "string",
  • "custom17": "string",
  • "custom18": "string",
  • "custom19": "string",
  • "custom20": "string",
  • "custom21": "string",
  • "custom22": "string",
  • "custom23": "string",
  • "custom24": "string",
  • "custom25": "string",
  • "custom26": "string",
  • "custom27": "string",
  • "custom28": "string",
  • "custom29": "string",
  • "custom30": "string",
  • "custom31": "string",
  • "custom32": "string",
  • "custom33": "string",
  • "custom34": "string",
  • "custom35": "string",
  • "custom36": "string",
  • "custom37": "string",
  • "custom38": "string",
  • "custom39": "string",
  • "custom40": "string",
  • "custom41": "string",
  • "custom42": "string",
  • "custom43": "string",
  • "custom44": "string",
  • "custom45": "string",
  • "custom46": "string",
  • "custom47": "string",
  • "custom48": "string",
  • "custom49": "string",
  • "custom50": "string",
  • "custom51": "string",
  • "custom52": "string",
  • "custom53": "string",
  • "custom54": "string",
  • "custom55": "string",
  • "custom56": "string",
  • "custom57": "string",
  • "custom58": "string",
  • "custom59": "string",
  • "custom60": "string",
  • "custom61": "string",
  • "custom62": "string",
  • "custom63": "string",
  • "custom64": "string",
  • "custom65": "string",
  • "custom66": "string",
  • "custom67": "string",
  • "custom68": "string",
  • "custom69": "string",
  • "custom70": "string",
  • "custom71": "string",
  • "custom72": "string",
  • "custom73": "string",
  • "custom74": "string",
  • "custom75": "string",
  • "custom76": "string",
  • "custom77": "string",
  • "custom78": "string",
  • "custom79": "string",
  • "custom80": "string",
  • "custom81": "string",
  • "custom82": "string",
  • "custom83": "string",
  • "custom84": "string",
  • "custom85": "string",
  • "custom86": "string",
  • "custom87": "string",
  • "custom88": "string",
  • "custom89": "string",
  • "custom90": "string",
  • "custom91": "string",
  • "custom92": "string",
  • "custom93": "string",
  • "custom94": "string",
  • "custom95": "string",
  • "custom96": "string",
  • "custom97": "string",
  • "custom98": "string",
  • "custom99": "string",
  • "custom100": "string",
  • "custom101": "string",
  • "custom102": "string",
  • "custom103": "string",
  • "custom104": "string",
  • "custom105": "string",
  • "custom106": "string",
  • "custom107": "string",
  • "custom108": "string",
  • "custom109": "string",
  • "custom110": "string",
  • "custom111": "string",
  • "custom112": "string",
  • "custom113": "string",
  • "custom114": "string",
  • "custom115": "string",
  • "custom116": "string",
  • "custom117": "string",
  • "custom118": "string",
  • "custom119": "string",
  • "custom120": "string",
  • "custom121": "string",
  • "custom122": "string",
  • "custom123": "string",
  • "custom124": "string",
  • "custom125": "string",
  • "custom126": "string",
  • "custom127": "string",
  • "custom128": "string",
  • "custom129": "string",
  • "custom130": "string",
  • "custom131": "string",
  • "custom132": "string",
  • "custom133": "string",
  • "custom134": "string",
  • "custom135": "string",
  • "custom136": "string",
  • "custom137": "string",
  • "custom138": "string",
  • "custom139": "string",
  • "custom140": "string",
  • "custom141": "string",
  • "custom142": "string",
  • "custom143": "string",
  • "custom144": "string",
  • "custom145": "string",
  • "custom146": "string",
  • "custom147": "string",
  • "custom148": "string",
  • "custom149": "string",
  • "custom150": "string",
  • "customId": "string",
  • "description": "string",
  • "externalCreatedAt": "2019-08-24T14:15:22Z",
  • "forecastCategory": "string",
  • "leadSource": "string",
  • "lostReason": "string",
  • "mapLink": "string",
  • "mapNextSteps": "string",
  • "mapStatus": "string",
  • "name": "string",
  • "nextStep": "string",
  • "opportunityType": "string",
  • "probability": 0,
  • "prospectingRepId": "string",
  • "recordType": "string",
  • "sharingTeamId": "string",
  • "tags": [
    ],
  • "touchedAt": "2019-08-24T14:15:22Z",
  • "trashedAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Opportunity Relationships

object

The account the opportunity is for. You can use attributes id and name to filter opportunities by account (e.g. filter[account][id]=X).

object
object
object

The creator of the opportunity. Relationship creator cannot be used as a filter.

object

The default plugin mapping associated with the opportunity. If no plugin mapping is enabled, it will return the first plugin mapping associated with the opportunity.

object
object

The opportunity favorited by the user.

object

The factors related to the opportunities health.

object

The products associated with opportunity.

object

The current stage of the opportunity. You can use only the attribute id to filter opportunities by stage (e.g. filter[stage][id]=X).

object

The user who owns the opportunity. You can use only the attribute id to filter opportunities by owner (e.g. filter[owner][id]=X).

object
object

The prospects associated with this opportunity. You can use only the attribute id to filter opportunities by prospects (e.g. filter[prospects][id]=X).

object

The current stage of the opportunity. You can use only the attribute id to filter opportunities by stage (e.g. filter[stage][id]=X).

object

The territory of the opportunity. You can use attributes id and name to filter opportunities by territory (e.g. filter[territory][id]=X).

object

The updater of the opportunity. Relationship updater cannot be used as a filter.

{
  • "account": {},
  • "assignedTeams": {},
  • "assignedUsers": {},
  • "creator": {},
  • "defaultPluginMapping": {},
  • "externalCreator": {},
  • "favorites": {},
  • "opportunityHealthFactors": {
    },
  • "opportunityLineItems": {
    },
  • "opportunityStage": {},
  • "owner": {},
  • "primaryProspect": {},
  • "prospects": {},
  • "stage": {},
  • "territory": {},
  • "updater": {}
}

Opportunity Resource Metadata

METADATA NAME DESCRIPTION QUERY PARAM
canWrite A boolean value indicating whether the current API user has write access to this resource. provideAuthorizationMeta
canDelete A boolean value indicating whether the current API user has delete access to this resource. provideAuthorizationMeta
dataConnections The set of connections a given Opportunity has to external sources. provideDataConnections

⌵ Opportunity Actions

Get a Collection of Opportunities

SecuritybearerAuth and s2sAuthToken
Responses
200

OK

422

JSON error message

get/opportunities
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": [
    ]
}
Create a New Opportunity
SecuritybearerAuth and s2sAuthToken 
Request 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
201
Created


422
JSON error message


post/opportunities
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Delete an Existing Opportunity by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
204
Deleted


422
JSON error message


delete/opportunities/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "errors": [
    ]
}
Get an Opportunity by ID
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Responses 
200
OK


404
Not Found


get/opportunities/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update an Opportunity
SecuritybearerAuth and s2sAuthToken 
Request 
path Parameters
id
required
integer
 
Request Body schema: application/vnd.api+json
required
object
 
Responses 
200
OK


422
JSON error message


patch/opportunities/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}