Create a pipeline

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

• JSON

{
  "dealGroup": {
    "allgroups": 1,
    "allusers": 0,
    "autoassign": 1,
    "currency": "eur",
    "title": "Qualifications",
    "users": ["3", "4"]
  }
}

 

200 OK

{
  "dealGroup": {
    "allgroups": 1,
    "allusers": 0,
    "autoassign": 1,
    "cdate": "2017-03-30T12:12:41-05:00",
    "currency": "eur",
    "dealGroupGroups": [],
    "dealGroupUsers": [
      "6",
      "7"
    ],
    "id": "5",
    "links": {
      "dealGroupGroups": "/api/3/dealGroups/5/dealGroupGroups",
      "dealGroupUsers": "/api/3/dealGroups/5/dealGroupUsers",
      "stages": "/api/3/dealGroups/5/stages"
    },
    "stages": [
      "12",
      "13",
      "14"
    ],
    "title": "Qualifications",
    "udate": "2017-03-30T12:12:41-05:00"
  },
  "dealGroupGroups": [],
  "dealGroupUsers": [
    {
      "cdate": null,
      "dealGroup": "5",
      "id": "6",
      "links": {
        "dealGroup": "/api/3/dealGroupUsers/6/dealGroup",
        "user": "/api/3/dealGroupUsers/6/user"
      },
      "user": "3"
    },
    {
      "cdate": null,
      "dealGroup": "5",
      "id": "7",
      "links": {
        "dealGroup": "/api/3/dealGroupUsers/7/dealGroup",
        "user": "/api/3/dealGroupUsers/7/user"
      },
      "user": "4"
    }
  ],
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "18D499",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "12",
      "links": {
        "group": "/api/3/dealStages/12/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "32B0FC",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "13",
      "links": {
        "group": "/api/3/dealStages/13/group"
      },
      "order": "2",
      "title": "In Contact",
      "udate": null,
      "width": "280"
    },
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": null,
      "color": "E6CE4B",
      "dealOrder": "next-action DESC",
      "group": "5",
      "id": "14",
      "links": {
        "group": "/api/3/dealStages/14/group"
      },
      "order": "3",
      "title": "Follow Up",
      "udate": null,
      "width": "280"
    }
  ]
}

BODY PARAMS

dealGroup

object

 

dealGroup.title                        REQUIRED

string                                       Pipeline's title.

 

dealGroup.currency                REQUIRED

string                                       Default currency to assign to new deals that belong to this deal group.

 

dealGroup.allgroups

int32                                        Whether all user groups have permission to manage this pipeline. Can be either 1 or 0. If 1, all user groups can manage this pipeline. If 0, only user groups in dealGroup.groups parameter can manage this pipeline.

 

dealGroup.allusers

int32                                        Whether new deals get auto-assigned to all users. Can be either 1 or 0. If 1, new deals are auto-assigned to all users unless auto-assign is disabled. If 0, new deals are auto-assigned to only the users in dealGroup.users parameter.

 

dealGroup.autoassign

int32                                        Deal auto-assign option. Can be one of 0, 1, and 2. If 0, auto-assign is disabled. If 1, Round Robin method is used to auto-assign new deals. If 2, deals are distributed based on deal values.

 

dealGroup.users

array of strings                          List of user ids to auto-assign new deals to unless auto-assign option is disabled.

 

dealGroup.groups

array of strings                          List of user group ids to allow managing this pipeline.

 

Creating a new pipeline will also create three default deal stages named "To Contact", "In Contact", and "Follow Up".

By providing user ids with dealGroup.users and enabling the auto-assign option with dealGroup.autoassign: 1, a new pipeline can control how new deals are assigned to the owners. By providing user group ids with dealGroup.groups, a new pipeline can control which user groups are allowed to manage the pipeline.