PATCH /v1/deals/{id}
PATCH
/v1/deals/{id}
const url = 'https://seu-endereco-da-api/v1/deals/example';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"title":"example","value":1,"note":"example","assigneeId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","companyId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","expectedCloseAt":"example","attributes":{},"tagIds":["2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"],"products":[{"productId":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0","quantity":1}]}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://seu-endereco-da-api/v1/deals/example \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "title": "example", "value": 1, "note": "example", "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "companyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expectedCloseAt": "example", "attributes": {}, "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "products": [ { "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1 } ] }'Permissão que a Chave de acesso precisa: Criar e mover negócios (deals:manage).
Authorizations
Seção intitulada “Authorizations”Parameters
Seção intitulada “Parameters”Path Parameters
Seção intitulada “Path Parameters”id
required
string
Request Bodyrequired
Seção intitulada “Request Bodyrequired”Media typeapplication/json
object
title
string
value
number
note
string
assigneeId
string format: uuid
companyId
string format: uuid
expectedCloseAt
string
attributes
object
key
additional properties
any
tagIds
Array<string>
products
Array<object>
object
productId
required
string format: uuid
quantity
required
number
Example generated
{ "title": "example", "value": 1, "note": "example", "assigneeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "companyId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "expectedCloseAt": "example", "attributes": {}, "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "products": [ { "productId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "quantity": 1 } ]}Responses
Seção intitulada “Responses”Media typeapplication/json
object
id
required
string
number
required
Sequential per tenant, shown as #número
number
pipelineId
required
string
stageId
required
string
contactId
required
string
companyId
required
string
assigneeId
required
string
conversationId
required
string
title
required
string
value
required
number
note
required
string
expectedCloseAt
required
Data prevista de fechamento
string format: date-time
attributes
required
Valores dos campos personalizados do negocio (entity deal), pela chave do campo
object
status
required
string
wonAt
required
string format: date-time
lostAt
required
string format: date-time
lossReason
required
object
id
required
string
name
required
string
lostNote
required
string
winReason
required
object
id
required
string
name
required
string
wonNote
required
string
intakeAt
required
When the deal arrived as a new lead through the intake
string format: date-time
stageEnteredAt
required
string format: date-time
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
contact
required
object
id
required
string
name
required
string
phoneNumber
required
string
profilePicUrl
required
Presigned url for the contact’s whatsapp profile photo
string
provider
required
string
company
required
object
id
required
string
name
required
string
groupName
required
string
groupProvider
required
string
groupProfilePicUrl
required
string
createdBy
required
object
id
required
string
name
required
string
avatarUrl
required
Public url for the user’s photo
string
assignee
required
object
id
required
string
name
required
string
avatarUrl
required
Public url for the user’s photo
string
tagIds
required
Array<string>
products
required
Array<object>
object
id
required
string
name
required
string
price
required
Unit price in centavos
number
quantity
required
number
Example
{ "status": "open"}