Create a deal

JSON

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

201 Created

{
  "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": "johndoe@example.com",
      "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": {
    "cdate": "2017-03-31T11:28:26-05:00",
    "contact": "51",
    "currency": "usd",
    "group": "1",
    "hash": "acd136f3",
    "id": "7",
    "isDisabled": "",
    "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:28:26-05:00",
    "nextTask": null,
    "organization": null,
    "owner": "1",
    "percent": null,
    "stage": "1",
    "status": 1,
    "title": "AC Deal",
    "value": 45600,
    "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"
    }
  ]
}

BODY PARAMS

deal

object deal.description

deal.title REQUIRED

string Deal's title.

deal.description

string Deal's description

deal.contact REQUIRED

string Deal's primary contact's id.

deal.value REQUIRED

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

deal.currency REQUIRED

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

deal.group REQUIRED

string Deal's pipeline id. Required if deal.stage is not provided. If deal.group is not provided, the stage's pipeline will be assigned to the deal automatically.

deal.stage REQUIRED

string Deal's stage id. Required if deal.group is not provided. If deal.stage is not provided, the deal will be assigned with the first stage in the pipeline provided in deal.group.

deal.owner REQUIRED

string Deal's owner id. Required if pipeline's auto-assign option is disabled.

deal.percent

int32 Deal's percentage.

deal.status

int32 Deal's status.

To create 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 a new deal belongs to.

By default, primary contact and deal stage are also returned in the response.

Artikelen in deze sectie

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

BODY PARAMS

Opmerkingen