Create a stage

POST  https://:account.api-us1.com/api/3/dealStages

• JSON

{
  "dealStage": {
    "cardRegion1": "title",
    "cardRegion2": "next-action",
    "cardRegion3": "show-avatar",
    "cardRegion4": "contact-fullname-orgname",
    "cardRegion5": "value",
    "color": "32B0FC",
    "dealOrder": "next-action DESC",
    "group": "4",
    "order": 1,
    "title": "Initial Contact",
    "width": 360
  }
}

 

200 OK

{
  "dealStage": {
    "cardRegion1": "title",
    "cardRegion2": "next-action",
    "cardRegion3": "show-avatar",
    "cardRegion4": "contact-fullname-orgname",
    "cardRegion5": "value",
    "cdate": "2017-03-01T15:55:58-06:00",
    "color": "32B0FC",
    "dealOrder": "next-action DESC",
    "group": "4",
    "id": "16",
    "links": {
      "group": "/api/3/dealStages/16/group"
    },
    "order": 1,
    "title": "Initial Contact",
    "udate": "2017-03-01T15:55:58-06:00",
    "width": 280
  }
}

QUERY PARAMS

reorder

int32                                          Whether to reorder stages within the pipeline after creating a new deal stage. Can be one of 0 and 1. If set to 1, new order values will be assigned to all stages within the same pipeline. If deal stages with the same order exists, the stage with the highest id will be assigned with the lowest order

BODY PARAMS

dealStage

object

 

dealStage.title                            REQUIRED

string                                          Deal stage's title

 

dealStage.group                         REQUIRED

string                                          Deal stage's pipeline id

 

dealStage.order

int32                                           Order of the deal stage. If more than one deal stage share the same order value, the order of those deal stages may not be always the same. If dealStage.order is not provided, the order is assigned with (the highest order of deal stages within the same pipeline) + 1

dealStage.dealOrder

string                                         Option and direction to be used to sort deals in the deal stage. The option and direction should be delimited by a space. Direction can be either "ASC" or "DESC"

 

dealStage.cardRegion1

string                                        What to show in upper-left corner of Deal Cards

 

dealStage.cardRegion2

string                                        What to show in upper-right corner of Deal Cards

 

dealStage.cardRegion3

string                                        Whether to show the avatar in Deal Cards. Can be one of show-avatar and hide-avatar. If set to show-avatar, deal cards will show the avatars. If set to hide-avatar, deal cards will hide the avatars

 

dealStage.cardRegion4

string                                        What to show next to the avatar in Deal Cards

 

dealStage.cardRegion5

string                                        What to show in lower-right corner of Deal Cards

 

dealStage.color

string                                        Deal Stage's color. 6-character HEX color code without the hashtag. e.g. "434343" to assign the hex color value "#434343"

 

dealStage.width

int32                                         Deal stage's width in pixels, without px unit

 

To create a deal stage, the following permissions are required.

• Deal permission: the user should have permission to manage deals.
• Edit Pipeline permission: the user should have permission to edit pipelines.
• Pipeline-specific permission: the user should have permission to manage the pipeline that the stage belongs to.