A API do Prospa

Contatos /people

As pessoas do espaço, com empresa e telefone.

• GET /api/v1/people
• GET /api/v1/people/{id}
• POST /api/v1/people
• PATCH /api/v1/people/{id}
• DELETE /api/v1/people/{id}

Para cadastrar: obrigatório first_name · opcional last_name, email, phone, title, company_id, whatsapp_opt_in, custom_data. `company_id` precisa ser de uma empresa do mesmo espaço.

Para alterar: first_name, last_name, email, phone, title, company_id, whatsapp_opt_in, custom_data. Mande só o que mudou. Campo enviado vazio (ou `null`) apaga o valor; campo ausente do corpo fica como está. `custom_data` mescla com o que já está gravado.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Empresas /companies

As contas do espaço.

• GET /api/v1/companies
• GET /api/v1/companies/{id}
• POST /api/v1/companies
• PATCH /api/v1/companies/{id}
• DELETE /api/v1/companies/{id}

Para cadastrar: obrigatório name · opcional domain, website, industry, custom_data. Nome repetido não é recusado — o CRM aceita homônimas.

Para alterar: name, domain, website, industry, custom_data. `name` não pode ficar vazio: empresa sem nome some das listas do CRM.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Negócios /deals

As oportunidades do funil, com etapa e valor.

• GET /api/v1/deals
• GET /api/v1/deals/{id}
• POST /api/v1/deals
• PATCH /api/v1/deals/{id}
• DELETE /api/v1/deals/{id}

Para cadastrar: obrigatório title · opcional value_cents, stage_id, company_id, probability, expected_close_at, custom_data. Sem `stage_id`, o negócio entra na primeira etapa do funil.

Para alterar: title, value_cents, stage_id, company_id, probability, expected_close_at, lost_reason, custom_data. Mudar `stage_id` é o que marca o negócio como ganho ou perdido, e dispara os mesmos avisos da tela (`deal.stage_changed` e, conforme a etapa, `deal.won` ou `deal.lost`). Em etapa de perda, mande `lost_reason`.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Tarefas /tasks

Os compromissos da equipe, abertos e concluídos.

• GET /api/v1/tasks
• GET /api/v1/tasks/{id}
• POST /api/v1/tasks
• PATCH /api/v1/tasks/{id}
• DELETE /api/v1/tasks/{id}

Para cadastrar: obrigatório title · opcional body, due_at, person_id, company_id, deal_id. Sem `due_at` a tarefa fica sem prazo — e sem alerta de atraso.

Para alterar: title, body, due_at, completed_at, person_id, company_id, deal_id. `completed_at` com uma data conclui a tarefa (e dispara `task.completed`); com `null`, reabre.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Notas /notes

As anotações registradas nas fichas.

• GET /api/v1/notes
• GET /api/v1/notes/{id}
• POST /api/v1/notes
• PATCH /api/v1/notes/{id}
• DELETE /api/v1/notes/{id}

Para cadastrar: obrigatório body · opcional title, person_id, company_id, deal_id. Uma nota sem contato, empresa ou negócio fica solta na conta.

Para alterar: title, body, person_id, company_id, deal_id. `body` não pode ficar vazio: nota sem conteúdo não é nota.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Histórico /activities

Tudo que aconteceu na conta — notas, tarefas, ligações, e-mails e registros automáticos.

• GET /api/v1/activities
• GET /api/v1/activities/{id}

Só leitura.

Etapas do funil /stages

As colunas do funil, na ordem em que aparecem. Use o `id` daqui para criar um negócio na etapa certa.

• GET /api/v1/stages

Só leitura. Devolve a lista inteira, sem paginação.

Contas do WhatsApp /whatsapp_accounts

Números ligados ao aplicativo da Meta desta instalação. O aviso da Meta cai no Prospa; o mapeamento decide para onde segue. A chave de acesso não sai por aqui.

• GET /api/v1/whatsapp_accounts
• GET /api/v1/whatsapp_accounts/{id}

Só leitura.

Mapeamentos do WhatsApp /whatsapp_mappings

Para onde o aviso da Meta vai depois de cair aqui. O WMS (e qualquer outro sistema) cadastra o endereço HTTP neste recurso — o webhook da Meta continua apontando para o Prospa.

• GET /api/v1/whatsapp_mappings
• GET /api/v1/whatsapp_mappings/{id}
• POST /api/v1/whatsapp_mappings
• PATCH /api/v1/whatsapp_mappings/{id}
• DELETE /api/v1/whatsapp_mappings/{id}

Para cadastrar: obrigatório account_id, name, target · opcional url, events, secret, enabled. No destino http, url é obrigatório. secret é opcional e não volta na leitura.

Para alterar: name, url, events, secret, enabled. account_id e target não mudam — apague e crie outro.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Campos do formulário /custom_fields

O modelo do formulário de contato, empresa ou negócio. Crie o campo aqui; o valor de cada registro vai em `custom_data` desses recursos.

• GET /api/v1/custom_fields
• GET /api/v1/custom_fields/{id}
• POST /api/v1/custom_fields
• PATCH /api/v1/custom_fields/{id}
• DELETE /api/v1/custom_fields/{id}

Para cadastrar: obrigatório object, name · opcional key, type, options, required, position. Sem `key`, ela nasce do nome. Sem `type`, o campo é texto. O teto é o `customFieldsPerObject` do plano, por objeto.

Para alterar: name, type, options, required, position. `object` e `key` não mudam — apague e crie outro para não órfão o que já foi preenchido.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Modelos de WhatsApp /whatsapp_templates

Modelos de mensagem na Meta. Cria, lista e apaga daqui — a análise da Meta atualiza o status sozinha.

• GET /api/v1/whatsapp_templates
• GET /api/v1/whatsapp_templates/{id}
• POST /api/v1/whatsapp_templates
• DELETE /api/v1/whatsapp_templates/{id}

Para cadastrar: obrigatório account_id, name, body · opcional language, category, header, footer, examples, quick_replies, url_label, url_href, phone_label, phone_number. examples é lista de textos, um por variável do corpo. quick_replies é lista de textos dos botões. Cabeçalho com mídia só pela tela, que sobe o arquivo.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.

Envio de WhatsApp /whatsapp_messages

Manda texto (dentro da janela de 24h) ou modelo aprovado. Não precisa do painel da Meta.

• GET /api/v1/whatsapp_messages
• GET /api/v1/whatsapp_messages/{id}
• POST /api/v1/whatsapp_messages

Para cadastrar: obrigatório account_id, to, type · opcional text, template_name, language, parameters. type=text exige text. type=template exige template_name. parameters é lista de textos do corpo.

Perfil comercial do WhatsApp /whatsapp_profiles

Recado, e-mail e sites que o cliente vê no número. POST atualiza na Meta e aqui.

• GET /api/v1/whatsapp_profiles
• GET /api/v1/whatsapp_profiles/{id}
• POST /api/v1/whatsapp_profiles

Para cadastrar: obrigatório account_id · opcional about, email, description, address, websites, vertical, sync, username, display_name, picture_url, transfer_username. sync=true só puxa da Meta. username e display_name pedem análise. picture_url baixa a imagem e manda como foto de perfil.

Fluxos do WhatsApp /whatsapp_flows

WhatsApp Flow — formulário dentro da conversa. Cria, publica e apaga daqui.

• GET /api/v1/whatsapp_flows
• GET /api/v1/whatsapp_flows/{id}
• POST /api/v1/whatsapp_flows
• DELETE /api/v1/whatsapp_flows/{id}

Para cadastrar: obrigatório account_id, name · opcional json, categories, publish, data_url. Sem json usa um fluxo mínimo. publish=true publica na hora. data_url é https.

Para excluir: o registro sai das listas e da consulta por id, como quando alguém exclui pela tela. A resposta é {"data":{"id":"…","deleted":true}}.