Skip to main content
POST
Criar um negócio
Sem pipeline_id e sem stage_id, o negócio entra na primeira etapa aberta do funil padrão. Veja os ids em Listar funis. value_cents é o valor em centavos: R$ 1.500,00 é 150000. custom_fields preenche as colunas personalizadas de negócio, com as mesmas regras das de contato: a chave tem que ser de uma coluna ativa e o valor do tipo dela.

Authorizations

Authorization
string
header
required

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

Body

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

O funil (GET /api/v1/crm/pipelines). Sem ele e sem stage_id: o funil padrão

stage_id
string<uuid>

A etapa; com pipeline_id, tem de ser desse funil. Sem ela: a primeira etapa aberta do funil

contact_id
string<uuid> | null

O contato (POST /api/v1/crm/contacts devolve o id)

value_cents
integer | null

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

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

150000

currency
string

Default: BRL

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

"BRL"

expected_close_date
string | null
Example:

"2026-12-15"

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:
lost_reason
string

Só com a etapa de perdido

Required string length: 1 - 300

Response

O negócio criado

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"