v1Deals

Create a deal

Changed on
post/v1/deals

Request

  • Base URL: https://api4.kinbox.com.br (the document declares no server; this is the origin it was published from)
  • URL: https://api4.kinbox.com.br/v1/deals
  • Auth: none declared

Request body

namestring required

Nome do negócio

valuenumber required

Valor em dinheiro do negócio

ticketIdstring

ID sequencial do ticket

descriptionstring

Descrição do ticket

slaDueAtstring date-time

Prazo de SLA do ticket

lostReasonstring[]

Motivos de perda

productsLostReasonobject[]

Motivos de perda por produto

lostReasonObsstring

Observação de perda

wonLostDatestring date-time

Data de perda ou ganho

dueDatestring date-time

Data de vencimento

status'open' | 'won' | 'lost' required

Status do negócio

operatorIdnumber

ID do usuário responsável pelo negócio

groupIdnumber

ID do grupo associado ao negócio

pipelineIdstring required

ID do pipeline associado ao negócio

stageIdstring required
originstring
campaignstring
authorType'user' | 'bot' | 'automation' | 'workflow' | 'unknown' | 'cadence' | 'api'
authorIdobject
tagIdsnumber[]
positionnumber
focusedCountsnumber
tasksobject
cadenceOccurrencesobject
timeInStageobject
lastStageChangedstring date-time
commentsnumber
customFieldsobject
contactIdnumber required

ID do contato associado ao negócio.

organizationIdnumber nullable

ID da organização (CRM) vinculada ao negócio. Envie null para desvincular.

Example request

{
  "organizationId": 42
}

Response

idstring required
namestring required

Nome do negócio

valuenumber required

Valor em dinheiro do negócio

ticketIdstring

ID sequencial do ticket

descriptionstring

Descrição do ticket

slaDueAtstring date-time

Prazo de SLA do ticket

lostReasonstring[]

Motivos de perda

productsLostReasonobject[]

Motivos de perda por produto

lostReasonObsstring

Observação de perda

wonLostDatestring date-time

Data de perda ou ganho

dueDatestring date-time

Data de vencimento

status'open' | 'won' | 'lost' required

Status do negócio

operatorIdnumber

ID do usuário responsável pelo negócio

groupIdnumber

ID do grupo associado ao negócio

pipelineIdstring required

ID do pipeline associado ao negócio

stageIdstring required
originstring
campaignstring
authorType'user' | 'bot' | 'automation' | 'workflow' | 'unknown' | 'cadence' | 'api'
authorIdobject
tagIdsnumber[]
positionnumber
focusedCountsnumber
tasksobject
cadenceOccurrencesobject
timeInStageobject
lastStageChangedstring date-time
commentsnumber
customFieldsobject

Changes

  • c083bbfe8973Revision changes
    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

  • 91830f0a8f54Revision changes
    • breaking

      the response property became optional for the status

    • info

      the request property became optional