Opportunity Stage

The stage an opportunity is in. Requires the Opportunities SKU to be enabled in order to have access. Please contact support for more assistance.

color
string <= 255 characters

The color used to label and highlight the opportunity stage.

createdAt
string <date-time>

The date and time the opportunity stage was created.

isClosed
boolean

Either true or flase, whether or not the opportunity stage represents an open or closed state of an opportunity.

name
string <= 255 characters

The name of the opportunity stage.

order
integer

The order of the opportunity stage.

updatedAt
string <date-time>

The date and time the opportunity stage was last updated.

{
  • "color": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "isClosed": true,
  • "name": "string",
  • "order": 0,
  • "updatedAt": "2019-08-24T14:15:22Z"
}

Opportunity Stage Relationships

(user (data (object) or links (object)))

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

Array of links (object) (opportunity)

The opportunities currently associated with the opportunity stage. Relationship opportunities cannot be used as a filter.

{
  • "creator": {
    },
  • "opportunities": [
    ]
}

Opportunity Stage 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 Stage has to external sources. provideDataConnections

⌵ Opportunity Stage Actions

Get a Collection of Opportunity Stages

SecuritybearerAuth
Responses
200

OK

422

JSON error message

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


422
JSON error message


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


422
JSON error message


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


404
Not Found


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


422
JSON error message


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