Stage

A descriptor of the point in the process, used for categorizing Prospects.

color
string <= 255 characters

The color the stage label will be highlighted in the interface, specified as a hexidecimal value (e.g. "#5951ff").

createdAt
string <date-time>

The date and time the stage was created.

name
string <= 255 characters

The name of the stage (e.g. "Qualified Lead").

order
integer

The stage's display order within the collection.

updatedAt
string <date-time>

The date and time the stage was last updated.

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

Stage Relationships

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

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

Array of links (object) (prospect)

The prospects associated to the stage. You can use only the attribute id to filter stages by prospects (e.g. filter[prospects][id]=X).

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

The most recent updater of the stage. Relationship updater cannot be used as a filter.

{
  • "creator": {
    },
  • "prospects": [
    ],
  • "updater": {
    }
}

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

⌵ Stage Actions

Get a Collection of Stages

SecuritybearerAuth
Responses
200

OK

422

JSON error message

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


422
JSON error message


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


422
JSON error message


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


404
Not Found


get/stages/{id}
Request samples 
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}
Update a 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/stages/{id}
Request samples 
application/vnd.api+json
{
  • "data": {
    }
}
Response samples 
application/vnd.api+json
{
  • "data": {
    }
}