logo
LeadsCriar lead
Leads

Criar lead

Cria um novo lead no sistema. Campos obrigatórios: name, email, phone e message.

Se propertyCode for informado e o imóvel existir, o lead será vinculado automaticamente ao imóvel. Se interestedPropertyTitle não for informado, será preenchido com o título do imóvel encontrado.

O lead é criado com status NEW_LEAD e prioridade MEDIUM por padrão.

curl -X POST "https://sandbox-partner-api.keyspot.com.br/v1/leads" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN (JWT)" \
  -d '{
  "name": "João Silva",
  "email": "joao@example.com",
  "phone": "11999999999",
  "message": "Tenho interesse neste imóvel, gostaria de mais informações."
}'
{
  "data": {
    "id": "clx1abc23def456",
    "name": "João Silva",
    "email": "joao@example.com",
    "phone": "11999999999",
    "message": "Tenho interesse neste imóvel, gostaria de mais informações.",
    "source": "API",
    "status": "NEW_LEAD",
    "priority": "MEDIUM",
    "propertyId": null,
    "interestedPropertyTitle": null,
    "createdAt": "2026-03-13T10:30:00.000Z",
    "updatedAt": "2026-03-13T10:30:00.000Z"
  }
}
POST
/v1/leads
POST
Bearer Token (JWT)
Bearer Tokenstring
Required

Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.

Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.
Content-Typestring
Required

The media type of the request body

Options: application/json
namestring
Required

Nome do contato

Min length: 1
emailstring
Required

E-mail do contato

Format: email
phonestring
Required

Telefone do contato

Min length: 1
messagestring
Required

Mensagem do contato

Min length: 1
sourcestring

Fonte de origem do lead

Options: WEBSITE, WHATSAPP, PHONE, EMAIL, SOCIAL_MEDIA, INSTAGRAM, FACEBOOK, PORTAL, PORTAL_VIVAREAL, PORTAL_ZAPIMOVEIS, PORTAL_OLX, PORTAL_IMOVELWEB, PORTAL_CHAVESNAMAO, META_ADS, GOOGLE_ADS, RD_STATION, REFERRAL, REAL_ESTATE, OTHER, API
propertyCodestring

Código do imóvel para vinculação automática

interestedPropertyTitlestring

Título do imóvel de interesse (preenchido automaticamente se propertyCode for encontrado)

trafficOriginstring

Origem do tráfego para rastreamento (UTM, campanha, etc.)

Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token (JWT). Token JWT obtido via POST /v1/auth/token. Válido por 1 hora.

Body

application/json
namestring
Required

Nome do contato

emailstring
Required

E-mail do contato

phonestring
Required

Telefone do contato

messagestring
Required

Mensagem do contato

sourcestring

Fonte de origem do lead

Allowed values:WEBSITEWHATSAPPPHONEEMAILSOCIAL_MEDIAINSTAGRAMFACEBOOKPORTALPORTAL_VIVAREALPORTAL_ZAPIMOVEISPORTAL_OLXPORTAL_IMOVELWEBPORTAL_CHAVESNAMAOMETA_ADSGOOGLE_ADSRD_STATIONREFERRALREAL_ESTATEOTHERAPI
propertyCodestring

Código do imóvel para vinculação automática

interestedPropertyTitlestring

Título do imóvel de interesse (preenchido automaticamente se propertyCode for encontrado)

trafficOriginstring

Origem do tráfego para rastreamento (UTM, campanha, etc.)

Responses