Skip to main content
PATCH
Alterar um negócio (etapa, valor, ganho ou perdido)
Para mover o negócio, envie o stage_id de uma etapa do mesmo funil. A mudança fica registrada na linha do tempo. Para fechar, envie status como won ou lost: sem stage_id, o negócio vai para a primeira etapa desse tipo no funil. lost_reason só vale no negócio perdido.

Authorizations

Authorization
string
header
required

API Key da organização (Authorization: Bearer ik_live_xxx)

Path Parameters

id
string
required

ID do negócio (UUID)

Body

application/json
title
string
Required string length: 1 - 160
stage_id
string<uuid>

Uma etapa DO FUNIL do negócio. Mudar de etapa registra a atividade stage_change

status
enum<string>

won ou lost: sem stage_id, o negócio vai para a primeira etapa desse tipo no funil; com stage_id, os dois têm de concordar. Para reabrir, mande o stage_id de uma etapa aberta

Available options:
won,
lost
lost_reason
string | null

Motivo da perda: só com o negócio perdido no fim. null limpa

Required string length: 1 - 300
value_cents
integer | null

Valor em centavos (R$ 1.500,00 = 150000)

Required range: 0 <= x <= 100000000000000
Example:

150000

currency
string
Pattern: ^[A-Z]{3}$
Example:

"BRL"

expected_close_date
string | null
Example:

"2026-12-15"

contact_id
string<uuid> | null

O contato; null tira

tags
string[]

Até 30 tags, cada uma com até 40 caracteres; a repetida sai. Substitui a lista inteira

Maximum array length: 30
Required string length: 1 - 40
Example:
custom_fields
object

Campos personalizados (os criados no painel, em CRM > Configurações), pela chave: texto (até 500), número, data (AAAA-MM-DD), uma das opções da seleção ou true/false. null tira o valor. As chaves que não vierem ficam como estão

Example:

Response

O negócio alterado

id
string
required
title
string
required
pipeline_id
string
required
stage
object
required
status
enum<string>
required

open, won ou lost (o tipo da etapa)

Available options:
open,
won,
lost
lost_reason
string | null
required
value_cents
number | null
required
currency
string
required
expected_close_date
string | null
required

Previsão de fechamento (AAAA-MM-DD)

contact
object | null
required
company
object | null
required
tags
string[]
required
custom_fields
object
required
stage_entered_at
string
required

Quando entrou na etapa atual

Example:

"2026-11-02T14:00:00.000Z"

closed_at
string | null
required

Quando foi ganho ou perdido; null no aberto

Example:

"2026-11-02T14:00:00.000Z"

created_at
string
required

Criação (UTC)

Example:

"2026-11-02T14:00:00.000Z"

updated_at
string
required

Última mudança (UTC)

Example:

"2026-11-02T14:00:00.000Z"