v1

latestOpenAPI 3.0.02026-07-26626596.3 KB

Negócios

Atualizar negócio

patch/api/v1/businesses/{id}

Path parameters

idstring required

Request body

leadIdstring

ID do lead a ser vinculado ao negócio

stageIdstring

ID do estágio de pipeline no qual o negócio será criado

attendantIdstring

ID do atendente a ser vinculado ao negócio

externalIdstring

ID externo a ser vinculado ao negócio

Example request

{
  "leadId": "59e77f5f-7581-4f20-a05b-97cd33485019",
  "stageId": "59e77f5f-7581-4f20-a05b-97cd33485019",
  "attendantId": "59e77f5f-7581-4f20-a05b-97cd33485019",
  "externalId": "61ab2k4189lhz01"
}

Response

idstring

ID do negócio.

createdAtstring date-time

Data de criação do negócio.

stageIdstring

ID do estágio atual do negócio.

leadIdstring

ID do lead associado ao negócio.

attendantIdstring

ID do atendente responsável pelo negócio.

nextActivityIdstring

ID da próxima atividade relacionada ao negócio.

totalnumber

Valor total do negócio.

discountnumber

Valor de desconto aplicado ao negócio.

additionnumber

Valor de acréscimos aplicados ao negócio.

shippingnumber

Valor do frete relacionado ao negócio.

couponstring

Cupom de desconto utilizado no negócio.

shippingTypestring

Tipo de frete selecionado para o negócio.

statusstring

Status atual do negócio.

codenumber

Código interno do negócio.

externalIdstring

ID externo vinculado ao negócio.

lastMovedAtstring date-time

Data da última movimentação do negócio.

statusChangedAtstring date-time

Data da última alteração do status do negócio.

lossReasonIdstring

ID do motivo de perda do negócio.

justificationstring

Justificativa associada ao negócio.

productsCountnumber

Quantidade total de produtos no negócio.

Example response

{
  "id": "e9a09677-cf00-4d84-aa12-6d78d6786555",
  "createdAt": "2025-06-18T22:18:36.666Z",
  "stageId": "e6803a51-4bd6-416b-b516-3622ff256732",
  "leadId": "c1152508-fdfd-4905-a3f4-f3850cc00bf0",
  "attendantId": "7e7da46a-a0ed-43c2-a3aa-3ac253f41b4d",
  "nextActivityId": "3d3d23a-a0ed-43c2-a3aa-3ac23433f41g01",
  "discount": 500,
  "shipping": 2000,
  "coupon": "CUPOM100",
  "shippingType": "Sedex",
  "status": "in_process",
  "code": 50607,
  "externalId": "f33420908-dcdc-4905-a3f4-f3850cc43bf0",
  "lastMovedAt": "2025-06-18T22:18:36.611Z",
  "statusChangedAt": "2025-06-18T22:20:14.611Z4",
  "products": [],
  "lossReasonId": "null",
  "productsCount": 2
}