Update a deal

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

• JSON

{
  "deal": {
    "contact": "51",
    "description": "This deal is an important deal",
    "currency": "usd",
    "group": "1",
    "owner": "3",
    "percent": 0,
    "stage": "1",
    "status": 1,
    "title": "New Deal",
    "value": 10000
  }
}

 

200 OK

{
  "contacts": [
    {
      "adate": "2017-02-06 15:50:11",
      "bounced_date": "0000-00-00",
      "bounced_hard": "0",
      "bounced_soft": "0",
      "cdate": "2017-02-03T11:26:41-06:00",
      "deleted": "0",
      "edate": "0000-00-00 00:00:00",
      "email": "[e-mail]",
      "email_domain": "",
      "email_local": "",
      "firstName": "",
      "gravatar": "1",
      "hash": "e1705a92f24edf5313ed21df44d6ff5f",
      "id": "51",
      "ip": "0",
      "lastName": "",
      "links": {
        "bounceLogs": "/api/3/contacts/51/bounceLogs",
        "contactAutomations": "/api/3/contacts/51/contactAutomations",
        "contactData": "/api/3/contacts/51/contactData",
        "contactDeals": "/api/3/contacts/51/contactDeals",
        "contactGoals": "/api/3/contacts/51/contactGoals",
        "contactLists": "/api/3/contacts/51/contactLists",
        "contactLogs": "/api/3/contacts/51/contactLogs",
        "contactTags": "/api/3/contacts/51/contactTags",
        "deals": "/api/3/contacts/51/deals",
        "fieldValues": "/api/3/contacts/51/fieldValues",
        "geoIps": "/api/3/contacts/51/geoIps",
        "notes": "/api/3/contacts/51/notes",
        "organization": "/api/3/contacts/51/organization",
        "plusAppend": "/api/3/contacts/51/plusAppend",
        "scoreValues": "/api/3/contacts/51/scoreValues",
        "trackingLogs": "/api/3/contacts/51/trackingLogs"
      },
      "organization": null,
      "orgid": "0",
      "phone": "",
      "rating_tstamp": "0000-00-00",
      "segmentio_id": "",
      "sentcnt": "0",
      "socialdata_lastcheck": "0000-00-00 00:00:00",
      "ua": "",
      "udate": "2017-02-03T11:26:41-06:00"
    }
  ],
  "deal": {
    "activitycount": "4",
    "cdate": "2017-03-31T11:28:26-05:00",
    "contact": "51",
    "currency": "usd",
    "edate": "0000-00-00 00:00:00",
    "group": "1",
    "hash": "acd136f3",
    "id": "7",
    "links": {
      "dealActivities": "/api/3/deals/7/dealActivities",
      "contact": "/api/3/deals/7/contact",
      "contactDeals": "/api/3/deals/7/contactDeals",
      "group": "/api/3/deals/7/group",
      "nextTask": "/api/3/deals/7/nextTask",
      "notes": "/api/3/deals/7/notes",
      "organization": "/api/3/deals/7/organization",
      "owner": "/api/3/deals/7/owner",
      "scoreValues": "/api/3/deals/7/scoreValues",
      "stage": "/api/3/deals/7/stage",
      "tasks": "/api/3/deals/7/tasks"
    },
    "mdate": "2017-03-31T11:52:02-05:00",
    "nextTask": null,
    "nextdealid": "6",
    "nexttaskid": "0",
    "organization": null,
    "owner": "3",
    "percent": 0,
    "stage": "1",
    "status": 1,
    "title": "New Deal",
    "value": 10000,
    "description": "This deal is an important deal"
  },
  "dealStages": [
    {
      "cardRegion1": "title",
      "cardRegion2": "next-action",
      "cardRegion3": "show-avatar",
      "cardRegion4": "contact-fullname-orgname",
      "cardRegion5": "value",
      "cdate": "2017-01-20T09:27:32-06:00",
      "color": "C481DF",
      "dealOrder": "next-action DESC",
      "group": "1",
      "id": "1",
      "links": {
        "group": "/api/3/dealStages/1/group"
      },
      "order": "1",
      "title": "To Contact",
      "udate": "2017-01-20T09:27:32-06:00",
      "width": "280"
    }
  ]
}

PATH PARAMS

id                                    REQUIRED

int32                               Deal's id

 

BODY PARAMS

deal

object                              deal.description

 

deal.title

string                               Deal's title.

 

deal.description

string                               Deal's description

 

deal.contact

string                               Deal's primary contact id.

 

deal.value

int32                                Deal's value in cents. (i.e. $456.78 => 45678). Must be greater than or equal to zero.

 

deal.currency

string                               Deal's currency in 3-digit ISO format, lowercased.

 

deal.group

string                               Deal's pipeline id. Deal's stage or deal.stage should belong to deal.group.

 

deal.stage

string                               Deal's stage id. deal.stage should belong to Deal's pipeline or deal.group.

 

deal.owner

string                               Deal's owner id.

 

deal.percent

int32                                Deal's percentage.

 

deal.status

int32                                Deal's status.

 

To update a deal, following permissions are required.

• Deal permission: the user should have a permission to manage deals.
• Pipeline-specific permission: the user should have a permission to manage the pipeline the updating deal belongs to.
• Deal reassign permission: if assigning the deal to another user, this permission is required.

By default, the deal stage is also returned in the response. If deal.contact was provided in the request, the primary contact is also returned in the response.