Contatos
Gerencie sua base de clientes — crie, busque, atualize e consulte o histórico de conversas de cada contato.
GET
Listar Contatos
Retorna a lista paginada de contatos.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
Query Parameters
page
integer
Número da página. Padrão: 1.
sort
string
Ordenação:
name, email, phone_number, created_at.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts?page=1 \
--header 'api_access_token: '
200
{
"payload": {
"meta": { "count": 150, "current_page": 1 },
"payload": [
{
"id": 17,
"name": "João Silva",
"email": "joao@empresa.com",
"phone_number": "+5511999990001",
"created_at": 1716000000
}
]
}
}
GET
Buscar Contatos
Busca contatos por nome, e-mail ou telefone.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/search
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
Query Parameters
q
string
obrigatório
Termo de busca.
include_contacts
boolean
Inclui dados completos dos contatos. Padrão: true.
page
integer
Número da página.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/search?q=joao \
--header 'api_access_token: '
200
{
"payload": [
{"id": 17, "name": "João Silva", "email": "joao@empresa.com"}
],
"meta": {"count": 1}
}
POST
Criar Contato
Cria um novo contato na base.
POST
https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
Body Parameters
name
string
obrigatório
Nome completo do contato.
email
string
E-mail do contato.
phone_number
string
Telefone com código do país. Ex:
+5511999990001
company_name
string
Nome da empresa.
identifier
string
Identificador único externo.
custom_attributes
object
Atributos personalizados em JSON.
CURL
curl --request POST \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts \
--header 'api_access_token: ' \
--header 'Content-Type: application/json' \
--data '{
"name": "Ana Costa",
"email": "ana@empresa.com",
"phone_number": "+5511988880001"
}'
200
{
"id": 18,
"name": "Ana Costa",
"email": "ana@empresa.com",
"phone_number": "+5511988880001"
}
GET
Detalhes do Contato
Retorna todos os dados de um contato.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/{id}
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
id
integer
obrigatório
ID do contato.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/{id} \
--header 'api_access_token: '
200
{
"id": 17,
"name": "João Silva",
"email": "joao@empresa.com",
"phone_number": "+5511999990001",
"custom_attributes": {}
}
PUT
Atualizar Contato
Atualiza os dados de um contato existente.
PUT
https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/{id}
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
id
integer
obrigatório
ID do contato.
Body Parameters
name
string
Nome do contato.
email
string
E-mail do contato.
phone_number
string
Telefone do contato.
company_name
string
Nome da empresa.
CURL
curl --request PUT \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/{id} \
--header 'api_access_token: ' \
--header 'Content-Type: application/json' \
--data '{
"name": "João Silva Atualizado",
"company_name": "Nova Empresa"
}'
200
{
"id": 17,
"name": "João Silva Atualizado"
}
GET
Conversas do Contato
Retorna todas as conversas de um contato específico.
GET
https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/{id}/conversations
Parâmetros de Path
account_id
integer
obrigatório
ID da conta.
id
integer
obrigatório
ID do contato.
CURL
curl --request GET \
--url https://chat.klivo.marketing/api/v1/accounts/{account_id}/contacts/{id}/conversations \
--header 'api_access_token: '
200
{
"payload": [
{"id": 42, "status": "resolved"},
{"id": 38, "status": "open"}
]
}