Move deals to another stage

PUT  https://:account.api-us1.com/api/3/dealStages/id/deals

• JSON

{
  "deal": {
    "stage": "3"
  }
}

 

200 OK

{
  "deals": [
    {
      "activitycount": "1",
      "cdate": "2017-05-19T16:21:47-05:00",
      "contact": "1",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "1",
      "hash": "6faccb2d",
      "id": "1",
      "links": {
        "dealActivities": "/api/3/deals/1/dealActivities",
        "contact": "/api/3/deals/1/contact",
        "contactDeals": "/api/3/deals/1/contactDeals",
        "group": "/api/3/deals/1/group",
        "nextTask": "/api/3/deals/1/nextTask",
        "notes": "/api/3/deals/1/notes",
        "organization": "/api/3/deals/1/organization",
        "owner": "/api/3/deals/1/owner",
        "scoreValues": "/api/3/deals/1/scoreValues",
        "stage": "/api/3/deals/1/stage",
        "tasks": "/api/3/deals/1/tasks"
      },
      "mdate": "2017-05-19T16:21:47-05:00",
      "nextTask": null,
      "nextdealid": "2",
      "nexttaskid": "0",
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "3",
      "status": "0",
      "title": "Another Deal",
      "value": "10000"
    },
    {
      "activitycount": "1",
      "cdate": "2017-05-19T16:23:01-05:00",
      "contact": "2",
      "currency": "usd",
      "edate": "0000-00-00 00:00:00",
      "group": "1",
      "hash": "fe7cc4f3",
      "id": "2",
      "links": {
        "dealActivities": "/api/3/deals/2/dealActivities",
        "contact": "/api/3/deals/2/contact",
        "contactDeals": "/api/3/deals/2/contactDeals",
        "group": "/api/3/deals/2/group",
        "nextTask": "/api/3/deals/2/nextTask",
        "notes": "/api/3/deals/2/notes",
        "organization": "/api/3/deals/2/organization",
        "owner": "/api/3/deals/2/owner",
        "scoreValues": "/api/3/deals/2/scoreValues",
        "stage": "/api/3/deals/2/stage",
        "tasks": "/api/3/deals/2/tasks"
      },
      "mdate": "2017-05-19T16:23:01-05:00",
      "nextTask": null,
      "nextdealid": "1",
      "nexttaskid": "0",
      "organization": null,
      "owner": "1",
      "percent": "0",
      "stage": "3",
      "status": "0",
      "title": "Urgent Deal",
      "value": "10000"
    }
  ]
}

422 Different pipeline

{
  "errors": [
    {
      "detail": "Target stage does not belong to same pipeline",
      "source": {
        "pointer": "/data/attributes/stage"
      },
      "status": 422,
      "title": "Invalid attribute"
    }
  ]
}

PATH PARAMS

id                                         REQUIRED

int32                                    Deal stage's id whose deals are to be moved to another deal stage

 

BODY PARAMS

deal

object

 

deal.stage

string                                   Target deal stage's id to move deals to

To update 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.

If the source stage's pipeline is different from target stage's pipeline, 422 Unprocessible Entity error code will be returned.