Skip to main content

​
Passo 1: Gere sua API Key

No painel da SocialSell, acesse Configurações → Developers e crie uma nova API Key. Selecione os escopos que sua integração precisa. A chave terá o formato sk_live_....

​
Passo 2: Faça sua primeira requisição

Liste os contatos da sua organização: 
curl https://api.socialsell.ai/v1/contacts \
  -H "Authorization: Bearer sk_live_sua_chave_aqui"

​
Passo 3: Interprete a resposta

{
  "data": [
    {
      "id": "664f1a2b3c4d5e6f78901234",
      "name": "João Silva",
      "email": "joao@empresa.com.br",
      "phone": "+5511999999999",
      "whatsapp_jid": "5511999999999@s.whatsapp.net",
      "instagram_username": null,
      "source": "whatsapp",
      "assigned_to": {
        "id": "664a1b2c3d4e5f6789012345",
        "name": "Maria Santos"
      },
      "company": {
        "id": "664b1c2d3e4f5a6789012346",
        "name": "Empresa ABC"
      },
      "tags": ["cliente", "vip"],
      "custom_fields": {},
      "notes_count": 2,
      "deals_count": 1,
      "created_at": "2026-01-15T10:30:00.000Z",
      "updated_at": "2026-06-01T14:22:00.000Z"
    }
  ],
  "meta": {
    "total": 142,
    "has_more": true,
    "next_cursor": "eyJpZCI6IjY2NGYxYTJiM2M0ZDVlNmY3ODkwMTIzNCIsImNhIjoiMjAyNi0wMS0xNVQxMDozMDowMC4wMDBaIn0",
    "request_id": "req_01jx8kz3m4n5p6q7r8s9t0u1v"
  }
}
  • data — array com os itens retornados
  • meta.total — total de registros na organização
  • meta.has_more — se há mais páginas
  • meta.next_cursor — token para a próxima página

​
Passo 4: Crie um contato

curl -X POST https://api.socialsell.ai/v1/contacts \
  -H "Authorization: Bearer sk_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Ana Costa",
    "email": "ana@empresa.com.br",
    "phone": "+5521988888888",
    "tags": ["lead", "inbound"],
    "source": "site"
  }'

​
Passo 5: Envie uma mensagem via WhatsApp

curl -X POST https://api.socialsell.ai/v1/messages/send \
  -H "Authorization: Bearer sk_live_sua_chave_aqui" \
  -H "Content-Type: application/json" \
  -d '{
    "contact_id": "664f1a2b3c4d5e6f78901234",
    "channel": "whatsapp",
    "type": "text",
    "content": "Olá! Como posso ajudar você hoje?"
  }'

​
Próximos passos

Paginação

Como navegar por listas grandes com cursores.

Webhooks

Receba eventos em tempo real no seu sistema.

Escopos

Quais permissões sua chave precisa para cada endpoint.

Erros

Como tratar erros e entender os códigos.