Skip to main content
POST
/
v3
/
deals
Create Deal
curl --request POST \
  --url https://api4.kinbox.com.br/v3/deals \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "value": 123,
  "status": "open",
  "contact": {
    "id": 123,
    "name": "<string>",
    "avatar": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "isPrivate": true
  },
  "operatorId": 123,
  "groupId": 123,
  "pipelineId": "<string>",
  "stageId": "<string>",
  "origin": "<string>",
  "tagIds": [
    123
  ],
  "_id": "<string>",
  "contactId": 123,
  "lostReason": [
    "<string>"
  ],
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "quantity": 123,
      "discount": 123,
      "discountType": {},
      "total": 123
    }
  ],
  "lostReasonObs": "<string>",
  "wonLostDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "conversation": {
    "id": 123,
    "platformId": 123,
    "showPending": true,
    "pendingAt": "<string>",
    "lastMessageAt": "2023-11-07T05:31:56Z"
  },
  "campaign": "<string>",
  "authorType": "user",
  "authorId": {},
  "position": 123,
  "focusedCounts": 123,
  "tasks": {},
  "timeInStage": {},
  "lastStageChanged": "2023-11-07T05:31:56Z",
  "comments": 123,
  "context": {
    "automationId": "<string>"
  },
  "customFields": {}
}
'
{
  "id": "<string>",
  "name": "<string>",
  "value": 123,
  "status": "open",
  "contact": {
    "id": 123,
    "name": "<string>",
    "avatar": "<string>",
    "phone": "<string>",
    "email": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "isPrivate": true
  },
  "operatorId": 123,
  "groupId": 123,
  "pipelineId": "<string>",
  "stageId": "<string>",
  "origin": "<string>",
  "tagIds": [
    123
  ],
  "workspaceId": 123,
  "createdAt": "2023-11-07T05:31:56Z",
  "lastUpdateAt": "2023-11-07T05:31:56Z",
  "_id": "<string>",
  "lostReason": [
    "<string>"
  ],
  "products": [
    {
      "id": "<string>",
      "name": "<string>",
      "price": 123,
      "quantity": 123,
      "discount": 123,
      "discountType": {},
      "total": 123
    }
  ],
  "lostReasonObs": "<string>",
  "wonLostDate": "2023-11-07T05:31:56Z",
  "dueDate": "2023-11-07T05:31:56Z",
  "conversation": {
    "id": 123,
    "platformId": 123,
    "showPending": true,
    "pendingAt": "<string>",
    "lastMessageAt": "2023-11-07T05:31:56Z"
  },
  "campaign": "<string>",
  "authorType": "user",
  "authorId": {},
  "position": 123,
  "focusedCounts": 123,
  "tasks": {},
  "timeInStage": {},
  "lastStageChanged": "2023-11-07T05:31:56Z",
  "comments": 123,
  "context": {
    "automationId": "<string>"
  },
  "customFields": {},
  "updatedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json
​
name
string
required
​
value
number
required
​
status
enum<string>
required
Available options:
open,
won,
lost
​
contact
object
required
​
operatorId
number
required
​
groupId
number
required
​
pipelineId
string
required
​
stageId
string
required
​
origin
string
required
​
tagIds
number[]
required
​
_id
string
​
contactId
number
​
lostReason
string[]
​
products
object[]
​
lostReasonObs
string
​
wonLostDate
string<date-time>
​
dueDate
string<date-time>
​
conversation
object
​
campaign
string
​
authorType
enum<string>
Available options:
user,
bot,
automation,
workflow,
unknown,
cadence
​
authorId
object
​
position
number
​
focusedCounts
number
​
tasks
object
​
timeInStage
object
​
lastStageChanged
string<date-time>
​
comments
number
​
context
object
​
customFields
object

Response

201 - application/json
​
id
string
required
​
name
string
required
​
value
number
required
​
status
enum<string>
required
Available options:
open,
won,
lost
​
contact
object
required
​
operatorId
number
required
​
groupId
number
required
​
pipelineId
string
required
​
stageId
string
required
​
origin
string
required
​
tagIds
number[]
required
​
workspaceId
number
required
​
createdAt
string<date-time>
required
​
lastUpdateAt
string<date-time>
required
​
_id
string
​
lostReason
string[]
​
products
object[]
​
lostReasonObs
string
​
wonLostDate
string<date-time>
​
dueDate
string<date-time>
​
conversation
object
​
campaign
string
​
authorType
enum<string>
Available options:
user,
bot,
automation,
workflow,
unknown,
cadence
​
authorId
object
​
position
number
​
focusedCounts
number
​
tasks
object
​
timeInStage
object
​
lastStageChanged
string<date-time>
​
comments
number
​
context
object
​
customFields
object
​
updatedAt
string<date-time>