Catalisa.Building Blocks

API do WPP Business

151 endpoints em 20 recursos. A permissão de cada rota é a que o código exige — conferida linha a linha, não copiada do nome.

Ver a referência detalhada, com corpo de requisição e catálogo de erros →

152 endpoints

Meta Apps

/api/v1/apps5
  • POST/api/v1/appsRegistra um Meta App e cifra o App SecretWPP_BIZ_ACCOUNTS_MANAGE
  • GET/api/v1/appsLista os apps da organizaçãoWPP_BIZ_READ
  • GET/api/v1/apps/:idBusca um appWPP_BIZ_READ
  • PATCH/api/v1/apps/:idAtualiza nome ou App SecretWPP_BIZ_ACCOUNTS_MANAGE
  • DELETE/api/v1/apps/:idExclusão lógicaWPP_BIZ_ACCOUNTS_MANAGE

Contas WABA

/api/v1/accounts27
  • POST/api/v1/accountsCria a conta WABA (onboarding modo A)WPP_BIZ_ACCOUNTS_MANAGE
  • GET/api/v1/accountsLista contasWPP_BIZ_READ
  • GET/api/v1/accounts/:idBusca contaWPP_BIZ_READ
  • PATCH/api/v1/accounts/:idAtualiza token, nome ou app vinculadoWPP_BIZ_ACCOUNTS_MANAGE
  • DELETE/api/v1/accounts/:idExclusão lógicaWPP_BIZ_ACCOUNTS_MANAGE
  • POST/api/v1/accounts/:id/phone-numbersVincula um número à contaWPP_BIZ_ACCOUNTS_MANAGE
  • GET/api/v1/accounts/:id/phone-numbersLista os números da contaWPP_BIZ_READ
  • GET/api/v1/accounts/:id/webhooksConsulta o estado da assinatura na MetaWPP_BIZ_READ
  • POST/api/v1/accounts/:id/webhooksAssina o app e a WABA nos campos escolhidosWPP_BIZ_ACCOUNTS_MANAGE
  • PUT/api/v1/accounts/:id/webhooksTroca os campos assinadosWPP_BIZ_ACCOUNTS_MANAGE
  • DELETE/api/v1/accounts/:id/webhooksRemove a assinatura no nível do appWPP_BIZ_ACCOUNTS_MANAGE
  • POST/api/v1/accounts/:id/regenerate-verify-tokenGera novo webhookVerifyTokenWPP_BIZ_ACCOUNTS_MANAGE
  • GET/api/v1/accounts/:id/waba-infoEstado da WABA na Meta (verificação, revisão)WPP_BIZ_READ
  • GET/api/v1/accounts/:id/templatesLista templates lendo a MetaWPP_BIZ_TEMPLATES_READ
  • POST/api/v1/accounts/:id/templatesCria o template direto na MetaWPP_BIZ_TEMPLATES_WRITE
  • DELETE/api/v1/accounts/:id/templatesApaga template na Meta por nomeWPP_BIZ_TEMPLATES_WRITE
  • POST/api/v1/accounts/:id/templates/:templateId/syncSincroniza um template local com a MetaWPP_BIZ_TEMPLATES_WRITE
  • PATCH/api/v1/accounts/:id/templates/:templateIdEdita componentes ou categoria na MetaWPP_BIZ_TEMPLATES_WRITE
  • GET/api/v1/accounts/phone-numbers/:phoneNumberId/business-profileLê o perfil comercialWPP_BIZ_ACCOUNTS_MANAGE
  • PATCH/api/v1/accounts/phone-numbers/:phoneNumberId/business-profileAtualiza perfil comercialWPP_BIZ_ACCOUNTS_MANAGE
  • GET/api/v1/accounts/phone-numbers/:phoneNumberId/statusQualidade e estado do númeroWPP_BIZ_READ
  • POST/api/v1/accounts/phone-numbers/:phoneNumberId/registerRegistra o número na Cloud API com PINWPP_BIZ_ACCOUNTS_MANAGE
  • POST/api/v1/accounts/phone-numbers/:phoneNumberId/deregisterCancela o registroWPP_BIZ_ACCOUNTS_MANAGE
  • POST/api/v1/accounts/phone-numbers/:phoneNumberId/request-codePede código por SMS ou VOICEWPP_BIZ_ACCOUNTS_MANAGE
  • POST/api/v1/accounts/phone-numbers/:phoneNumberId/verify-codeConfirma o código recebidoWPP_BIZ_ACCOUNTS_MANAGE
  • POST/api/v1/accounts/phone-numbers/:phoneNumberId/two-step-verificationDefine o PIN de dois fatoresWPP_BIZ_ACCOUNTS_MANAGE
  • PATCH/api/v1/accounts/phone-numbers/:phoneNumberId/display-namePede troca do nome exibidoWPP_BIZ_ACCOUNTS_MANAGE

Onboarding simplificado

/api/v1/devices/standalone1
  • POST/api/v1/devices/standaloneOnboarding modo B: token + phoneNumberId + wabaId, o BB descobre o restoWPP_BIZ_ACCOUNTS_MANAGE

Mensagens

/api/v1/messages7
  • POST/api/v1/messages/sendTexto, mídia, localização ou interativo (exige janela aberta)WPP_BIZ_MESSAGES_SEND
  • POST/api/v1/messages/send-templateTemplate aprovado (abre a janela)WPP_BIZ_MESSAGES_SEND
  • POST/api/v1/messages/send-interactiveBotões, lista, CTA de URL ou flowWPP_BIZ_MESSAGES_SEND
  • POST/api/v1/messages/send-otpTemplate de autenticação com códigoWPP_BIZ_MESSAGES_SEND
  • POST/api/v1/messages/:id/mark-readMarca a mensagem como lida na MetaWPP_BIZ_MESSAGES_SEND
  • GET/api/v1/messagesLista mensagens (phoneNumberId, contactId, limit, offset)WPP_BIZ_MESSAGES_READ
  • GET/api/v1/messages/:idBusca uma mensagemWPP_BIZ_MESSAGES_READ

Contatos

/api/v1/contacts12
  • POST/api/v1/contactsCria contatoWPP_BIZ_CONTACTS_WRITE
  • GET/api/v1/contactsLista contatosWPP_BIZ_CONTACTS_READ
  • GET/api/v1/contacts/searchBusca por texto, telefone, e-mail, etiqueta e períodoWPP_BIZ_CONTACTS_READ
  • POST/api/v1/contacts/bulkImporta até 1.000 contatos por chamadaWPP_BIZ_CONTACTS_WRITE
  • GET/api/v1/contacts/:idBusca contatoWPP_BIZ_CONTACTS_READ
  • PATCH/api/v1/contacts/:idAtualiza contatoWPP_BIZ_CONTACTS_WRITE
  • DELETE/api/v1/contacts/:idExclusão lógicaWPP_BIZ_CONTACTS_WRITE
  • GET/api/v1/contacts/:id/conversation-windowEstado da janela de 24h (exige ?phoneNumberId=)WPP_BIZ_CONTACTS_READ
  • POST/api/v1/contacts/:id/tagsAtribui etiquetas ao contatoWPP_BIZ_CONTACTS_WRITE
  • GET/api/v1/contacts/tagsLista etiquetasWPP_BIZ_CONTACTS_READ
  • POST/api/v1/contacts/tagsCria etiquetaWPP_BIZ_CONTACTS_WRITE
  • DELETE/api/v1/contacts/tags/:tagIdRemove etiquetaWPP_BIZ_CONTACTS_WRITE

Templates (cache local)

/api/v1/templates9
  • POST/api/v1/templatesCria o template local como DRAFTWPP_BIZ_TEMPLATES_WRITE
  • GET/api/v1/templatesLista do cache localWPP_BIZ_TEMPLATES_READ
  • GET/api/v1/templates/:idBusca template localWPP_BIZ_TEMPLATES_READ
  • PATCH/api/v1/templates/:idEdita componentes ou categoria (bloqueado em PENDING)WPP_BIZ_TEMPLATES_WRITE
  • DELETE/api/v1/templates/:idExclusão lógicaWPP_BIZ_TEMPLATES_WRITE
  • POST/api/v1/templates/:id/submitEnvia o template à Meta e marca PENDINGWPP_BIZ_TEMPLATES_WRITE
  • POST/api/v1/templates/:id/syncPuxa o status atual da Meta para o cacheWPP_BIZ_TEMPLATES_WRITE
  • GET/api/v1/templates/analyticsMétricas de template na Meta (exige opt-in na WABA)WPP_BIZ_ANALYTICS_READ
  • GET/api/v1/templates/qualityNota de qualidade dos templates na MetaWPP_BIZ_ANALYTICS_READ

Campanhas

/api/v1/campaigns8
  • POST/api/v1/campaignsCria campanha (exige template APPROVED)WPP_BIZ_CAMPAIGNS_WRITE
  • GET/api/v1/campaignsLista campanhasWPP_BIZ_CAMPAIGNS_READ
  • GET/api/v1/campaigns/:idBusca campanha com contadoresWPP_BIZ_CAMPAIGNS_READ
  • PATCH/api/v1/campaigns/:idAtualiza (só em DRAFT ou SCHEDULED)WPP_BIZ_CAMPAIGNS_WRITE
  • DELETE/api/v1/campaigns/:idExclusão lógica (bloqueada em EXECUTING)WPP_BIZ_CAMPAIGNS_WRITE
  • POST/api/v1/campaigns/:id/executeResolve destinatários e começa a enviarWPP_BIZ_CAMPAIGNS_EXECUTE
  • POST/api/v1/campaigns/:id/pausePausa a campanha em execuçãoWPP_BIZ_CAMPAIGNS_EXECUTE
  • GET/api/v1/campaigns/:id/recipientsLista destinatários e status individualWPP_BIZ_CAMPAIGNS_READ

Automações

/api/v1/automations6
  • POST/api/v1/automationsCria automaçãoWPP_BIZ_AUTOMATIONS_WRITE
  • GET/api/v1/automationsLista automaçõesWPP_BIZ_AUTOMATIONS_READ
  • GET/api/v1/automations/:idBusca automaçãoWPP_BIZ_AUTOMATIONS_READ
  • PATCH/api/v1/automations/:idAtualiza automaçãoWPP_BIZ_AUTOMATIONS_WRITE
  • DELETE/api/v1/automations/:idExclusão lógicaWPP_BIZ_AUTOMATIONS_WRITE
  • POST/api/v1/automations/:id/toggleLiga ou desligaWPP_BIZ_AUTOMATIONS_WRITE

Dispatchers

/api/v1/dispatchers8
  • POST/api/v1/dispatchersCria dispatcher e a inscrição no Webhooks EngineWPP_BIZ_DISPATCHERS_WRITE
  • GET/api/v1/dispatchersLista dispatchersWPP_BIZ_DISPATCHERS_READ
  • GET/api/v1/dispatchers/:idBusca dispatcherWPP_BIZ_DISPATCHERS_READ
  • PATCH/api/v1/dispatchers/:idAtualiza filtros, destino e retentativaWPP_BIZ_DISPATCHERS_WRITE
  • DELETE/api/v1/dispatchers/:idRemove dispatcher e a inscriçãoWPP_BIZ_DISPATCHERS_WRITE
  • POST/api/v1/dispatchers/:id/togglePausa ou retoma a entregaWPP_BIZ_DISPATCHERS_WRITE
  • GET/api/v1/dispatchers/:id/delivery-logsLog de entrega (page, pageSize, status)WPP_BIZ_DISPATCHERS_READ
  • POST/api/v1/dispatchers/:id/delivery-logs/:logId/retryReenvia uma entrega que falhouWPP_BIZ_DISPATCHERS_WRITE

WhatsApp Flows

/api/v1/flows9
  • POST/api/v1/flowsCria o flow na MetaWPP_BIZ_FLOWS_MANAGE
  • GET/api/v1/flowsLista flowsWPP_BIZ_FLOWS_MANAGE
  • GET/api/v1/flows/:idBusca flowWPP_BIZ_FLOWS_MANAGE
  • PATCH/api/v1/flows/:idAtualiza nome, categorias ou endpointWPP_BIZ_FLOWS_MANAGE
  • PUT/api/v1/flows/:id/jsonSubstitui a definição JSON na MetaWPP_BIZ_FLOWS_MANAGE
  • POST/api/v1/flows/:id/publishPublica o flowWPP_BIZ_FLOWS_MANAGE
  • POST/api/v1/flows/:id/deprecateDescontinua o flowWPP_BIZ_FLOWS_MANAGE
  • DELETE/api/v1/flows/:idRemove o flowWPP_BIZ_FLOWS_MANAGE
  • POST/api/v1/flows/:id/sendEnvia mensagem interativa com o flowWPP_BIZ_MESSAGES_SEND

Catálogo e produtos

/api/v1/catalogs11
  • POST/api/v1/catalogsCria catálogo localWPP_BIZ_CATALOG_MANAGE
  • GET/api/v1/catalogsLista catálogosWPP_BIZ_CATALOG_READ
  • GET/api/v1/catalogs/:idBusca catálogoWPP_BIZ_CATALOG_READ
  • DELETE/api/v1/catalogs/:idExclusão lógicaWPP_BIZ_CATALOG_MANAGE
  • POST/api/v1/catalogs/:catalogId/productsCria produto localWPP_BIZ_CATALOG_MANAGE
  • GET/api/v1/catalogs/:catalogId/productsLista produtosWPP_BIZ_CATALOG_READ
  • GET/api/v1/catalogs/:catalogId/products/:pidBusca produtoWPP_BIZ_CATALOG_READ
  • PATCH/api/v1/catalogs/:catalogId/products/:pidAtualiza produtoWPP_BIZ_CATALOG_MANAGE
  • DELETE/api/v1/catalogs/:catalogId/products/:pidExclusão lógicaWPP_BIZ_CATALOG_MANAGE
  • POST/api/v1/catalogs/send-productEnvia mensagem de um produtoWPP_BIZ_CATALOG_MANAGE
  • POST/api/v1/catalogs/send-product-listEnvia lista de produtos por seçãoWPP_BIZ_CATALOG_MANAGE

Pedidos

/api/v1/orders3
  • GET/api/v1/ordersLista pedidosWPP_BIZ_ORDERS_READ
  • GET/api/v1/orders/:idBusca pedido com itensWPP_BIZ_ORDERS_READ
  • PATCH/api/v1/orders/:id/statusMuda o status do pedidoWPP_BIZ_ORDERS_MANAGE

Pagamentos

/api/v1/payments9
  • POST/api/v1/payments/configCria a configuração de pagamento da contaWPP_BIZ_PAYMENTS_MANAGE
  • GET/api/v1/payments/config/:accountIdLê a configuraçãoWPP_BIZ_PAYMENTS_READ
  • PATCH/api/v1/payments/config/:idAtualiza a configuraçãoWPP_BIZ_PAYMENTS_MANAGE
  • POST/api/v1/paymentsCria o registro de cobrança de um pedidoWPP_BIZ_PAYMENTS_MANAGE
  • GET/api/v1/paymentsLista cobrançasWPP_BIZ_PAYMENTS_READ
  • GET/api/v1/payments/:idBusca cobrançaWPP_BIZ_PAYMENTS_READ
  • PATCH/api/v1/payments/:id/statusMuda o status da cobrançaWPP_BIZ_PAYMENTS_MANAGE
  • POST/api/v1/payments/send-pixEnvia mensagem order_details com PIXWPP_BIZ_PAYMENTS_MANAGE
  • POST/api/v1/payments/send-boletoEnvia mensagem order_details com boletoWPP_BIZ_PAYMENTS_MANAGE

Analytics

/api/v1/analytics/conversations2
  • GET/api/v1/analytics/conversationsAnalytics de conversa **da Meta** (exige accountId, start, end)WPP_BIZ_ANALYTICS_READ
  • GET/api/v1/analytics/conversations/statsAgregação local por categoria e origemWPP_BIZ_ANALYTICS_READ

Mídia

/api/v1/media4
  • POST/api/v1/media/uploadSobe arquivo para a Meta (multipart/form-data)WPP_BIZ_MEDIA_MANAGE
  • GET/api/v1/media/:mediaId/urlObtém a URL temporária do arquivoWPP_BIZ_MEDIA_READ
  • GET/api/v1/media/:mediaId/downloadBaixa o binário pela MetaWPP_BIZ_MEDIA_READ
  • DELETE/api/v1/media/:mediaIdRemove o arquivo da MetaWPP_BIZ_MEDIA_MANAGE

Agentes e regras de distribuição

/api/v1/agents11
  • POST/api/v1/agentsCria agente a partir de um usuário do IAMWPP_BIZ_AGENTS_MANAGE
  • GET/api/v1/agentsLista agentesWPP_BIZ_AGENTS_MANAGE
  • GET/api/v1/agents/availableLista agentes disponíveis, por menor cargaWPP_BIZ_AGENTS_MANAGE
  • GET/api/v1/agents/:idBusca agenteWPP_BIZ_AGENTS_MANAGE
  • PATCH/api/v1/agents/:idAtualiza nome, e-mail, capacidade e habilidadesWPP_BIZ_AGENTS_MANAGE
  • PATCH/api/v1/agents/:id/statusMuda disponibilidadeWPP_BIZ_AGENTS_MANAGE
  • DELETE/api/v1/agents/:idExclusão lógicaWPP_BIZ_AGENTS_MANAGE
  • POST/api/v1/agents/routing-rulesCria regra de distribuiçãoWPP_BIZ_AGENTS_MANAGE
  • GET/api/v1/agents/routing-rulesLista regrasWPP_BIZ_AGENTS_MANAGE
  • PATCH/api/v1/agents/routing-rules/:idAtualiza regraWPP_BIZ_AGENTS_MANAGE
  • DELETE/api/v1/agents/routing-rules/:idExclusão lógicaWPP_BIZ_AGENTS_MANAGE

Caixa de entrada

/api/v1/inbox8
  • POST/api/v1/inbox/assignCria ou atualiza a atribuição de uma conversaWPP_BIZ_INBOX_MANAGE
  • GET/api/v1/inboxLista atribuiçõesWPP_BIZ_INBOX_MANAGE
  • GET/api/v1/inbox/:idBusca atribuiçãoWPP_BIZ_INBOX_MANAGE
  • POST/api/v1/inbox/:id/transferTransfere para outro agente, com motivoWPP_BIZ_INBOX_MANAGE
  • POST/api/v1/inbox/:id/resolveMarca como resolvidaWPP_BIZ_INBOX_MANAGE
  • POST/api/v1/inbox/:id/closeFecha a conversaWPP_BIZ_INBOX_MANAGE
  • POST/api/v1/inbox/:id/notesAdiciona nota interna (só agente registrado)WPP_BIZ_INBOX_MANAGE
  • GET/api/v1/inbox/:id/notesLista notasWPP_BIZ_INBOX_MANAGE

Webhook da Meta e log

/api/v1/webhook6
  • GET/api/v1/webhookVerificação hub.challenge da Meta**Pública** — casa o webhookVerifyToken da conta
  • POST/api/v1/webhookRecebe eventos da Meta**Pública** — autentica por HMAC x-hub-signature-256
  • GET/api/v1/webhook/logsLista logs de webhookWPP_BIZ_WEBHOOKS_READ
  • GET/api/v1/webhook/logs/statsEstatísticas de processamentoWPP_BIZ_WEBHOOKS_READ
  • GET/api/v1/webhook/logs/:idBusca um log com o payload cruWPP_BIZ_WEBHOOKS_READ
  • POST/api/v1/webhook/logs/:id/replayReprocessa o payload guardadoWPP_BIZ_WEBHOOKS_WRITE

Saúde

/wpp-business/health1
  • GET/wpp-business/healthIdentificação e versão do serviço. Fora da contagem de 151.