Documentação oficial da API 123zap
\nA 123zap facilita sua comunicação automática via WhatsApp, ajudando a enviar cobranças, lembretes, campanhas e muito mais, tudo de forma prática e integrada ao seu sistema.
\nNossa API foi desenvolvida para que você consiga conectar seus sistemas, planilhas ou ERPs à plataforma e automatizar suas mensagens com agilidade e segurança.
\nPara usar as APIs da 123zap, você vai precisar de alguns dados que listamos aqui embaixo. E fica tranquilo: se pintar qualquer dúvida, é só chamar nosso suporte técnico — estamos aqui pra ajudar! 💬✨
\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"owner":"27503258","collectionId":"f7fd80af-1b54-4ba3-b0e4-09c25ad6c67b","publishedId":"2sB2qgdJ3E","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"8033F4"},"publishDate":"2025-06-05T13:29:44.000Z"},"item":[{"name":"Status de API","item":[{"name":"Consultar status da API","id":"4a8937a4-81be-4ac4-af3c-ff52b2ede776","request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api.123zap}}/hello","description":"Verifica se a API está disponível.
\nNão exige autenticação.
\n","urlObject":{"path":["hello"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"201ed42d-7887-41b0-9124-6385f501b4d7","name":"200 - API disponível","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api.123zap}}/hello","description":"Verifica se a API está disponível.\n\nNão exige autenticação."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"\"Hello, from 123zap (:\""}],"_postman_id":"4a8937a4-81be-4ac4-af3c-ff52b2ede776"}],"id":"ba7862ce-4aa1-4f70-bdca-65b37f460f32","description":"Endpoints públicos de status da API.
\nEsta pasta documenta apenas a verificação de disponibilidade validada no backend atual.\nUse esta rota para confirmar se a API base está acessível antes de testar fluxos de autenticação ou perfil.
\n","_postman_id":"ba7862ce-4aa1-4f70-bdca-65b37f460f32"},{"name":"Autenticação","item":[{"name":"Realizar login","id":"9e38344c-21e3-4d2a-a1f6-cec1fdc077a9","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"usuario.teste\",\n \"password\": \"SenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/login","description":"Autentica um usuário com username e password.
Retorno padronizado:
\nstatus: \"success\" quando a autenticação retorna tokens.status: \"challenge\" quando o Cognito exige uma etapa adicional.status: \"error\" para validação, credenciais inválidas, e-mail não verificado, rate limit ou falha interna.Segurança: este endpoint possui limite de tentativas por usuário e por IP.
\n","urlObject":{"path":["auth","login"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"0039564a-5cc9-4026-b57e-4425454193e7","name":"200 - Login realizado","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"usuario.teste\",\n \"password\": \"SenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/login","description":"Autentica um usuário com `username` e `password`.\n\nRetorno padronizado:\n- `status: \"success\"` quando a autenticação retorna tokens.\n- `status: \"challenge\"` quando o Cognito exige uma etapa adicional.\n- `status: \"error\"` para validação, credenciais inválidas, e-mail não verificado, rate limit ou falha interna.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"idToken\": \"eyJ...\",\n \"accessToken\": \"eyJ...\",\n \"refreshToken\": \"eyJ...\",\n \"expiresIn\": 3600\n },\n \"error\": null\n}"},{"id":"113b7b9b-b67c-43f9-bddc-3aee9ce9b2a8","name":"400 - Challenge de autenticação","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"usuario.teste\",\n \"password\": \"SenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/login","description":"Autentica um usuário com `username` e `password`.\n\nRetorno padronizado:\n- `status: \"success\"` quando a autenticação retorna tokens.\n- `status: \"challenge\"` quando o Cognito exige uma etapa adicional.\n- `status: \"error\"` para validação, credenciais inválidas, e-mail não verificado, rate limit ou falha interna.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"challenge\",\n \"data\": {\n \"message\": \"New password required\",\n \"challengeName\": \"NEW_PASSWORD_REQUIRED\",\n \"session\": \"AYABe...\",\n \"requiredFields\": [\n \"newPassword\"\n ]\n },\n \"error\": null\n}"},{"id":"a46dd696-febb-447d-bcc2-d3f42cdf799f","name":"400 - Campos obrigatórios ausentes","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"usuario.teste\",\n \"password\": \"SenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/login","description":"Autentica um usuário com `username` e `password`.\n\nRetorno padronizado:\n- `status: \"success\"` quando a autenticação retorna tokens.\n- `status: \"challenge\"` quando o Cognito exige uma etapa adicional.\n- `status: \"error\"` para validação, credenciais inválidas, e-mail não verificado, rate limit ou falha interna.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"missing_required_fields\",\n \"message\": \"Missing required fields: username, password\",\n \"details\": {\n \"fields\": [\n \"username\",\n \"password\"\n ]\n }\n }\n}"},{"id":"cc38e808-4f98-41fe-813d-6c24688a4935","name":"403 - E-mail não verificado","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"usuario.teste\",\n \"password\": \"SenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/login","description":"Autentica um usuário com `username` e `password`.\n\nRetorno padronizado:\n- `status: \"success\"` quando a autenticação retorna tokens.\n- `status: \"challenge\"` quando o Cognito exige uma etapa adicional.\n- `status: \"error\"` para validação, credenciais inválidas, e-mail não verificado, rate limit ou falha interna.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"email_not_verified\",\n \"message\": \"Email not verified\"\n }\n}"},{"id":"06abe331-84f0-414e-81cf-c3fb2885d786","name":"429 - Limite de tentativas excedido","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"usuario.teste\",\n \"password\": \"SenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/login","description":"Autentica um usuário com `username` e `password`.\n\nRetorno padronizado:\n- `status: \"success\"` quando a autenticação retorna tokens.\n- `status: \"challenge\"` quando o Cognito exige uma etapa adicional.\n- `status: \"error\"` para validação, credenciais inválidas, e-mail não verificado, rate limit ou falha interna.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Try again later.\"\n }\n}"},{"id":"a7f14e06-6fb6-444b-b0b8-db8fd4aaefd0","name":"500 - Erro inesperado de autenticação","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"username\": \"usuario.teste\",\n \"password\": \"SenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/login","description":"Autentica um usuário com `username` e `password`.\n\nRetorno padronizado:\n- `status: \"success\"` quando a autenticação retorna tokens.\n- `status: \"challenge\"` quando o Cognito exige uma etapa adicional.\n- `status: \"error\"` para validação, credenciais inválidas, e-mail não verificado, rate limit ou falha interna.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"unexpected_auth_response\",\n \"message\": \"Unexpected authentication response\"\n }\n}"}],"_postman_id":"9e38344c-21e3-4d2a-a1f6-cec1fdc077a9"},{"name":"Realizar logout","id":"44137ac9-bd47-4408-bd05-b0aa5d85d849","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"accessToken\": \"eyJ...\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/logout","description":"Invalida a sessão global do usuário a partir do accessToken.
Retorno padronizado:
\nstatus: \"success\" quando o logout é concluído.status: \"error\" quando o token não é informado, é inválido ou ocorre falha interna.Endpoints públicos de autenticação mantidos para uso operacional. Endpoints auxiliares de descoberta de usuário e criação/confirmação de conta não são expostos nesta documentação de cliente.
\n","_postman_id":"f7c75e49-29b5-489f-b74d-ede46def9031"},{"name":"Recuperação","item":[{"name":"Solicitar recuperação de senha","id":"f44a8219-2115-4c9f-8b1e-799077d5425b","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\": \"usuario.teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/recovery-password","description":"Inicia a recuperação de senha para o identificador informado em user.
Por segurança, a resposta de sucesso é genérica e não confirma se o usuário existe.
\nSegurança: este endpoint possui limite de tentativas por usuário e por IP.
\n","urlObject":{"path":["auth","recovery-password"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"3c590920-b5f5-4137-83fe-64b03dec67ad","name":"200 - Recuperação iniciada","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\": \"usuario.teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/recovery-password","description":"Inicia a recuperação de senha para o identificador informado em `user`.\n\nPor segurança, a resposta de sucesso é genérica e não confirma se o usuário existe.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"status\": \"success\"\n },\n \"error\": null\n}"},{"id":"50ce5913-ebce-4ed8-9c4f-7d1633b11251","name":"400 - Campo obrigatório ausente","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\": \"usuario.teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/recovery-password","description":"Inicia a recuperação de senha para o identificador informado em `user`.\n\nPor segurança, a resposta de sucesso é genérica e não confirma se o usuário existe.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"missing_required_fields\",\n \"message\": \"Missing required fields: user\",\n \"details\": {\n \"fields\": [\n \"user\"\n ]\n }\n }\n}"},{"id":"fd469835-e821-41ce-b6a8-36cd650956c6","name":"429 - Limite de tentativas excedido","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\": \"usuario.teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/recovery-password","description":"Inicia a recuperação de senha para o identificador informado em `user`.\n\nPor segurança, a resposta de sucesso é genérica e não confirma se o usuário existe.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Try again later.\"\n }\n}"},{"id":"898652f3-b20d-4e45-a54d-a927e0b2c20a","name":"500 - Erro interno","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"user\": \"usuario.teste\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/recovery-password","description":"Inicia a recuperação de senha para o identificador informado em `user`.\n\nPor segurança, a resposta de sucesso é genérica e não confirma se o usuário existe.\n\nSegurança: este endpoint possui limite de tentativas por usuário e por IP."},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"internal_error\",\n \"message\": \"An unexpected error occurred\"\n }\n}"}],"_postman_id":"f44a8219-2115-4c9f-8b1e-799077d5425b"},{"name":"Verificar token de recuperação","id":"dd1eeede-a8f8-406e-bca0-a1cf4d84cf12","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/verify-token","description":"Valida se o token de recuperação existe e ainda está dentro do prazo.
\nRetorno padronizado:
\nstatus: \"success\" quando o token pode ser usado.status: \"error\" quando o token está ausente, inválido, expirado, bloqueado por rate limit ou ocorre falha interna.Segurança: este endpoint possui limite de tentativas por IP.
\n","urlObject":{"path":["auth","verify-token"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"ace3348b-2441-44cd-991c-fa84221bc31f","name":"200 - Token válido","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/verify-token","description":"Valida se o token de recuperação existe e ainda está dentro do prazo.\n\nRetorno padronizado:\n- `status: \"success\"` quando o token pode ser usado.\n- `status: \"error\"` quando o token está ausente, inválido, expirado, bloqueado por rate limit ou ocorre falha interna.\n\nSegurança: este endpoint possui limite de tentativas por IP."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"status\": \"success\"\n },\n \"error\": null\n}"},{"id":"a6c5b217-246e-4555-a706-870926e1e157","name":"400 - Campo obrigatório ausente","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/verify-token","description":"Valida se o token de recuperação existe e ainda está dentro do prazo.\n\nRetorno padronizado:\n- `status: \"success\"` quando o token pode ser usado.\n- `status: \"error\"` quando o token está ausente, inválido, expirado, bloqueado por rate limit ou ocorre falha interna.\n\nSegurança: este endpoint possui limite de tentativas por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"missing_required_fields\",\n \"message\": \"Missing required fields: token\",\n \"details\": {\n \"fields\": [\n \"token\"\n ]\n }\n }\n}"},{"id":"d51b8104-23cd-415d-8d3a-293cf3cc0500","name":"400 - Token inválido ou expirado","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/verify-token","description":"Valida se o token de recuperação existe e ainda está dentro do prazo.\n\nRetorno padronizado:\n- `status: \"success\"` quando o token pode ser usado.\n- `status: \"error\"` quando o token está ausente, inválido, expirado, bloqueado por rate limit ou ocorre falha interna.\n\nSegurança: este endpoint possui limite de tentativas por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"invalid_or_expired_token\",\n \"message\": \"Invalid or expired token\"\n }\n}"},{"id":"b8963230-ffe8-44b7-9d60-340c0c79d900","name":"429 - Limite de tentativas excedido","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/verify-token","description":"Valida se o token de recuperação existe e ainda está dentro do prazo.\n\nRetorno padronizado:\n- `status: \"success\"` quando o token pode ser usado.\n- `status: \"error\"` quando o token está ausente, inválido, expirado, bloqueado por rate limit ou ocorre falha interna.\n\nSegurança: este endpoint possui limite de tentativas por IP."},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Try again later.\"\n }\n}"},{"id":"6e5b13b5-41de-47f9-832c-88ccd2d548d1","name":"500 - Erro interno","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/verify-token","description":"Valida se o token de recuperação existe e ainda está dentro do prazo.\n\nRetorno padronizado:\n- `status: \"success\"` quando o token pode ser usado.\n- `status: \"error\"` quando o token está ausente, inválido, expirado, bloqueado por rate limit ou ocorre falha interna.\n\nSegurança: este endpoint possui limite de tentativas por IP."},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"internal_error\",\n \"message\": \"An unexpected error occurred\"\n }\n}"}],"_postman_id":"dd1eeede-a8f8-406e-bca0-a1cf4d84cf12"},{"name":"Trocar senha","id":"4a3cfe4a-4ca0-4041-941d-ed5f45e0c2b3","request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.
\nA senha deve atender à política de força do backend e password deve ser igual a confirmPassword.
Segurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP.
\n","urlObject":{"path":["auth","change-password"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"e41674ec-4187-4446-bd22-ea54fd2c9cf3","name":"200 - Senha alterada","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.\n\nA senha deve atender à política de força do backend e `password` deve ser igual a `confirmPassword`.\n\nSegurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP."},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"status\": \"success\"\n },\n \"error\": null\n}"},{"id":"0be6d21a-fb67-48fa-a23b-6f37d8d2125c","name":"400 - Campos obrigatórios ausentes","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.\n\nA senha deve atender à política de força do backend e `password` deve ser igual a `confirmPassword`.\n\nSegurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"missing_required_fields\",\n \"message\": \"Missing required fields: token, password, confirmPassword\",\n \"details\": {\n \"fields\": [\n \"token\",\n \"password\",\n \"confirmPassword\"\n ]\n }\n }\n}"},{"id":"e6bb792a-f6ca-4cbd-90d6-5a5de1cecaaf","name":"400 - Senhas não coincidem","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.\n\nA senha deve atender à política de força do backend e `password` deve ser igual a `confirmPassword`.\n\nSegurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"password_mismatch\",\n \"message\": \"Passwords do not match\"\n }\n}"},{"id":"38e3bd86-b2d2-4d5a-a0f2-d3d2c4d5dbcc","name":"400 - Senha fraca","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.\n\nA senha deve atender à política de força do backend e `password` deve ser igual a `confirmPassword`.\n\nSegurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"weak_password\",\n \"message\": \"A senha deve conter pelo menos 8 caracteres, incluindo letra maiúscula, letra minúscula, número e caractere especial.\"\n }\n}"},{"id":"5013ab66-65dd-4bfb-be17-593aefe14b04","name":"400 - Token inválido ou expirado","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.\n\nA senha deve atender à política de força do backend e `password` deve ser igual a `confirmPassword`.\n\nSegurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP."},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"invalid_or_expired_token\",\n \"message\": \"Invalid or expired token\"\n }\n}"},{"id":"7ece6bbe-ab42-4fe0-91ac-62990668efb6","name":"429 - Limite de tentativas excedido","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.\n\nA senha deve atender à política de força do backend e `password` deve ser igual a `confirmPassword`.\n\nSegurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP."},"status":"Too Many Requests","code":429,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"rate_limit_exceeded\",\n \"message\": \"Too many requests. Try again later.\"\n }\n}"},{"id":"d42d8048-780f-4170-b72b-498c329ac9e2","name":"500 - Erro interno","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"token\": \"token-de-recuperacao\",\n \"password\": \"NovaSenhaForte1!\",\n \"confirmPassword\": \"NovaSenhaForte1!\"\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/auth/change-password","description":"Define uma nova senha a partir de um token de recuperação válido.\n\nA senha deve atender à política de força do backend e `password` deve ser igual a `confirmPassword`.\n\nSegurança: o token é validado novamente no momento da troca e este endpoint possui limite de tentativas por IP."},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"error\",\n \"data\": null,\n \"error\": {\n \"code\": \"internal_error\",\n \"message\": \"An unexpected error occurred\"\n }\n}"}],"_postman_id":"4a3cfe4a-4ca0-4041-941d-ed5f45e0c2b3"}],"id":"34048fb4-665c-4a1a-b2a7-7fb7133b3cb0","description":"Fluxo de recuperação de senha. Por segurança, a solicitação de recuperação usa resposta genérica e pode retornar 429 quando o limite de tentativas for atingido.
\n","_postman_id":"34048fb4-665c-4a1a-b2a7-7fb7133b3cb0"},{"name":"Perfil","item":[{"name":"Consultar informações do perfil","id":"9b87e0e7-a6cd-4619-b513-52e65324d59f","request":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api.123zap}}/profile/info","description":"Retorna os dados principais do perfil do cliente autenticado.
\nUse data.plan_name, data.username, data.email, data.name, data.cpf_cnpj e data.address no frontend. Se o usuário autenticado não possuir perfil vinculado, a API retorna user_not_found.
Completa ou atualiza os dados cadastrais do cliente autenticado.
\nEsta rota é usada pelo frontend no fluxo de conclusão de cadastro/perfil. O backend define o plano padrão do cadastro e ignora plan_id enviado pelo cliente quando necessário.
Campos obrigatórios principais: person_type, firstName, lastName, cpf_cnpj, telephone, cellphone, email, zipcode, street, number, neighborhood, city e state.
Inicia a alteração de e-mail do usuário autenticado e envia um código de confirmação para o novo endereço.
\nA confirmação só é concluída na rota PUT /profile/email. A rota possui rate limit por usuário, novo e-mail e IP.
Conclui a alteração de e-mail do usuário autenticado usando o código recebido no novo endereço.
\nEnvie new_email com o mesmo endereço usado na solicitação e code com o código recebido. A rota possui rate limit por usuário, novo e-mail e IP.
Atualiza o avatar do usuário autenticado.
\nRegras atuais:
\nbase64_image no formato data:image/png;base64,....Rotas privadas de perfil do cliente autenticado.
\nContrato de resposta padronizado:
\nstatus: \"success\", data com o payload da rota e error: null.status: \"error\", data: null e error.code estável para tratamento pelo frontend.Autenticação:
\nAuthorization: {{Token}}.Client_ID: {{client_id}}, alinhado ao consumo atual do frontend.Segurança operacional:
\nEste endpoint retorna a lista de notificações do usuário logado na plataforma 123Zap. As notificações incluem mensagens informativas, alertas de sucesso, avisos importantes, falhas e lembretes — todas categorizadas por nível de prioridade com base em uma paleta de cores.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["dashboard","notifications"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"5dbc184f-867b-4777-8965-64818c600cab","name":"Consultar notificações","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/dashboard/notifications"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 21:53:53 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"225"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lwx5fhzfCYcEJqQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": 1,\n \"platform\": \"123zap\",\n \"text\": \"👋 Seja bem-vindo à 123Zap! Estamos aqui para ajudar você a se comunicar melhor com seus clientes.\",\n \"read\": false,\n \"color\": \"blue\" // Informativo\n },\n {\n \"id\": 2,\n \"platform\": \"123zap\",\n \"text\": \"✅ Canal de atendimento WhatsApp conectado com sucesso. Agora você pode começar a enviar e receber mensagens!\",\n \"read\": false,\n \"color\": \"green\" // Sucesso\n },\n {\n \"id\": 3,\n \"platform\": \"123zap\",\n \"text\": \"⚠️ Sua conta está se aproximando do limite de mensagens mensais. Considere revisar seu plano.\",\n \"read\": false,\n \"color\": \"yellow\" // Atenção\n },\n {\n \"id\": 4,\n \"platform\": \"123zap\",\n \"text\": \"❌ Seu canal foi desconectado. Reconfigure a conexão para retomar o envio de mensagens.\",\n \"read\": false,\n \"color\": \"red\" // Urgente\n },\n {\n \"id\": 5,\n \"platform\": \"123zap\",\n \"text\": \"📌 Lembre-se de revisar as mensagens automáticas antes do início da nova campanha amanhã.\",\n \"read\": false,\n \"color\": \"purple\" // Importante\n }\n ]\n}"}],"_postman_id":"67c760af-a435-447a-9a79-567241225fb5"},{"name":"Marcar notificação - Lida","id":"202ce014-abce-45a4-b6fd-ad8aae41411d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notification_id\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/campaigns/summary","description":"Este endpoint permite marcar uma notificação específica como lida no dashboard da plataforma 123zap.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["dashboard","campaigns","summary"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"0048cbfc-0688-4d37-8831-1035d27a6ea0","name":"Marcar notificação - Lida","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"notification_id\": 2\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/notification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 20:01:34 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"63"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LwhcGjDeCYcEPbQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Notification marked as read\"\n}"}],"_postman_id":"202ce014-abce-45a4-b6fd-ad8aae41411d"},{"name":"Mensagens recebidas (comprehend)","id":"13739b52-11b2-431b-aca6-eaf56e4e3209","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/dashboard/messages/received/comprehend","description":"Este endpoint retorna a análise automática de todas as mensagens de texto recebidas pelos canais da plataforma 123Zap. Através de inteligência artificial, são extraídos dados como:
\nSentimentos gerais (positivos, negativos, neutros e mistos)
\nEntidades identificadas (nomes, datas, valores, locais, organizações, etc.)
\nFrases-chave, quando aplicável
\nTotal de mensagens analisadas
\nA análise é atualizada semanalmente, sempre às segundas-feiras, com base nas mensagens disponíveis no canal de entrada.
\nEssa funcionalidade permite extrair insights relevantes sobre o comportamento dos seus clientes, ajudando na tomada de decisões estratégicas e na melhoria contínua da comunicação.
\nA análise automática das mensagens recebidas oferece uma visão estratégica do relacionamento com seus clientes. Ao compreender o tom emocional, os temas abordados e os principais elementos citados nas conversas, sua empresa pode:
\nIdentificar padrões de satisfação ou insatisfação ao longo do tempo
\n→ Ex: Aumento de sentimentos negativos após uma campanha ou falha no atendimento.
\nAjustar a comunicação para alinhar o tom e a abordagem com o que o público espera.
\nDetectar temas recorrentes ou pontos críticos que exigem ação imediata (como atrasos, preços, suporte, etc.).
\nAnalisar entidades citadas com frequência (nomes, datas, locais, valores), o que pode indicar tendências, eventos ou demandas específicas.
\nOtimizar campanhas e atendimento com base em dados reais e atualizados semanalmente.
\nEssa camada de inteligência transforma conversas comuns em informações estratégicas, permitindo decisões mais rápidas, precisas e focadas no cliente.
\n","urlObject":{"path":["dashboard","messages","received","comprehend"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"4ce60138-bdb2-40f6-9baa-968e26627828","name":"Mensagens recebidas (comprehend)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/dashboard/messages/received/comprehend"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 20:17:17 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"11282"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lwjv-jVQiYcEM2A="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"Sentimentos Gerais\": {\n \"Positive\": 15,\n \"Negative\": 3,\n \"Neutral\": 27,\n \"Mixed\": 0\n },\n \"Entidades\": [\n {\n \"Score\": 98,\n \"Type\": \"PERSON\",\n \"Text\": \"Carlos Eduardo\",\n \"BeginOffset\": 0,\n \"EndOffset\": 14\n },\n {\n \"Score\": 97,\n \"Type\": \"DATE\",\n \"Text\": \"05 de junho de 2025\",\n \"BeginOffset\": 25,\n \"EndOffset\": 45\n },\n {\n \"Score\": 96,\n \"Type\": \"QUANTITY\",\n \"Text\": \"R$ 2.350,00\",\n \"BeginOffset\": 48,\n \"EndOffset\": 59\n },\n {\n \"Score\": 95,\n \"Type\": \"LOCATION\",\n \"Text\": \"Agência Centro - São Paulo\",\n \"BeginOffset\": 62,\n \"EndOffset\": 89\n },\n {\n \"Score\": 94,\n \"Type\": \"ORGANIZATION\",\n \"Text\": \"Banco Itaú\",\n \"BeginOffset\": 92,\n \"EndOffset\": 102\n },\n {\n \"Score\": 87,\n \"Type\": \"TITLE\",\n \"Text\": \"Comprovante de Transferência\",\n \"BeginOffset\": 105,\n \"EndOffset\": 134\n },\n {\n \"Score\": 99,\n \"Type\": \"OTHER\",\n \"Text\": \"chave pix\",\n \"BeginOffset\": 137,\n \"EndOffset\": 147\n }\n ],\n \"Frases-Chave\": [],\n \"Total de Mensagens\": 1083\n }\n}\n"}],"_postman_id":"13739b52-11b2-431b-aca6-eaf56e4e3209"},{"name":"Campanhas enviadas (sintético)","id":"6fa0581d-02ac-4545-be66-1cff28ff22ae","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"start_date\": \"01/06/2025\",\r\n \"end_date\": \"04/06/2025\",\r\n \"name_campaign\": \"D-10\",\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/campaigns/summary","description":"Este endpoint permite consultar o histórico de execuções de uma campanha, retornando um resumo diário com a contagem de mensagens em diferentes status (lido, entregue, falha etc.) dentro do intervalo de datas especificado. Pode ser utilizado para geração de relatórios, acompanhamento de desempenho e auditoria de envios.
\nOs seguintes atributos devem ser passados:
\nDescrição dos Campos da Resposta;
\n","urlObject":{"path":["dashboard","campaigns","summary"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"850308bb-97c4-4233-aca8-4d4ab970448c","name":"Campanhas enviadas (sintético)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"start_date\": \"01/06/2025\",\r\n \"end_date\": \"04/06/2025\",\r\n \"name_campaign\": \"D-10\",\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/campaigns/summary"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Jun 2025 12:37:09 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"1036"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"L8sGTipxCYcEJPA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"data_execucao\": \"04/06/2025 14:09:15\",\n \"nome_campanha\": \"D-10\",\n \"descricao_campanha\": \"D-10\",\n \"mensagens_totais\": 0,\n \"status_espera\": 0,\n \"status_lido\": 0,\n \"status_falha\": 0,\n \"status_entregue\": 0,\n \"status_nao_confirmado\": 0,\n \"status_desconhecido\": 0,\n \"uuid_campanha\": \"f80fad14-c522-4d48-ae0b-33a6cb8e641b\"\n },\n {\n \"data_execucao\": \"03/06/2025 14:03:05\",\n \"nome_campanha\": \"D-10\",\n \"descricao_campanha\": \"D-10\",\n \"mensagens_totais\": 0,\n \"status_espera\": 0,\n \"status_lido\": 0,\n \"status_falha\": 0,\n \"status_entregue\": 0,\n \"status_nao_confirmado\": 0,\n \"status_desconhecido\": 0,\n \"uuid_campanha\": \"316ba45b-beb9-4b50-b22a-9941ae141885\"\n },\n {\n \"data_execucao\": \"02/06/2025 14:07:03\",\n \"nome_campanha\": \"D-10\",\n \"descricao_campanha\": \"D-10\",\n \"mensagens_totais\": 0,\n \"status_espera\": 0,\n \"status_lido\": 0,\n \"status_falha\": 0,\n \"status_entregue\": 0,\n \"status_nao_confirmado\": 0,\n \"status_desconhecido\": 0,\n \"uuid_campanha\": \"1bf8fa1c-4ac6-428f-acaa-524d87daedbe\"\n }\n ],\n \"last_updated\": \"2025-06-10T12:37:07.955301Z\",\n \"status_file\": \"generated\"\n}"}],"_postman_id":"6fa0581d-02ac-4545-be66-1cff28ff22ae"},{"name":"Campanhas enviadas (mês)","id":"554d757b-d83e-4906-8140-2c1aa322d15e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"start_date\": \"01/01/2025\",\r\n \"end_date\": \"30/06/2025\",\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/messages/sent/monthly","urlObject":{"path":["dashboard","messages","sent","monthly"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"210a21a2-c89b-4adf-b8f1-812ee68125d2","name":"Campanhas enviadas (mês)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"start_date\": \"01/06/2025\",\r\n \"end_date\": \"30/06/2025\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/messages/sent/monthly"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Jun 2025 12:31:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"651"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"L8rOwj9WiYcEMkg="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"month_year\": \"2025-06\",\n \"status_count\": 3170,\n \"final_status\": \"delivered\"\n },\n {\n \"month_year\": \"2025-06\",\n \"status_count\": 15,\n \"final_status\": \"entregue celular\"\n }\n ],\n \"last_updated\": \"2025-06-09T17:14:15.020005Z\",\n \"status_file\": \"generated\"\n}"}],"_postman_id":"554d757b-d83e-4906-8140-2c1aa322d15e"},{"name":"Mensagens recebidas (mês)","id":"666f790c-67b2-4d0c-bb75-0e9a6c591177","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/messages/received/monthly","urlObject":{"path":["dashboard","messages","received","monthly"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"ff9a5ff7-ac6e-4c23-bccf-d516af032b47","name":"Mensagens recebidas (mês)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/messages/received/monthly"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Jun 2025 12:56:55 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"953"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"L8u_uh10iYcEP-g="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"month_year\": \"2024-08\",\n \"final_status\": \"received\",\n \"status_count\": 1680\n },\n {\n \"month_year\": \"2024-09\",\n \"final_status\": \"received\",\n \"status_count\": 1803\n },\n {\n \"month_year\": \"2024-10\",\n \"final_status\": \"received\",\n \"status_count\": 2222\n },\n {\n \"month_year\": \"2024-11\",\n \"final_status\": \"received\",\n \"status_count\": 1846\n },\n {\n \"month_year\": \"2024-12\",\n \"final_status\": \"received\",\n \"status_count\": 2783\n },\n {\n \"month_year\": \"2025-01\",\n \"final_status\": \"received\",\n \"status_count\": 2537\n },\n {\n \"month_year\": \"2025-02\",\n \"final_status\": \"received\",\n \"status_count\": 2151\n },\n {\n \"month_year\": \"2025-03\",\n \"final_status\": \"received\",\n \"status_count\": 3985\n },\n {\n \"month_year\": \"2025-04\",\n \"final_status\": \"received\",\n \"status_count\": 3728\n },\n {\n \"month_year\": \"2025-05\",\n \"final_status\": \"received\",\n \"status_count\": 3861\n },\n {\n \"month_year\": \"2025-06\",\n \"final_status\": \"received\",\n \"status_count\": 1232\n }\n ],\n \"last_updated\": \"2025-06-10T12:56:28.013915Z\",\n \"status_file\": \"generated\"\n}"}],"_postman_id":"666f790c-67b2-4d0c-bb75-0e9a6c591177"},{"name":"Campanhas status (total)","id":"2a7e3110-1e28-4343-b491-31fd5b958c2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/total/generated","urlObject":{"path":["dashboard","total","generated"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"aa676c6f-70a8-4cc4-bc5a-2d71ddf20776","name":"Campanhas enviadas (mês) Copy","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/total/generated"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 10 Jun 2025 12:55:13 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"272"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"L8uvcgo6CYcEPeA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": {\n \"messages_general\": 165243,\n \"total_read\": 90025,\n \"total_failed\": 25676,\n \"total_send\": 39936,\n \"total_unknown\": 1075,\n \"total_not_confirmed\": 6946,\n \"total_waiting\": 76\n },\n \"last_updated\": \"2025-06-10T12:46:03.543338Z\",\n \"status_file\": \"generated\"\n}"}],"_postman_id":"2a7e3110-1e28-4343-b491-31fd5b958c2d"},{"name":"Mensagens enviadas (linhas)","id":"ede82e9a-9acf-42b3-8c7c-b2fc6971cf69","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"start_date\": \"01/01/2025\",\r\n \"end_date\": \"30/06/2025\",\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/messages/sent/lines","urlObject":{"path":["dashboard","messages","sent","lines"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"ede82e9a-9acf-42b3-8c7c-b2fc6971cf69"},{"name":"Mensagens recebidas (linhas)","id":"5cfe2226-1fe1-46d8-8379-0ebc1733b5b1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"start_date\": \"01/01/2025\",\r\n \"end_date\": \"30/06/2025\",\r\n \"refresh\": true\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/dashboard/messages/received/lines","urlObject":{"path":["dashboard","messages","received","lines"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"5cfe2226-1fe1-46d8-8379-0ebc1733b5b1"}],"id":"2f1654ec-71b1-4cef-b38b-aae0b25add78","description":"Esta sessão reúne rotas que fornecem dados e funcionalidades relacionadas ao painel principal do usuário. Além de apresentar notificações, mensagens, e análises, ela também oferece consultas de dados essenciais para acompanhamento do desempenho e gestão do canal na plataforma 123Zap.
\nO objetivo é entregar uma visão consolidada e estratégica, facilitando o monitoramento e a tomada de decisões.
\n","_postman_id":"2f1654ec-71b1-4cef-b38b-aae0b25add78"},{"name":"ERPs","item":[{"name":"Consultar ERPs disponiveis","id":"1362904c-f680-497a-a66a-746c45289258","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api.123zap}}/erp/list","description":"Este endpoint permite consultar todos os ERPs que a 123Zap oferece para integração. A resposta inclui informações como nome, descrição, status de disponibilidade, logo e categoria de cada ERP.
\n","urlObject":{"path":["erp","list"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"7b53b3c5-7837-4787-abf2-a48008734cf7","name":"Consultar ERPs disponiveis","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api.123zap}}/erp/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 15:33:05 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"1831"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LY1jIiEXiYcEMIQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"12345-12345-12345\",\n \"title\": \"EliteSoft\",\n \"description\": \"Sistema de gestão empresarial para provedores de internet...\",\n \"status\": \"Disponível\",\n \"logo\": \"https://example.com.br\",\n \"category\": \"ERP provedor\"\n }\n ]\n}"}],"_postman_id":"1362904c-f680-497a-a66a-746c45289258"},{"name":"Consultar ERPs cadastrados","id":"8fce9aa5-9e94-4199-ba88-face02517c0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api.123zap}}/erp/credentials","description":"Este endpoint mostra os ERPs que você já cadastrou e configurou na plataforma 123Zap. A resposta traz detalhes importantes, como o nome do ERP, o status da integração, a categoria e até o logo.
\nOu seja, depois que você adicionar suas credenciais de acesso ao ERP, ele vai aparecer nessa lista para facilitar o seu controle.
\n","urlObject":{"path":["erp","credentials"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"19ba612e-79bf-4632-bf7c-43b41835bc00","name":"Consultar Credenciais cadastradas","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":"{{api.123zap}}/erp/credentials/consult"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 15:55:03 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"303"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LY4xVhY3iYcEPRQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"1234-1234-1234\",\n \"status\": \"active\",\n \"integration_title\": \"Controllr ISP\",\n \"integration_logo\": \"https://exemplo.com.br\",\n \"integration_category\": \"ERP provedor\"\n }\n ]\n}"}],"_postman_id":"8fce9aa5-9e94-4199-ba88-face02517c0f"},{"name":"Hubsoft - Adicionar credencial","id":"af3d46c5-77e5-4f02-a62d-dae4e4c769b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.hubsoft.com.br\",\r\n \"client_id\": 0,\r\n \"client_secret\": \"ABCDEF123\",\r\n \"username\": \"User\",\r\n \"password\": \"Password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/hubsoft","description":"Este endpoint permite adicionar e configurar as credenciais de acesso ao ERP HubSoft dentro da plataforma 123Zap. Através dele, é possível estabelecer a conexão segura com o ERP para integrações automáticas.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","hubsoft"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"4846c709-3b2a-4d92-b940-afdadea091ff","name":"Hubsoft - Adicionar credencial","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.hubsoft.com.br\",\r\n \"client_id\": 0,\r\n \"client_secret\": \"ABCDEF123\",\r\n \"username\": \"User\",\r\n \"password\": \"Password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/hubsoft"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 16:09:30 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LY64QjrriYcEJcA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"af3d46c5-77e5-4f02-a62d-dae4e4c769b0"},{"name":"Hubsoft - Consultar faturas","id":"af3e30b0-b1c0-4186-baae-662596900141","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pagina\": 1,\r\n \"busca\": \"\",\r\n \"valor_busca\": \"\",\r\n \"tipo_data\": \"data_vencimento\",\r\n \"data_inicio\": \"2025-05-01\",\r\n \"data_fim\": \"2025-05-31\",\r\n \"tipo_resultado\": \"detalhado\",\r\n \"apenas_quitado\": \"nao\",\r\n \"apenas_em_aberto\": \"sim\",\r\n \"valor_zerado\": \"nao\",\r\n \"exibir_pix_copia_cola\": \"sim\",\r\n \"exibir_fatura_inativa\": \"nao\",\r\n \"exibir_faturas_renegociacao\": \"nao\",\r\n \"status_cadastro_cliente\": \"ativo\",\r\n \"campos\": [\"\"] // \"ID_Fatura\", \"Data_Vencimento\", \"Valor_Total\", \"Código_Barras\", \"Link_PDF\", \"Cliente_ID\", \"Contrato_ID\", \"Nome_Completo\", CPF_CNPJ\", \"Telefone_01\", \"Telefone_02\", \"Telefone_03\", \"Email_01\", \"Email_02\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/hubsoft/invoices","description":"Este endpoint permite consultar as faturas abertas (ou de outros status) diretamente no ERP HubSoft, possibilitando gerar listas de cobranças, acompanhar inadimplências, criar dashboards ou realizar integrações com fluxos externos.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","hubsoft","invoices"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"aa2bfb37-be15-43eb-9e59-9dc7bb551e49","name":"Hubsoft - Consultar faturas","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pagina\": 1,\r\n \"busca\": \"\",\r\n \"valor_busca\": \"\",\r\n \"tipo_data\": \"data_vencimento\",\r\n \"data_inicio\": \"2025-05-01\",\r\n \"data_fim\": \"2025-05-31\",\r\n \"tipo_resultado\": \"detalhado\",\r\n \"apenas_quitado\": \"nao\",\r\n \"apenas_em_aberto\": \"sim\",\r\n \"valor_zerado\": \"nao\",\r\n \"exibir_pix_copia_cola\": \"sim\",\r\n \"exibir_fatura_inativa\": \"nao\",\r\n \"exibir_faturas_renegociacao\": \"nao\",\r\n \"status_cadastro_cliente\": \"ativo\",\r\n \"campos\": [\"\"] // \"ID_Fatura\", \"Data_Vencimento\", \"Valor_Total\", \"Código_Barras\", \"Link_PDF\", \"Cliente_ID\", \"Contrato_ID\", \"Nome_Completo\", CPF_CNPJ\", \"Telefone_01\", \"Telefone_02\", \"Telefone_03\", \"Email_01\", \"Email_02\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/hubsoft/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 16:44:34 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"28693"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LZABKjlIiYcEPTA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\":\"success\",\n \"total_pages\": 1000,\n \"current_page\":1,\n \"invoices\":[\n {\n \"ID_Fatura\":\"ABCD-EFGH-IJKL\",\n \"Data_Vencimento\":\"2025-05-10\",\n \"Valor_Total\": 89.9,\n \"C\\u00f3digo_Barras\":\"00000.1110.00000.00000.000000.0000\",\n \"Link_PDF\":\"https://api.your.hubsoft.com.br/pdf/fatura/{id}\",\n \"Cliente_ID\": 110,\n \"Contrato_ID\": 100,\n \"Nome_Completo\":\"PATRICIA APARECIDA RIBEIRO\",\n \"CPF_CNPJ\":\"0000000000\",\n \"Telefone_01\": \"(DD) 9 99999999\",\n \"Telefone_02\": \"(DD) 9 99999999\",\n \"Telefone_03\": \"(DD) 9 99999999\",\n \"Email_01\": \"01@email.com.br\",\n \"Email_02\": \"02@email.com.br\"\n }\n ]\n}"}],"_postman_id":"af3e30b0-b1c0-4186-baae-662596900141"},{"name":"Controllr - Adicionar credencial","id":"86beee6c-d09a-4e7a-aee2-94c6f11925e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.controllr.com.br\",\r\n \"username\": \"User\",\r\n \"password\": \"Password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/controllr","description":"Este endpoint permite adicionar à plataforma as credenciais de conexão com o ERP ISP Controllr, possibilitando realizar integrações, consultas de dados e automações diretamente a partir do ERP.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","controllr"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"1a6ed9c0-7c22-4ef9-a5f7-a3b98d9f1459","name":"Controllr - Adicionar credencial","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.controllr.com.br\",\r\n \"username\": \"User\",\r\n \"password\": \"Password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/controllr"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 16:52:40 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LZBNQishCYcEJiA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"86beee6c-d09a-4e7a-aee2-94c6f11925e6"},{"name":"Controllr - Consultar faturas","id":"f8d1a79f-47b1-4ce6-8778-81aefbd6eae1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pagina\": 1,\r\n \"data_vencimento_inicio\": \"01/05/2025\",\r\n \"data_vencimento_fim\": \"20/05/2025\",\r\n \"status\": \"aberto\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/controllr/invoices","description":"Este endpoint permite consultar as faturas abertas, quitadas ou em qualquer status diretamente no ERP Controllr, possibilitando gerar listas, relatórios ou automações dentro da plataforma 123Zap.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","controllr","invoices"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"853beab7-80ca-44ff-bb17-7fa7194e57d3","name":"Controllr - Consultar faturas","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pagina\": 1,\r\n \"data_vencimento_inicio\": \"01/05/2025\",\r\n \"data_vencimento_fim\": \"20/05/2025\",\r\n \"status\": \"aberto\"\r\n} ","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/controllr/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 18:27:43 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"6076"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LZPGxi0_iYcEMTA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"total_pages\": 1000,\n \"current_page\": 1,\n \"invoices\": [\n {\n \"ID_Fatura\": 1002,\n \"Data_Vencimento\": \"20/05/2025\",\n \"Valor_Total\": \"199.80\",\n \"Código_Barras\": \"00000. 00000 000000 0000000\",\n \"Link_PDF\": \"https://your.controllr.com.br/p/inv?{id}\",\n \"Nome_Completo\": \"ALAN AUGUSTO GOMES\",\n \"Contrato\": 16,\n \"Rua\": \"Rua A - 2290\",\n \"Código_PIX\": \"00020101021226950014br.gov.bcb.pix...\",\n \"WhatsApp\": \"31999999999\",\n \"Telefone_01\": \"\",\n \"Telefone_02\": \"\",\n \"Email_01\": \"your@email.com\",\n \"Email_02\": \"\"\n }\n ]\n}"}],"_postman_id":"f8d1a79f-47b1-4ce6-8778-81aefbd6eae1"},{"name":"SGP - Adicionar credencial","id":"ca1cd325-fd29-412a-9513-15aa2501f889","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.sgp.com.br\",\r\n \"app\": \"Name\",\r\n \"token\": \"ABCDEF123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sgp","description":"Este endpoint permite adicionar à plataforma a credencial de conexão com o ERP SGP, possibilitando a criação de listas de dados diretamente a partir do ERP para integração com a plataforma 123Zap.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","sgp"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"bf120e93-27f1-4872-b13e-3e754e982ae4","name":"SGP - Adicionar credencial","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.sgp.com.br\",\r\n \"app\": \"Name\",\r\n \"token\": \"ABCDEF123\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sgp"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 18:38:52 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LZQwvhHtiYcEJ-g="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"ca1cd325-fd29-412a-9513-15aa2501f889"},{"name":"SGP - Consultar faturas","id":"034329be-8d1d-4e6f-b93f-b18c68505ca6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pagina\": 1,\r\n \"cliente_id\": \"\",\r\n \"cpfcnpj\": \"\",\r\n \"plano\": \"\",\r\n \"contrato\": \"\",\r\n \"status\": \"aberto\",\r\n \"portador\": \"\",\r\n \"contrato_status\": \"\",\r\n \"tipo_servico\": \"\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"campos\": [\"\"] // \"ID_Fatura\", \"Data_Vencimento\", \"Valor_Total\", \"Código_Barras\", \"Link_PDF\", \"Nome_Completo\", CPF_CNPJ\", \"Telefone_01\", \"Telefone_02\", \"Telefone_03\", \"Email_01\", \"Email_02\", WhatsApp\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sgp/invoices","description":"Este endpoint permite consultar as faturas abertas no ERP SGP, possibilitando a criação de listas de dados diretamente a partir do ERP para integração com a plataforma 123Zap.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","sgp","invoices"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"2cd21b94-894e-4dee-9e55-dbedc12c9ec3","name":"SGP - Consultar faturas","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"pagina\": 1,\r\n \"cliente_id\": \"\",\r\n \"cpfcnpj\": \"\",\r\n \"plano\": \"\",\r\n \"contrato\": \"\",\r\n \"status\": \"aberto\",\r\n \"portador\": \"\",\r\n \"contrato_status\": \"\",\r\n \"tipo_servico\": \"\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"campos\": [\"\"] // \"ID_Fatura\", \"Data_Vencimento\", \"Valor_Total\", \"Código_Barras\", \"Link_PDF\", \"Nome_Completo\", CPF_CNPJ\", \"Telefone_01\", \"Telefone_02\", \"Telefone_03\", \"Email_01\", \"Email_02\", WhatsApp\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sgp/invoices"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 30 May 2025 18:50:02 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"47188"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LZSYJg7_CYcEJpg="}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"success\",\n \"total_pages\": 15,\n \"invoices\": [\n {\n \"ID_Fatura\": 542913,\n \"Data_Vencimento\": \"2025-05-30\",\n \"Valor_Total\": 50,\n \"Código_Barras\": \"00190.00001 0000000 00000000 00000000000\",\n \"Link_PDF\": \"http://your.sgp/boleto/{id}/\",\n \"Nome_Completo\": \"ABRAAO VIANA DA COSTA\",\n \"CPF_CNPJ\": \"000.000.000-00\",\n \"Telefone_01\": \"31999999999\",\n \"Telefone_02\": \"31999999999\",\n \"Telefone_03\": \"31999999999\",\n \"Email_01\": \"your@email.com.br\",\n \"Email_02\": \"your@email.com.br\",\n \"WhatsApp\": \"31999999999\"\n }\n ]\n}"}],"_postman_id":"034329be-8d1d-4e6f-b93f-b18c68505ca6"},{"name":"EliteSoft - Adicionar credencial","id":"f70be002-0e27-4440-ba3d-b2177a566279","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://integrator.viafibra.com.br/integrator.server.php\",\r\n \"_user\": \"275Z0X5WSB\",\r\n \"_passwd\": \"275Z0X5YHN\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/elitesoft","description":"Este endpoint permite adicionar e configurar as credenciais de acesso ao ERP HubSoft dentro da plataforma 123Zap. Através dele, é possível estabelecer a conexão segura com o ERP para integrações automáticas.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","elitesoft"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"3deb3719-f749-486b-aae8-d61c4bd53a7e","name":"EliteSoft - Adicionar credencial","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://integrator.viafibra.com.br/integrator.server.php\",\r\n \"_user\": \"275Z0X5WSB\",\r\n \"_passwd\": \"275Z0X5YHN\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/elitesoft"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 22:30:27 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Mo5MAjZpIAMEbeA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"f70be002-0e27-4440-ba3d-b2177a566279"},{"name":"Sienge - Adicionar credencial","id":"f10c6399-202d-482a-90d3-af63ba399592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://api.sienge.com.br/\",\r\n \"username\": \"User\",\r\n \"password\": \"Password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sienge","description":"Este endpoint permite adicionar e configurar as credenciais de acesso ao ERP Sienge dentro da plataforma 123zap. Através dele, é possível estabelecer a conexão segura com o ERP para integrações automáticas.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","sienge"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"7525fa79-aeb4-4fa3-9c54-0c569086ad14","name":"Sienge - Adicionar credencial","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.sienge.com.br\",\r\n \"username\": \"User\",\r\n \"password\": \"Password\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sienge"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 22 Sep 2025 15:37:22 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"RT3_XjH9oAMEYoQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"f10c6399-202d-482a-90d3-af63ba399592"}],"id":"23465924-f341-4a51-8f43-59b655ff9545","description":"A 123zap conecta nossa plataforma aos ERPs que você já usa, facilitando a troca de informações e deixando tudo mais automático e eficiente. Aqui você encontra as principais rotas para conectar sua conta com segurança e fazer consultas já pré-configuradas.
\nAlguns dos ERPs que já integram com a gente:
\nHubSoft
\nISP Controllr
\nSGP
\nEliteSoft
\nVoalle
\nNão encontrou seu sistema aqui? Sem problema! Dê uma olhada nas chamadas via API REST para criar integrações personalizadas, ou fale com nosso suporte para ver como podemos ajudar a conectar seu sistema.
\n","_postman_id":"23465924-f341-4a51-8f43-59b655ff9545"},{"name":"Listagens","item":[{"name":"Listar planilhas","id":"fa00dc89-9745-4270-972c-dcf074a4b040","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/sheets/list","description":"Este endpoint permite recuperar todas as listagens (planilhas) que foram cadastradas na plataforma 123Zap. As listagens são utilizadas como fontes de dados para execução de campanhas, envios de mensagens, automações ou integrações.
\n","urlObject":{"path":["sheets","list"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"978b0a53-a04a-4e1e-81ab-b9a719ef8927","name":"Listar planilhas","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/sheets/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 18:29:14 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"1181"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LpuC2hWCiYcEMhg="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"code\": \"541214cf-1968-44ca-878e-2264ada3e275\",\n \"title\": \"yourTitle\",\n \"description\": \"description\",\n \"created_at\": \"2025-06-04T18:28:24.546740\",\n \"type\": \"Google planilhas\",\n \"url\": \"https://docs.google.com/spreadsheets/d/1yxxwAOjMme1NT4vx1QKgWFmC8vIiIkGuCq_r9zeDkn8/edit?gid=819123866#gid=819123866\",\n \"method\": \"GET\",\n \"status\": \"active\",\n \"file_name\": null,\n \"file_url\": null,\n \"file_type\": null\n }\n ]\n}"}],"_postman_id":"fa00dc89-9745-4270-972c-dcf074a4b040"},{"name":"Deletar planilha","id":"f887b616-4c4b-4e6f-8409-c239e308b2db","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/sheets?id=504ee19d-5231-4b2b-8b51-750f4e2ffbd9","description":"Este endpoint permite excluir uma planilha/listagem específica da plataforma 123Zap, identificada pelo seu id. Após a exclusão, a planilha não estará mais disponível para uso em campanhas ou consultas.
Os seguintes parâmetros devem ser passados:
\nEndFragment
\n","urlObject":{"path":["sheets"],"host":["{{api.123zap}}"],"query":[{"key":"id","value":"504ee19d-5231-4b2b-8b51-750f4e2ffbd9"}],"variable":[]}},"response":[{"id":"46c25dfc-e87d-4de8-a169-efbd7367a215","name":"Deletar planilha","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"url":{"raw":"{{api.123zap}}/sheets?id=8693aa71-83c1-4384-8026-3df0175c443c","host":["{{api.123zap}}"],"path":["sheets"],"query":[{"key":"id","value":"8693aa71-83c1-4384-8026-3df0175c443c"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 19:41:08 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lp4k1ibliYcEMKA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"f887b616-4c4b-4e6f-8409-c239e308b2db"},{"name":"Consultar variaveis - Planilha","id":"1003e4d6-c50e-4473-aec4-d2a444e60986","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/variables/check?code=fd67aad6-c21f-4beb-954a-20d5be0c540e","description":"Este endpoint permite consultar a padronização das variáveis associadas a uma planilha específica, usando o código de identificação fornecido.
\nNa plataforma 123Zap, existem variáveis padrões como Nome_Completo, Data_Vencimento, entre outras, que representam campos comuns usados para organizar e processar os dados da planilha de forma consistente.
\nNo momento da criação da planilha, o cliente precisa informar essa padronização, relacionando o nome das colunas na sua tabela (field) às variáveis padrões da 123Zap (variable).
\nEssa padronização garante que os dados sejam interpretados corretamente pela plataforma, facilitando a integração e o processamento automático.
\nAo consultar este endpoint, você obtém a lista dessas variáveis relacionadas à sua tabela, conforme a padronização feita inicialmente.
\n","urlObject":{"path":["sheets","variables","check"],"host":["{{api.123zap}}"],"query":[{"key":"code","value":"fd67aad6-c21f-4beb-954a-20d5be0c540e"}],"variable":[]}},"response":[{"id":"78766525-5c9f-4e30-b13f-c537601b481e","name":"Consultar variaveis","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api.123zap}}/sheets/variables/check?code=fd67aad6-c21f-4beb-954a-20d5be0c540e","host":["{{api.123zap}}"],"path":["sheets","variables","check"],"query":[{"key":"code","value":"fd67aad6-c21f-4beb-954a-20d5be0c540e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Jun 2025 15:24:26 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"147"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lsl6ThNLCYcEJ4A="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": 155,\n \"id_list\": \"fd67aad6-c21f-4beb-954a-20d5be0c540e\",\n \"name\": \"Nome_Completo\",\n \"column\": \"Nome_Completo\"\n }\n ]\n}"}],"_postman_id":"1003e4d6-c50e-4473-aec4-d2a444e60986"},{"name":"Consultar variaveis - Geral","id":"94d7caa5-babc-4d3b-a3ba-a8180de5bfe3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/variables/general","description":"Como mencionado, na plataforma 123Zap existem variáveis padrão, como Nome_Completo, Data_Vencimento, entre outras, que representam campos comuns utilizados para organizar e processar os dados da planilha de forma consistente.
\nAo consultar este endpoint, você obtém uma listagem com todas as variáveis disponíveis na plataforma, que podem ser utilizadas para padronizar e estruturar seus dados corretamente.
\n","urlObject":{"path":["sheets","variables","general"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"3515c481-906f-450f-b3ea-c6fc51ef55d5","name":"Consultar variaveis","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api.123zap}}/sheets/variables/check?code=fd67aad6-c21f-4beb-954a-20d5be0c540e","host":["{{api.123zap}}"],"path":["sheets","variables","check"],"query":[{"key":"code","value":"fd67aad6-c21f-4beb-954a-20d5be0c540e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Jun 2025 15:24:26 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"147"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lsl6ThNLCYcEJ4A="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": 155,\n \"id_list\": \"fd67aad6-c21f-4beb-954a-20d5be0c540e\",\n \"name\": \"Nome_Completo\",\n \"column\": \"Nome_Completo\"\n }\n ]\n}"},{"id":"fc42a9b7-ba2c-48d9-9721-804a8829c8d6","name":"Consultar variaveis - Geral","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/variables/general"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Jun 2025 15:53:56 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"4265"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LsqORjWPCYcEPCQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"variableName\": \"Contrato_ID\",\n \"category\": \"Informações Pessoais\"\n },\n {\n \"variableName\": \"Cliente_ID\",\n \"category\": \"Informações Pessoais\"\n },\n {\n \"variableName\": \"Nome\",\n \"category\": \"Informações Pessoais\"\n },\n {\n \"variableName\": \"Documento_02\",\n \"category\": \"Informações Pessoais\"\n },\n {\n \"variableName\": \"Documento_01\",\n \"category\": \"Informações Pessoais\"\n },\n {\n \"variableName\": \"Data_Nascimento\",\n \"category\": \"Informações Pessoais\"\n },\n {\n \"variableName\": \"Nome_Completo\",\n \"category\": \"Informações Pessoais\"\n },\n {\n \"variableName\": \"País\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"Cidade\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"Rua\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"Estado\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"Número\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"Complemento\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"Bairro\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"CEP\",\n \"category\": \"Endereço\"\n },\n {\n \"variableName\": \"Social_Media_02\",\n \"category\": \"Contato\"\n },\n {\n \"variableName\": \"WhatsApp\",\n \"category\": \"Contato\"\n },\n {\n \"variableName\": \"Email\",\n \"category\": \"Contato\"\n },\n {\n \"variableName\": \"Telefone_01\",\n \"category\": \"Contato\"\n },\n {\n \"variableName\": \"Telefone_02\",\n \"category\": \"Contato\"\n },\n {\n \"variableName\": \"Telefone_03\",\n \"category\": \"Contato\"\n },\n {\n \"variableName\": \"Social_Media_01\",\n \"category\": \"Contato\"\n },\n {\n \"variableName\": \"Banco\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Serviço\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Descrição\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Status\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Desconto_02_Valor_Perc\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Desconto_03_Lista_Data\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Desconto_03_Valor_Perc\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Desconto_Modalidade\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Emissão\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"ID_Fatura\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Código_Barras\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Data_Vencimento\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Valor_Total\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Descrição_Detalhada\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Link_PDF\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Natureza_Financeira\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Tipo_Faturamento\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Referência_Contrato\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Valor_Pago\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Referência_01\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Referência_02\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Referência_03\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Referência_04\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Referência_05\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"CPF_CNPJ\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Multa_Modalidade\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Multa_Valor\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Juros_Modalidade\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Juros_Valor\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Abatimento_Modalidade\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Abatimento_Valor_Perc\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Desconto_01_Lista_Data\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Desconto_01_Valor_Perc\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Desconto_02_Lista_Data\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Dias_Vencimento\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Dia_Recebimento\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Ano_Recebimento\",\n \"category\": \"Referências Financeiras\"\n },\n {\n \"variableName\": \"Mês_Recebimento\",\n \"category\": \"Referências Financeiras\"\n }\n ]\n}"}],"_postman_id":"94d7caa5-babc-4d3b-a3ba-a8180de5bfe3"},{"name":"Consultar acesso - Google Planilhas","id":"23d136e4-4058-4097-8938-c3e0542102a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/google/check?url=https://docs.google.com/spreadsheets/d/1yxxwAOjMme1NT4vx1QKgWFmC8vIiIkGuCq_r9zeDkn8/edit?gid=819123866%23gid=819123866","description":"Este endpoint verifica se a plataforma 123Zap tem acesso à planilha Google Sheets fornecida na URL. A verificação confirma se a planilha está compartilhada corretamente e acessível para uso nas suas campanhas e listagens.
\n\n\n⚠️ Atenção: Para que a 123Zap consiga acessar sua planilha, é necessário compartilhá-la com o e-mail planilhas-n8n@projeto-brio-n8n.iam.gserviceaccount.com Sem esse compartilhamento, a plataforma não terá permissão para ler os dados.
\n
Os seguintes parâmetros devem ser passados:
\n","urlObject":{"path":["sheets","google","check"],"host":["{{api.123zap}}"],"query":[{"key":"url","value":"https://docs.google.com/spreadsheets/d/1yxxwAOjMme1NT4vx1QKgWFmC8vIiIkGuCq_r9zeDkn8/edit?gid=819123866#gid=819123866"}],"variable":[]}},"response":[{"id":"ee123639-cb45-4e64-8fe1-9434012fb125","name":"Consultar acesso Google","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api.123zap}}/sheets/google/check?url=https://docs.google.com/spreadsheets/d/1yxxwAOjMme1NT4vx1QKgWFmC8vIiIkGuCq_r9zeDkn8/edit?gid=819123866%23gid=819123866","host":["{{api.123zap}}"],"path":["sheets","google","check"],"query":[{"key":"url","value":"https://docs.google.com/spreadsheets/d/1yxxwAOjMme1NT4vx1QKgWFmC8vIiIkGuCq_r9zeDkn8/edit?gid=819123866%23gid=819123866"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 17:04:57 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"321"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lphs1iUyCYcEJ5A="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Google Sheets access is active\",\n \"item_example\": {\n \"Nome_Completo \": \"Maria Eduarda\",\n \"Contrato_ID \": \"1001\",\n \"CEP\": \"10100-000\",\n \"Email\": \"maria@exemplo.com\",\n \"Telefone_01\": \"3133123333\",\n \"Data_Vencimento\": \"30/05/2025\",\n \"Valor_Total\": \"149.99\",\n \"WhatsApp\": \"3199999999\"\n }\n}"}],"_postman_id":"23d136e4-4058-4097-8938-c3e0542102a8"},{"name":"Adicionar listagem - Google Planilhas","id":"002099d0-b1d9-4b41-b0e6-198cc5e929bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"yourTitle\",\r\n \"desc\": \"description\",\r\n \"url\": \"https://docs.google.com/spreadsheets/d/1yxxwAOjMme1NT4vx1QKgWFmC8vIiIkGuCq_r9zeDkn8/edit?gid=819123866#gid=819123866\",\r\n \"variables\": [\r\n {\r\n \"field\": \"cliente\",\r\n \"variable\": \"Nome_Completo\"\r\n },\r\n {\r\n \"field\": \"WhatsApp\",\r\n \"variable\": \"WhatsApp\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/google/add","description":"Este endpoint permite adicionar uma nova listagem à plataforma 123Zap a partir de uma planilha do Google Sheets.
\nVocê pode definir um título, descrição e mapear os campos da planilha para variáveis internas da 123Zap, tornando o envio de mensagens altamente personalizado.
\nOs seguintes atributos devem ser passados:
\nEndFragment
\n","urlObject":{"path":["sheets","google","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"02fad1d4-0a88-41ff-a307-39837f28caa7","name":"Adicionar listagem","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"yourTitle\",\r\n \"desc\": \"description\",\r\n \"url\": \"https://docs.google.com/spreadsheets/d/1yxxwAOjMme1NT4vx1QKgWFmC8vIiIkGuCq_r9zeDkn8/edit?gid=819123866#gid=819123866\",\r\n \"variables\": [\r\n {\r\n \"field\": \"cliente\",\r\n \"variable\": \"Nome_Completo\"\r\n },\r\n {\r\n \"field\": \"WhatsApp\",\r\n \"variable\": \"WhatsApp\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/google/add"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 18:28:26 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"62"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lpt7Ajb4CYcEMmQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Listing added successfully\"\n}"}],"_postman_id":"002099d0-b1d9-4b41-b0e6-198cc5e929bf"},{"name":"Adicionar listagem - Controllr (Faturas)","id":"be65d2c1-3e91-4e1f-b50a-839240cb868a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem controllr\",\r\n \"desc\": \"Listagem controllr\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"status\": \"aberto\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/controllr/invoices/add","description":"Este endpoint permite adicionar uma nova listagem à plataforma 123Zap a partir de uma planilha do Google Sheets.
\nVocê pode definir um título, descrição e mapear os campos da planilha para variáveis internas da 123Zap, tornando o envio de mensagens altamente personalizado.
\nOs seguintes atributos devem ser passados:
\nEndFragment
\n","urlObject":{"path":["erp","controllr","invoices","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"6407981b-0e24-44d4-800a-c396f24c107a","name":"Adicionar listagem - Controllr (Faturas)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Teste API POSTMAN\",\r\n \"desc\": \"Teste API POSTMAN\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"status\": \"aberto\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/controllr/invoices/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 16:31:59 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"MoEqlioSIAMEcDA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"API Rest listing added successfully\",\n \"listing_id\": \"e90ba17e-d888-43ee-944c-e454a8a5c758\"\n}"}],"_postman_id":"be65d2c1-3e91-4e1f-b50a-839240cb868a"},{"name":"Adicionar listagem - SGP (Faturas)","id":"e1cd8acf-3fe8-4497-ac85-b947f2ba2473","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem SGP\",\r\n \"desc\": \"Listagem SGP\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"status\": \"aberto\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sgp/invoices/add","description":"Este endpoint permite adicionar uma nova listagem à plataforma 123Zap a partir de uma planilha do Google Sheets.
\nVocê pode definir um título, descrição e mapear os campos da planilha para variáveis internas da 123Zap, tornando o envio de mensagens altamente personalizado.
\nOs seguintes atributos devem ser passados:
\nEndFragment
\n","urlObject":{"path":["erp","sgp","invoices","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"740de086-6178-4db9-a8d6-5f9f34b8c59e","name":"Adicionar listagem - SGP (Faturas)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem SGP\",\r\n \"desc\": \"Listagem SGP\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"status\": \"aberto\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sgp/invoices/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 21:39:11 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"MoxqSi_wIAMEMgQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"API Rest listing added successfully\",\n \"listing_id\": \"f20be444-d8df-44df-84d3-9eb02cf66146\"\n}"}],"_postman_id":"e1cd8acf-3fe8-4497-ac85-b947f2ba2473"},{"name":"Adicionar listagem - HubSoft (Faturas)","id":"6d2c1522-4d2d-4bf7-a92f-3111ded7d3ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem Hubsoft\",\r\n \"desc\": \"Listagem Hubsoft\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"apenas_quitado\": \"nao\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/hubsoft/invoices/add","description":"Este endpoint permite adicionar uma nova listagem à plataforma 123Zap a partir de uma planilha do Google Sheets.
\nVocê pode definir um título, descrição e mapear os campos da planilha para variáveis internas da 123Zap, tornando o envio de mensagens altamente personalizado.
\nOs seguintes atributos devem ser passados:
\nEndFragment
\n","urlObject":{"path":["erp","hubsoft","invoices","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"1025668e-7501-414b-9a29-ac5c6dedc584","name":"Adicionar listagem - HubSoft (Faturas)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem Hubsoft\",\r\n \"desc\": \"Listagem Hubsoft\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"apenas_quitado\": \"nao\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/hubsoft/invoices/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 21:38:24 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"MoxjUgJLIAMEMkA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"API Rest listing added successfully\",\n \"listing_id\": \"1b956017-c2ec-4018-b905-a24e92ee2e66\"\n}"}],"_postman_id":"6d2c1522-4d2d-4bf7-a92f-3111ded7d3ac"},{"name":"Adicionar listagem - Sienge (Faturas)","id":"230f8313-49c4-4f97-85b6-d5a21222659f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem Sienge\",\r\n \"desc\": \"Listagem Sienge\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"status\": \"Aberto\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sienge/invoices/add","description":"Este endpoint permite adicionar uma nova listagem à plataforma 123Zap a partir do seu ERP Sienge.
\nVocê pode definir um título, descrição e mapear os campos da planilha para variáveis internas da 123zap, tornando o envio de mensagens altamente personalizado.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["erp","sienge","invoices","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"7fd50572-f649-40e1-9a33-d0238220fc1b","name":"Adicionar listagem - Sienge (Faturas)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem Sienge\",\r\n \"desc\": \"Listagem Sienge\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"status\": \"Aberto\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/sienge/invoices/add"},"status":"OK","code":200,"_postman_previewlanguage":"Text","header":[{"key":"Date","value":"Thu, 25 Sep 2025 15:03:09 GMT"},{"key":"Content-Type","value":"text/plain; charset=utf-8"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"RdrxvjoioAMEJ-g="}],"cookie":[],"responseTime":null,"body":"{\"status\": \"success\", \"message\": \"API Rest listing added successfully\", \"listing_id\": \"d2f325ee-f0e0-47fc-a3fe-312550d96fc9\"}"}],"_postman_id":"230f8313-49c4-4f97-85b6-d5a21222659f"},{"name":"Adicionar listagem - EliteSoft (Faturas)","id":"b997294d-3897-4fb8-80e6-0e2f6dda208b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem EliteSoft\",\r\n \"desc\": \"Listagem EliteSoft\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\",\r\n \"status\": \"aberto\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/elitesoft/invoices/add","description":"Este endpoint permite adicionar uma nova listagem à plataforma 123Zap a partir de uma planilha do Google Sheets.
\nVocê pode definir um título, descrição e mapear os campos da planilha para variáveis internas da 123Zap, tornando o envio de mensagens altamente personalizado.
\nOs seguintes atributos devem ser passados:
\nEndFragment
\n","urlObject":{"path":["erp","elitesoft","invoices","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"c83807dd-fc61-4885-b7cd-67ed35b2343c","name":"Adicionar listagem - EliteSoft (Faturas)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Listagem Hubsoft\",\r\n \"desc\": \"Listagem Hubsoft\",\r\n \"data_vencimento_inicio\": \"2025-05-01\",\r\n \"data_vencimento_fim\": \"2025-05-31\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/erp/elitesoft/invoices/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Mon, 23 Jun 2025 22:54:37 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Mo8tniaWoAMEYNg="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"API Rest listing added successfully\",\n \"listing_id\": \"ac52bb38-e8d0-408d-b6d0-a97407181b28\"\n}"}],"_postman_id":"b997294d-3897-4fb8-80e6-0e2f6dda208b"},{"name":"Consultar acesso - API REST","id":"2a6533b4-8c67-45a5-af21-964e402d333e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.api.com.br\",\r\n \"method\": \"POST\",\r\n \"authorization\": \"your-token-123\",\r\n \"body\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/api/check","description":"Este endpoint permite testar se uma integração via API personalizada está funcionando corretamente dentro da plataforma 123Zap.
\nEle realiza uma chamada à URL da sua API, utilizando o método, o token de autenticação e o corpo configurado. O objetivo é garantir que a conexão está válida e que a API retorna os dados no formato esperado para que você possa criar uma listagem dinâmica alimentada diretamente pela sua API.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["sheets","api","check"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"79391ce5-9e5b-4448-aece-491ee4f76e72","name":"Consultar acesso API","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"url\": \"https://your.api.com.br\",\r\n \"method\": \"POST\",\r\n \"authorization\": \"your-token-123\",\r\n \"body\": {}\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/api/check"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 20:23:29 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"645"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lp-xSgQECYcEJhQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"API Rest access is active\",\n \"item_example\": {\n \"fatura_id\": \"012\",\n \"valor\": \"119.90\",\n \"vencimento\": \"05/06/2025\",\n \"Código de barras\": \"22199292921921921912921929192112\",\n \"Email\": \"client@server.com\",\n \"Nome\": \"ADAO CRISTIANO\",\n \"pix\": \"00020101021226950014br.gov.bcb.909PIXSICOOB6006CIDADE62070503***6304EC3D\",\n \"Contrato\": \"87\",\n \"Rua\": \"Rua Tipo - 345\",\n \"Link\": \"https://your.api.fatura/id\",\n \"Celular\": \"31999999999\"\n }\n}"}],"_postman_id":"2a6533b4-8c67-45a5-af21-964e402d333e"},{"name":"Adicionar listagem - API REST","id":"fa1162fd-c1b6-43d4-a0f0-d88c4d8a344e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"yourTitle\",\r\n \"desc\": \"yourDescription\",\r\n \"method\": \"POST\",\r\n \"url\": \"https://your.api.com.br\",\r\n \"authorization\": \"your-token-123\",\r\n \"body\": \"{}\",\r\n \"variables\": [\r\n {\r\n \"field\": \"Nome_Completo\",\r\n \"variable\": \"Nome_Completo\"\r\n },\r\n {\r\n \"field\": \"WhatsApp\",\r\n \"variable\": \"WhatsApp\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/api/add","description":"Este endpoint permite criar uma nova listagem na plataforma 123Zap a partir de uma API externa. Você pode conectar qualquer sistema que disponibilize dados via API REST, definir um título, uma descrição e mapear os dados retornados para variáveis internas da 123Zap, tornando seus envios de mensagens dinâmicos, personalizados e automatizados.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["sheets","api","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"ca00c495-7765-45f9-bac0-c2efc2beabd1","name":"Adicionar listagem - API REST","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"yourTitle\",\r\n \"desc\": \"yourDescription\",\r\n \"method\": \"POST\",\r\n \"url\": \"https://your.api.com.br\",\r\n \"authorization\": \"your-token-123\",\r\n \"body\": \"{}\",\r\n \"variables\": [\r\n {\r\n \"field\": \"Nome_Completo\",\r\n \"variable\": \"Nome_Completo\"\r\n },\r\n {\r\n \"field\": \"WhatsApp\",\r\n \"variable\": \"WhatsApp\"\r\n }\r\n ]\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/api/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 21:46:15 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"125"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LqK40j88iYcEM4Q="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"API Rest listing added successfully\",\n \"listing_id\": \"9c9675db-97f9-4203-96cf-af6847ab72d7\"\n}"}],"_postman_id":"fa1162fd-c1b6-43d4-a0f0-d88c4d8a344e"},{"name":"Adicionar listagem - Excel","id":"46c22d45-9da6-4291-b41c-4544eda4b592","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"2118379a-5779-4963-a11f-28b46e87455e","src":"postman-cloud:///1f04198e-818f-46f0-98b8-b3c47d4133d3"},{"key":"title","value":"Base de Clientes\n","type":"text","uuid":"bb43299d-58ce-428f-907d-971a31bea628"},{"key":"desc","value":"Planilha de cadastro","type":"text","uuid":"2379465f-01d0-41a0-bc6e-e7d28c07bd44"},{"key":"variables","value":"[{\"field\":\"Nome_Completo\",\"variable\":\"Nome_Completo\"}]","type":"text","uuid":"8a8f3375-0db5-4228-acc1-c7d21924db01"}]},"url":"{{api.123zap}}/sheets/excel/add","description":"Este endpoint permite adicionar uma nova listagem à plataforma 123Zap a partir de um arquivo Excel. Você pode definir um título, uma descrição e mapear os campos das colunas do Excel para variáveis internas da plataforma, permitindo que suas campanhas sejam altamente personalizadas e organizadas.
\nO seguinte form-data é esperado:
\n","urlObject":{"path":["sheets","excel","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"65a681fc-1c53-48cd-bfd5-e965d38a21bb","name":"Adicionar listagem - Excel","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"formdata","formdata":[{"key":"file","type":"file","uuid":"2118379a-5779-4963-a11f-28b46e87455e","src":"postman-cloud:///1f04198e-818f-46f0-98b8-b3c47d4133d3"},{"key":"title","value":"Base de Clientes\n","type":"text","uuid":"bb43299d-58ce-428f-907d-971a31bea628"},{"key":"desc","value":"Planilha de cadastro","type":"text","uuid":"2379465f-01d0-41a0-bc6e-e7d28c07bd44"},{"key":"variables","value":"[{\"field\":\"Nome_Completo\",\"variable\":\"Nome_Completo\"}]","type":"text","uuid":"8a8f3375-0db5-4228-acc1-c7d21924db01"}]},"url":"{{api.123zap}}/sheets/excel/add"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Wed, 04 Jun 2025 23:36:55 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"120"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LqbHEiyoCYcEJdg="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Arquivo adicionado com sucesso\",\n \"listing_id\": \"6adb3435-a4a8-4e66-9bc3-d1502672a871\"\n}"}],"_postman_id":"46c22d45-9da6-4291-b41c-4544eda4b592"},{"name":"Consultar acesso - Excel","id":"6483508e-fe76-4e25-b8c4-2bdc0e2bce41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/sheets/excel/check?code=fd67aad6-c21f-4beb-954a-20d5be0c540e","description":"Este endpoint verifica se a plataforma 123Zap tem acesso à planilha Excel com base no código de identificação fornecido.
\n\n\n⚠️ Atenção: Para que a 123Zap consiga acessar sua planilha, é necessário ter o código em mãos e garantir que ele esteja realmente vinculado à sua conta.
\n
Os seguintes parâmetros devem ser passados:
\n","urlObject":{"path":["sheets","excel","check"],"host":["{{api.123zap}}"],"query":[{"key":"code","value":"fd67aad6-c21f-4beb-954a-20d5be0c540e"}],"variable":[]}},"response":[{"id":"da5a84b0-01e7-4518-aebc-85e35d158d01","name":"Consultar acesso - Excel","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"{{api.123zap}}/sheets/excel/check?code=fd67aad6-c21f-4beb-954a-20d5be0c540e","host":["{{api.123zap}}"],"path":["sheets","excel","check"],"query":[{"key":"code","value":"fd67aad6-c21f-4beb-954a-20d5be0c540e"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Thu, 05 Jun 2025 14:52:43 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"1504"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LshQJjWICYcEJNw="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"File access is active\",\n \"file_url\": \"https://123zap.com/sheets/xls/b909f5c5/cliente_whatsapp.xlsx_20250605134445?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=ASIASA33HXPL75SAUCSH%2F20250605%2Fus-east-2%2Fs3%2Faws4_request&X-Amz-Date=20250605T145238Z&X-Amz-Expires=3600&X-Amz-SignedHeaders=host...\",\n \"item_example\": {\n \"Cliente\": \"João Silva\",\n \"WhatsApp\": \"55DDD999999999\"\n }\n}"}],"_postman_id":"6483508e-fe76-4e25-b8c4-2bdc0e2bce41"},{"name":"Teste nova funcionalidade","id":"1ee67076-d16e-4428-bf1a-d30f4445dcfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"","urlObject":{"query":[],"variable":[]}},"response":[],"_postman_id":"1ee67076-d16e-4428-bf1a-d30f4445dcfe"}],"id":"d9928e06-532c-48d5-9896-5dbba9272bd4","description":"Nesta seção, você encontrará os principais endpoints relacionados às listagens na plataforma 123Zap.
\nListagens são conjuntos organizados de dados que você pode criar e gerenciar para facilitar o envio de mensagens. Elas funcionam como uma base estruturada de contatos ou informações, que podem ser alimentadas por serviços como Google Planilhas, arquivos Excel ou por meio da integração direta com seu ERP.
\nCom essas listagens, você pode segmentar sua base de clientes e fazer disparos específicos para cada situação. Por exemplo: os clientes de janeiro deram uma esquecidinha no pagamento? Sem problemas! Crie uma listagem só com eles e mande aquele lembrete na medida certa. 😉
\n","_postman_id":"d9928e06-532c-48d5-9896-5dbba9272bd4"},{"name":"Mensagens","item":[{"name":"Enviar mensagem","id":"3f584c40-5050-43fc-bd37-ce2432854dc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Homenagem Dia da Mulher\",\r\n \"msg_type\": \"Avisos\",\r\n \"channel_type\": \"WhatsAppWEB\",\r\n \"number\": \"5531999999999\",\r\n \"messages\": [\r\n {\r\n \"type\": \"text\",\r\n \"content\": \"Essa é uma mensagem de teste\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/messages/send","description":"Na 123zap você pode enviar mensagens de E-mail, WhatsApp e SMS utilizando o mesmo endpoint e mudando somente o parametro channel_type.
\n📱 SMS
\nCada mensagem pode conter um ou mais blocos de conteúdo, como texto, imagem e etc.
\nOs seguintes atributos devem ser passados:
\nCada item de messages deve conter:
{\n \"title\": \"Lembrete de Pagamento\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"SMS\",\n \"messages\": [\n {\n \"type\": \"text\",\n \"content\": \"Olá! Lembrete: sua fatura com vencimento em 10/06 está pendente. Evite juros e mantenha seu serviço ativo. Dúvidas? Fale com a gente!\"\n }\n ]\n}\n\n{\n \"title\": \"Alerta Financeiro\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"E-mail\",\n \"messages\": [\n {\n \"type\": \"html\",\n \"content\": \"Alerta Financeiro:Identificamos que há pendências financeiras em aberto no seu cadastro. Por favor, verifique sua situação o quanto antes para evitar a suspensão dos serviços.Qualquer dúvida, estamos à disposição.Equipe 123zap\"\n }\n ]\n}\n\n{\n \"title\": \"Homenagem Dia da Mulher\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"WhatsApp\",\n \"messages\": [\n {\n \"type\": \"img\",\n \"content\": \"https://res.cloudinary.com/demo/image/upload/sample.jpg\"\n },\n {\n \"type\": \"text\",\n \"content\": \"Em nome de toda a nossa equipe, desejamos um Feliz Dia da Mulher! Que cada dia seja repleto de força, sabedoria e reconhecimento. 💐\"\n }\n ]\n}\n\nEste endpoint permite listar todos os modelos de mensagem cadastrados na plataforma 123Zap para o cliente autenticado.
\nOs modelos retornados incluem informações como nome, status de aprovação, variáveis utilizadas e tipo (texto, imagem).
\nEsses modelos podem ser utilizados em campanhas, notificações automáticas e mensagens manuais, otimizando a comunicação com seus contatos.
\n","urlObject":{"path":["templates","list"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"eb658cc6-07ee-4158-ad57-098b55a29ab1","name":"Listar modelos","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/templates/list"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 15:52:29 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"1708"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lv89ThqPiYcEMkw="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"data\": [\n {\n \"id\": \"78de0371-7bb9-438e-89da-fcf0fcadad16\",\n \"title\": \"Alerta Financeiro\",\n \"status\": \"Ativo\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"E-mail\",\n \"type\": \"Custom123\",\n \"message_json\": {\n \"messages\": [\n {\n \"id\": 1,\n \"type\": \"email\",\n \"message\": [\n {\n \"type\": \"html\",\n \"content\": \"Alerta Financeiro:
Identificamos que há pendências financeiras em aberto no seu cadastro. Por favor, verifique sua situação o quanto antes para evitar a suspensão dos serviços.
Qualquer dúvida, estamos à disposição.
Equipe 123zap
Este endpoint permite excluir um modelo de mensagem específico da plataforma 123Zap, utilizando seu identificador único (id_template).
Uma vez excluído, o modelo não poderá mais ser utilizado em campanhas ou mensagens automáticas.
\n","urlObject":{"path":["templates","delete"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"f76ade66-d6cf-4f16-b804-29ad6b665026","name":"Deletar modelo","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_template\": \"4ab75344-00d9-4a2b-8001-8bffe50db0e3\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/templates/delete"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 14:58:27 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"65"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"Lv1CsjxuiYcEMhw="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"message\": \"Template deleted successfully\"\n}"}],"_postman_id":"a101126a-fe71-419e-9338-c7ca40a96121"},{"name":"Adicionar modelo","id":"a317cc1b-8e24-4887-a06f-d1861d2b922f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"Homenagem Dia da Mulher\",\r\n \"msg_type\": \"Avisos\",\r\n \"channel_type\": \"WhatsApp\",\r\n \"messages\": [\r\n {\r\n \"type\": \"img\",\r\n \"content\": \"https://res.cloudinary.com/demo/image/upload/sample.jpg\"\r\n },\r\n {\r\n \"type\": \"text\",\r\n \"content\": \"Em nome de toda a nossa equipe, desejamos um Feliz Dia da Mulher! Que cada dia seja repleto de força, sabedoria e reconhecimento. 💐\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/templates/insert","description":"Este endpoint permite criar um novo modelo de mensagem na plataforma 123Zap.
\nOs modelos podem ser utilizados posteriormente em campanhas, automações e envios manuais. Você pode criar modelos para os seguintes canais:
\n📱 SMS
\nCada modelo pode conter um ou mais blocos de conteúdo, como texto, imagem ou HTML (no caso de e-mails).
\nOs seguintes atributos devem ser passados:
\nCada item de messages deve conter:
{\n \"title\": \"Lembrete de Pagamento\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"SMS\",\n \"messages\": [\n {\n \"type\": \"text\",\n \"content\": \"Olá! Lembrete: sua fatura com vencimento em 10/06 está pendente. Evite juros e mantenha seu serviço ativo. Dúvidas? Fale com a gente!\"\n }\n ]\n}\n\n{\n \"title\": \"Alerta Financeiro\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"E-mail\",\n \"messages\": [\n {\n \"type\": \"html\",\n \"content\": \"Alerta Financeiro:Identificamos que há pendências financeiras em aberto no seu cadastro. Por favor, verifique sua situação o quanto antes para evitar a suspensão dos serviços.Qualquer dúvida, estamos à disposição.Equipe 123zap\"\n }\n ]\n}\n\n{\n \"title\": \"Homenagem Dia da Mulher\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"WhatsApp\",\n \"messages\": [\n {\n \"type\": \"img\",\n \"content\": \"https://res.cloudinary.com/demo/image/upload/sample.jpg\"\n },\n {\n \"type\": \"text\",\n \"content\": \"Em nome de toda a nossa equipe, desejamos um Feliz Dia da Mulher! Que cada dia seja repleto de força, sabedoria e reconhecimento. 💐\"\n }\n ]\n}\n\nEste endpoint permite atualizar um modelo de mensagem existente na plataforma 123Zap.
\nOs modelos podem ser usados em campanhas, automações e envios manuais, e estão disponíveis para os seguintes canais:
\n📩 E-mail | 💬 WhatsApp | 📱 SMS
\nA estrutura da requisição é a mesma da criação de modelo, com a adição obrigatória do campo id_template, que identifica qual modelo será atualizado.
Cada modelo pode conter um ou mais blocos de conteúdo, como texto, imagem ou HTML (no caso de e-mails).
\nOs seguintes atributos devem ser passados:
\nCada item de messages deve conter:
{\n \"title\": \"Lembrete de Pagamento\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"SMS\",\n \"messages\": [\n {\n \"type\": \"text\",\n \"content\": \"Olá! Lembrete: sua fatura com vencimento em 10/06 está pendente. Evite juros e mantenha seu serviço ativo. Dúvidas? Fale com a gente!\"\n }\n ]\n}\n\n{\n \"title\": \"Alerta Financeiro\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"E-mail\",\n \"messages\": [\n {\n \"type\": \"html\",\n \"content\": \"Alerta Financeiro:Identificamos que há pendências financeiras em aberto no seu cadastro. Por favor, verifique sua situação o quanto antes para evitar a suspensão dos serviços.Qualquer dúvida, estamos à disposição.Equipe 123zap\"\n }\n ]\n}\n\n{\n \"title\": \"Homenagem Dia da Mulher\",\n \"msg_type\": \"Avisos\",\n \"channel_type\": \"WhatsApp\",\n \"messages\": [\n {\n \"type\": \"img\",\n \"content\": \"https://res.cloudinary.com/demo/image/upload/sample.jpg\"\n },\n {\n \"type\": \"text\",\n \"content\": \"Em nome de toda a nossa equipe, desejamos um Feliz Dia da Mulher! Que cada dia seja repleto de força, sabedoria e reconhecimento. 💐\"\n }\n ]\n}\n\nEste endpoint permite duplicar um modelo de mensagem existente na plataforma 123Zap, criando uma cópia idêntica com um novo identificador.
\nÉ útil para reaproveitar a estrutura de modelos já criados, facilitando a criação de variações com ajustes mínimos.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["templates","duplicate"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"cd4c03cc-5e54-462d-819a-091eb23da04b","name":"Duplicar modelo","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_template\": \"1202c1e3-561c-4a68-9207-dab501303ffb\"\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/templates/duplicate"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 16:30:38 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"76"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LwCivjhcCYcEJLQ="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"id_template\": \"0915e953-103d-4a4a-865b-14efd2cb0972\"\n}"}],"_postman_id":"1902c483-041d-4fb9-b0c2-659fe6aa6998"},{"name":"Alterar visibilidade","id":"d85b6ccf-e6d0-4e5e-82f3-2caeff7182c4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_template\": \"1202c1e3-561c-4a68-9207-dab501303ffb\",\r\n \"visibility\": false\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/templates/visibility","description":"Este endpoint permite alterar a visibilidade de um modelo de mensagem na plataforma 123Zap.
\nVocê pode ocultar temporariamente um modelo (sem precisar deletá-lo) ou torná-lo visível novamente, facilitando a organização do seu painel de modelos.
\nModelos ocultos ainda estarão disponíveis para uso em campanhas.
\nOs seguintes atributos devem ser passados:
\n","urlObject":{"path":["templates","visibility"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"b092c9ef-c1ae-4428-85fa-51eb4d5e9a77","name":"Alterar visibilidade","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_template\": \"1202c1e3-561c-4a68-9207-dab501303ffb\",\r\n \"visibility\": false\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/templates/visibility"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 16:44:13 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"21"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LwEiJhkeCYcEJ8Q="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\"\n}"}],"_postman_id":"d85b6ccf-e6d0-4e5e-82f3-2caeff7182c4"},{"name":"Guardar imagem (Publica)","id":"d0efc8b6-d0cf-4991-9bcc-750cefed563b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"imagebase64\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAIAAADTED8xAAADMElEQVR4nOzVwQnAIBQFQYXff81RUkQCOyDj1YOPnbXWPmeTRef+/3O/OyBjzh3CD95BfqICMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMO0TAAD//2Anhf4QtqobAAAAAElFTkSuQmCC\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/templates/upload-image","description":"Este endpoint permite o upload de uma imagem codificada em base64 para ser utilizada dentro dos modelos de mensagem na plataforma 123Zap.
\nAo enviar a imagem, você recebe uma URL que pode ser referenciada em mensagens (ex: em blocos do tipo img para WhatsApp ou e-mail).
Os seguintes atributos devem ser passados:
\n","urlObject":{"path":["templates","upload-image"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[{"id":"254270cb-a763-479f-a5df-bc09584a44e4","name":"Guardar imagem (Publica)","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"client_id","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"imagebase64\": \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAQAAAAEACAIAAADTED8xAAADMElEQVR4nOzVwQnAIBQFQYXff81RUkQCOyDj1YOPnbXWPmeTRef+/3O/OyBjzh3CD95BfqICMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMK0CMO0TAAD//2Anhf4QtqobAAAAAElFTkSuQmCC\"\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/templates/upload-image"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Fri, 06 Jun 2025 16:47:00 GMT"},{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"Content-Length","value":"150"},{"key":"Connection","value":"keep-alive"},{"key":"Apigw-Requestid","value":"LwE78hDYiYcEPLA="}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"success\",\n \"image_url\": \"https://123zap/templates/images/client_id/{uuid}.png\"\n}"}],"_postman_id":"d0efc8b6-d0cf-4991-9bcc-750cefed563b"}],"id":"71bd7b87-8918-4ee7-a4ce-ffb2dfec723c","description":"Nesta seção, você encontrará os principais endpoints relacionados ao envio de mensagens na plataforma. As mensagens são o coração da comunicação com seus clientes — aqui, você pode enviar WhatsApp, SMS e E-mail facilmente.
\n","_postman_id":"71bd7b87-8918-4ee7-a4ce-ffb2dfec723c"},{"name":"Campanhas","item":[{"name":"Retornar campanhas","id":"9a87240d-9c06-432a-bff5-aebecf1cf608","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"url":"{{api.123zap}}/campaigns/list","urlObject":{"path":["campaigns","list"],"host":["{{api.123zap}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"9a87240d-9c06-432a-bff5-aebecf1cf608"},{"name":"Alterar status","id":"dbfdcaed-95cf-494b-9b7a-7f4da49c55e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": 0,\r\n \"status\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/campaigns/status","urlObject":{"path":["campaigns","status"],"host":["{{api.123zap}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"dbfdcaed-95cf-494b-9b7a-7f4da49c55e0"},{"name":"Alterar visibilidade","id":"8f5282ae-8144-48a3-81dd-ae57bd633e9e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"campaign_id\": 0,\r\n \"visibility\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/campaigns/visibility","urlObject":{"path":["campaigns","visibility"],"host":["{{api.123zap}}"],"query":[{"disabled":true,"key":"","value":""}],"variable":[]}},"response":[],"_postman_id":"8f5282ae-8144-48a3-81dd-ae57bd633e9e"},{"name":"Adicionar campanha agendada","id":"dd8406f0-1816-4482-a163-2c11477772d2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"title\": \"YourTitle\",\r\n \"description\": \"YourDescripton\",\r\n \"start_date\": \"2025-02-11\",\r\n \"expiration_date\": \"2025-02-11\",\r\n \"list_id\": \"1234567-YourID-LIST\",\r\n \"dynamic_date\": true, \r\n \"key_date_row\": 10,\r\n \"reference_moment\": \"before\",\r\n \"days_calculate\": 1,\r\n \"business_days\": true,\r\n \"block_dynamic\": false,\r\n \"key_block\": \"yourDictionaryVariableID\",\r\n \"when_block\": \"!=\",\r\n \"value_blocked\": \"10/01/2025\",\r\n \"start_time\": \"12:00\",\r\n \"sms_id\": \"1234567-YourID-Channel\",\r\n \"email_id\": \"1234567-YourID-Channel\",\r\n \"model_whatsapp_id\": \"1234567-YourID-Model\",\r\n \"model_sms_id\": \"1234567-YourID-Model\",\r\n \"model_email_id\": \"1234567-YourID-Model\",\r\n \"whatsapp_id\": \"1234567-YourID-Channel\",\r\n \"visibility\": true\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/campaigns/schedule/add","urlObject":{"path":["campaigns","schedule","add"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"dd8406f0-1816-4482-a163-2c11477772d2"},{"name":"Editar campanha agendada","id":"a6067a99-392d-44f6-8741-a1b741477a02","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json","type":"text"},{"key":"Authorization","value":"{{Token}}","type":"text"},{"key":"Client_ID","value":"{{client_id}}","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"id_campaign\": \"123456-YOUR-CAMPAIGN-ID\",\r\n \"title\": \"YourTitle\",\r\n \"description\": \"YourDescripton\",\r\n \"start_date\": \"2025-02-11\",\r\n \"expiration_date\": \"2025-02-11\",\r\n \"list_id\": \"1234567-YourID-LIST\",\r\n \"dynamic_date\": true, \r\n \"key_date_row\": 10,\r\n \"reference_moment\": \"before\",\r\n \"days_calculate\": 1,\r\n \"business_days\": true,\r\n \"block_dynamic\": false,\r\n \"key_block\": \"yourDictionaryVariableID\",\r\n \"when_block\": \"!=\",\r\n \"value_blocked\": \"10/01/2025\",\r\n \"start_time\": \"12:00\",\r\n \"sms_id\": \"1234567-YourID-Channel\",\r\n \"email_id\": \"1234567-YourID-Channel\",\r\n \"model_whatsapp_id\": \"1234567-YourID-Model\",\r\n \"model_sms_id\": \"1234567-YourID-Model\",\r\n \"model_email_id\": \"1234567-YourID-Model\",\r\n \"whatsapp_id\": \"1234567-YourID-Channel\",\r\n \"visibility\": true\r\n}\r\n","options":{"raw":{"language":"json"}}},"url":"{{api.123zap}}/campaigns/schedule/edit","urlObject":{"path":["campaigns","schedule","edit"],"host":["{{api.123zap}}"],"query":[],"variable":[]}},"response":[],"_postman_id":"a6067a99-392d-44f6-8741-a1b741477a02"}],"id":"0382af82-390d-40f0-a509-2719347a105d","description":"Este documento tem como objetivo detalhar os endpoints relacionados à rota de campanhas da plataforma, permitindo que o usuário execute as operações básicas de forma clara e eficiente.
\nMétodo: GET
Rota: /campaigns/list
{\n \"message\": \"success\", \n \"campaigns\": []\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nMétodo: PUT
Rota: /campaigns/status
Descrição: Este endpoint permite alterar o status de uma campanha específica.
\nCorpo da Requisição (JSON):
\n{\n \"campaign_id\": x,\n \"status\": true\n}\n\n{\n \"message\": \"success\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nMétodo: POST
Rota: /campaigns-visibility
Autenticação: Necessária (Token JWT)
\nDescrição: Esse endpoint permite alterar a visibilidade de uma campanha específica.
\nCorpo da Requisição (JSON):
\n{\n \"campaign_id\": x,\n \"visibility\": true\n}\n\n{\n \"message\": \"success\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nMétodo: POST
Rota: /campaigns/schedule/add
Descrição: Este endpoint permite criar uma campanha agendada
\nCorpo da Requisição (JSON):
\n{\n \"title\": \"YourTitle\",\n \"description\": \"YourDescripton\",\n \"start_date\": \"2025-02-11\",\n \"expiration_date\": \"2025-02-11\",\n \"list_id\": \"1234567-YourID-LIST\",\n \"dynamic_date\": true, \n \"key_date_row\": 10,\n \"reference_moment\": \"before\",\n \"days_calculate\": 1,\n \"business_days\": true,\n \"block_dynamic\": false,\n \"key_block\": \"yourDictionaryVariableID\",\n \"when_block\": \"!=\",\n \"value_blocked\": \"10/01/2025\",\n \"start_time\": \"12:00\",\n \"sms_id\": \"1234567-YourID-Channel\",\n \"email_id\": \"1234567-YourID-Channel\",\n \"model_whatsapp_id\": \"1234567-YourID-Model\",\n \"model_sms_id\": \"1234567-YourID-Model\",\n \"model_email_id\": \"1234567-YourID-Model\",\n \"whatsapp_id\": \"1234567-YourID-Channel\",\n \"visibility\": true\n}\n\n{\n \"message\": \"success\",\n \"code\": \"12345-ID-Campaign\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nEste documento tem como objetivo detalhar os endpoints relacionados à rota geral de canais de email da plataforma, permitindo que o usuário realize operações básicas de forma clara e eficiente, como listar adicionar/integrar um novo canal de email.
\nEndpoint: POST /channels/email/add
Método: POST
Descrição: Inicia uma instância com base no código fornecido.
\nCorpo da Requisição (JSON):
\n{\n \"nome\": \"Email Financeiro\",\n \"email\": \"youremail@server.com\"\n}\n\n{\n \"message\": \"success\",\n \"instance\": \"xxxx-xxxxx-xxxx-xxx\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"Channel not found\"\n}\n\n{\n \"error\": \"Limit of channels reached\"\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nEste documento tem como objetivo detalhar os endpoints relacionados à rota geral de canais de email da plataforma, permitindo que o usuário realize operações básicas de forma clara e eficiente, como listar adicionar/integrar um novo canal de SMS.
\nEndpoint: POST /channels/sms/add
Método: POST
Descrição: Inicia uma instância com base no código fornecido.
\n{\n \"message\": \"success\",\n \"instance\": \"xxxx-xxxxx-xxxx-xxx\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"Channel not found\"\n}\n\n{\n \"error\": \"Limit of channels reached\"\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nEste documento tem como objetivo detalhar os endpoints relacionados à rota geral de canais de email da plataforma, permitindo que o usuário realize operações básicas de forma clara e eficiente, como listar adicionar/integrar um novo canal de WhatsApp API.
\nEndpoint: POST /channels/email/add
Método: POST
Descrição: Inicia uma instância com base no código fornecido.
\nCorpo da Requisição (JSON):
\n{\n \"url\": \"yourmeta.facebook.app\",\n \"token\": \"yourPermanentToken\",\n \"name\": \"WhatsApp Comercial\"\n}\n\n{\n \"message\": \"success\",\n \"instance\": \"xxxx-xxxxx-xxxx-xxx\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"Channel not found\"\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nNa 123zap, você pode gerenciar as configurações do seu canal através da nossa API, oferecendo a possibilidade de ter controle sobre todos os aspectos de sua integração. A API possibilita listar canais, configurar instâncias, gerar novas e até remover canais de WhatsApp.
\nEndpoint: /channels/whatsapp/web/qrcode
Método: POST
\nDescrição: Gera QRCode para conexão através do WhatsApp WEB.
\n{\n \"message\": \"success\", \n \"code\": \"xxxx-xxxx-xxx-xxxx\"\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nMétodo: GET
Rota: /channels/whatsapp/web/qrcode?code=xxxxx
Descrição: Retorna o QRCode no formato base64
\n{\n \"message\": \"success\", \n \"qrCode\": \"data:image/png;base64,iVBORw0...\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"Channel not found\"\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nEndpoint: POST
Método: /channels/whatsapp/web/save
Descrição: Salva o estado de conexão de uma instância do WhatsApp e configura um webhook para a instância.
\nCorpo da Requisição (JSON):
\n{\n \"code\": xxxx-xxxx-xxxx-xxxxx,\n \"nome\": \"WhatsApp Financeiro\"\n}\n\n{\n \"message\": \"success\", \n \"status\" : 200,\n \"uuid\": \"xxxx-xxxx-xxxx-xxxxx\",\n \"nome\": \"WhatsApp Financeiro\",\n \"owner\": \"553198888888\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"Channel not found\"\n}\n\n{\n \"error\": \"The number has not been linked to the server! Try again in a few moments.\"}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\nEndpoint: channels/whatsapp/web/config
Método: POST
Descrição: Atualiza a configuração de um canal existente.
\nCorpo da Requisição (JSON):
\n{\n \"type\": \"Faturas\",\n \"code\": \"073709b0-b0e3-4f57-869a-e4eb47525aee\"\n \"autoReplyText\": \"Sua mensagem de resposta automática\\\\ncom quebras de linha\",\n \"maxHour\": \"18:30\",\n \"minHour\": \"09:00\",\n \"autoReplyOption\": true,\n \"autoRemoveOption\": false\n}\n\n{\n \"message\": \"success\"\n}\n\n{\n \"error\": \"Field {field} is required\"\n}\n\n{\n \"message\": \"Unauthorized\"\n}\n\n{\n \"error\": \"Channel not found\"\n}\n\n{\n \"error\": \"An unexpected error occurred\"\n}\n\n