[{"data":1,"prerenderedAt":844},["ShallowReactive",2],{"docs-pages-meta":3,"i-lucide:menu":142,"i-fa6-solid:book":147,"i-fa6-solid:signs-post":151,"i-lucide:search":153,"i-lucide:languages":155,"i-lucide:chevron-down":157,"i-lucide:moon":159,"i-fa6-solid:tower-broadcast":161,"i-lucide:compass":164,"i-fa6-brands:whatsapp":166,"i-lucide:life-buoy":168,"i-fa6-solid:gear":170,"i-lucide:bot":172,"i-lucide:chart-column":174,"i-lucide:arrow-up-right":176,"i-lucide:sparkles":178,"i-fa6-solid:key":180,"i-fa6-solid:list-check":182,"i-lucide:webhook":184,"i-fa6-solid:layer-group":186,"i-fa6-solid:plug":188,"docs-page:\u002Fen\u002Fapi-reference\u002Fv3\u002Fconventions":191,"i-fa6-solid:triangle-exclamation":836,"i-lucide:copy":838,"i-lucide:chevron-left":840,"i-lucide:chevron-right":842},[4,9,14,19,22,27,30,35,38,42,47,52,56,61,66,71,76,79,83,87,90,93,97,100,104,107,111,115,119,123,127,131,135,139],{"path":5,"title":6,"description":7,"icon":8},"\u002Fen\u002Fapi-reference\u002Fv2\u002Fauthentication","Authentication","Learn how to generate and manage your access credentials to use the API securely.","key",{"path":10,"title":11,"description":12,"icon":13},"\u002Fen\u002Fapi-reference\u002Fv2","Introduction","The v2 API: connections, chats, messages and templates.","sparkles",{"path":15,"title":16,"description":17,"icon":18},"\u002Fen\u002Fapi-reference\u002Fv2\u002Fwebhooks","Webhooks","In this section, you’ll learn how to integrate and use webhooks and messaging events to connect your application to your projects.","webhook",{"path":20,"title":6,"description":21,"icon":8},"\u002Fen\u002Fapi-reference\u002Fv3\u002Fauthentication","How a v3 request proves who it is, and which workspace it acts on.",{"path":23,"title":24,"description":25,"icon":26},"\u002Fen\u002Fapi-reference\u002Fv3\u002Fconventions","Conventions","Pagination, errors, ids and dates — the rules every v3 endpoint follows.","list-check",{"path":28,"title":11,"description":29,"icon":13},"\u002Fen\u002Fapi-reference\u002Fv3","The v3 API: workspaces, connections, campaigns and the helpdesk.",{"path":31,"title":32,"description":33,"icon":34},"\u002Fen\u002Fapi-reference\u002Fv3\u002Frealtime","Realtime","The websocket behind the shared inbox: live conversations, typing and presence.","tower-broadcast",{"path":36,"title":16,"description":37,"icon":18},"\u002Fen\u002Fapi-reference\u002Fv3\u002Fwebhooks","Receive WhatsApp and helpdesk events on your own server, and prove they came from us.",{"path":39,"title":40,"description":41,"icon":8},"\u002Fen\u002Fapikeys","API Keys","Understand what API Keys are and why they are required to use Pingo Notify securely.",{"path":43,"title":44,"description":45,"icon":46},"\u002Fen\u002Fconnections","Connections","Connections represent WhatsApp sessions linked to Pingo Notify, used for sending, receiving, and integrations.","qrcode",{"path":48,"title":49,"description":50,"icon":51},"\u002Fen\u002Fhooks-and-development","Hooks and Development","Extend the Pingo Notify WordPress plugin with custom triggers, groups, and hooks.","code",{"path":53,"title":54,"description":55,"icon":13},"\u002Fen","Introduction to Pingo Notify","Connect WhatsApp to your systems, automate workflows, and send messages.",{"path":57,"title":58,"description":59,"icon":60},"\u002Fen\u002Fintegrations","Integrations","Integrations represent external applications linked to Pingo Notify, authorized to access resources such as connections, plans, and messaging.","cube",{"path":62,"title":63,"description":64,"icon":65},"\u002Fen\u002Fofficial-whatsapp-api","Official WhatsApp API","Step-by-step guide to request access to the Official WhatsApp Business API and connect it to Pingo Notify.","badge-check",{"path":67,"title":68,"description":69,"icon":70},"\u002Fen\u002Fplugin-wordpress","Get started","WordPress plugin that connects events from your site to Pingo Notify for automatic notification delivery.","wordpress",{"path":72,"title":73,"description":74,"icon":75},"\u002Fen\u002Ftemplate-plugins","Templates Guide","Learn how to create custom dynamic messages.","square-envelope",{"path":77,"title":16,"description":78,"icon":18},"\u002Fen\u002Fwebhooks","Receive WhatsApp events in real time by linking webhooks to one or more connections in Pingo Notify.",{"path":80,"title":81,"description":82,"icon":8},"\u002Fpt-BR\u002Fapi-reference\u002Fv2\u002Fauthentication","Autenticação","Veja como gerar e gerenciar suas credenciais de acesso para utilizar a API com segurança.",{"path":84,"title":85,"description":86,"icon":13},"\u002Fpt-BR\u002Fapi-reference\u002Fv2","Introdução","A API v2: conexões, conversas, mensagens e templates.",{"path":88,"title":16,"description":89,"icon":18},"\u002Fpt-BR\u002Fapi-reference\u002Fv2\u002Fwebhooks","Nesta seção, você aprende como integrar e utilizar webhooks e eventos de mensageria para conectar a aplicação aos seus projetos.",{"path":91,"title":81,"description":92,"icon":8},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Fauthentication","Como uma requisição v3 prova quem é, e em qual workspace ela atua.",{"path":94,"title":95,"description":96,"icon":26},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Fconventions","Convenções","Paginação, erros, ids e datas — as regras que todo endpoint da v3 segue.",{"path":98,"title":85,"description":99,"icon":13},"\u002Fpt-BR\u002Fapi-reference\u002Fv3","A API v3: workspaces, conexões, campanhas e o helpdesk.",{"path":101,"title":102,"description":103,"icon":34},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Frealtime","Tempo real","O websocket por trás da caixa compartilhada: conversas ao vivo, digitação e presença.",{"path":105,"title":16,"description":106,"icon":18},"\u002Fpt-BR\u002Fapi-reference\u002Fv3\u002Fwebhooks","Receba eventos do WhatsApp e do helpdesk no seu servidor, e prove que vieram de nós.",{"path":108,"title":109,"description":110,"icon":8},"\u002Fpt-BR\u002Fapikeys","Chaves de API","Entenda o que são Chaves de API e por que elas são necessárias para usar o Pingo Notify com segurança.",{"path":112,"title":113,"description":114,"icon":46},"\u002Fpt-BR\u002Fconnections","Conexões","Conexões representam sessões do WhatsApp vinculadas ao Pingo Notify, usadas para envio, recebimento e integrações.",{"path":116,"title":117,"description":118,"icon":51},"\u002Fpt-BR\u002Fhooks-and-development","Hooks e Desenvolvimento","Estenda o plugin WordPress do Pingo Notify com gatilhos, grupos e hooks personalizados.",{"path":120,"title":121,"description":122,"icon":13},"\u002Fpt-BR","Introdução ao Pingo Notify","Conecte o WhatsApp aos seus sistemas, automatize fluxos e envie mensagens.",{"path":124,"title":125,"description":126,"icon":60},"\u002Fpt-BR\u002Fintegrations","Integrações","Integrações representam aplicações externas vinculadas ao Pingo Notify, autorizadas a acessar recursos como conexões, planos e mensageria.",{"path":128,"title":129,"description":130,"icon":65},"\u002Fpt-BR\u002Fofficial-whatsapp-api","API Oficial do WhatsApp","Guia passo a passo para solicitar acesso à API Oficial do WhatsApp Business e conectá-la ao Pingo Notify.",{"path":132,"title":133,"description":134,"icon":70},"\u002Fpt-BR\u002Fplugin-wordpress","Primeiros passos","Plugin WordPress que conecta eventos do seu site ao Pingo Notify para envio automático de notificações.",{"path":136,"title":137,"description":138,"icon":75},"\u002Fpt-BR\u002Ftemplate-plugins","Guia de Templates","Aprenda a criar mensagens dinâmicas personalizadas.",{"path":140,"title":16,"description":141,"icon":18},"\u002Fpt-BR\u002Fwebhooks","Receba eventos do WhatsApp em tempo real vinculando webhooks a uma ou mais conexões no Pingo Notify.",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":146},0,24,false,"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M4 5h16M4 12h16M4 19h16\"\u002F>",{"left":143,"top":143,"width":148,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":150},448,512,"\u003Cpath fill=\"currentColor\" d=\"M96 0C43 0 0 43 0 96v320c0 53 43 96 96 96h320c17.7 0 32-14.3 32-32s-14.3-32-32-32v-64c17.7 0 32-14.3 32-32V32c0-17.7-14.3-32-32-32zm0 384h256v64H96c-17.7 0-32-14.3-32-32s14.3-32 32-32m32-240c0-8.8 7.2-16 16-16h192c8.8 0 16 7.2 16 16s-7.2 16-16 16H144c-8.8 0-16-7.2-16-16m16 48h192c8.8 0 16 7.2 16 16s-7.2 16-16 16H144c-8.8 0-16-7.2-16-16s7.2-16 16-16\"\u002F>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":152},"\u003Cpath fill=\"currentColor\" d=\"M224 32H64c-17.7 0-32 14.3-32 32v64c0 17.7 14.3 32 32 32h377.4c4.2 0 8.3-1.7 11.3-4.7l48-48c6.2-6.2 6.2-16.4 0-22.6l-48-48c-3-3-7.1-4.7-11.3-4.7H288c0-17.7-14.3-32-32-32s-32 14.3-32 32m256 224c0-17.7-14.3-32-32-32H288v-32h-64v32H70.6c-4.2 0-8.3 1.7-11.3 4.7l-48 48c-6.2 6.2-6.2 16.4 0 22.6l48 48c3 3 7.1 4.7 11.3 4.7H448c17.7 0 32-14.3 32-32zM288 480v-96h-64v96c0 17.7 14.3 32 32 32s32-14.3 32-32\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":154},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"m21 21l-4.34-4.34\"\u002F>\u003Ccircle cx=\"11\" cy=\"11\" r=\"8\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":156},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m5 8l6 6m-7 0l6-6l2-3M2 5h12M7 2h1m14 20l-5-10l-5 10m2-4h6\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":158},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m6 9l6 6l6-6\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":160},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M20.985 12.486a9 9 0 1 1-9.473-9.472c.405-.022.617.46.402.803a6 6 0 0 0 8.268 8.268c.344-.215.825-.004.803.401\"\u002F>",{"left":143,"top":143,"width":162,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":163},576,"\u003Cpath fill=\"currentColor\" d=\"M80.3 44C69.8 69.9 64 98.2 64 128s5.8 58.1 16.3 84c6.6 16.4-1.3 35-17.7 41.7s-35-1.3-41.7-17.7C7.4 202.6 0 166.1 0 128S7.4 53.4 20.9 20C27.6 3.6 46.2-4.3 62.6 2.3S86.9 27.6 80.3 44m474.8-24C568.6 53.4 576 89.9 576 128s-7.4 74.6-20.9 108c-6.6 16.4-25.3 24.3-41.7 17.7s-24.3-25.3-17.7-41.7c10.5-25.9 16.3-54.2 16.3-84s-5.8-58.1-16.3-84c-6.6-16.4 1.3-35 17.7-41.7s35 1.3 41.7 17.7M352 128c0 23.7-12.9 44.4-32 55.4V480c0 17.7-14.3 32-32 32s-32-14.3-32-32V183.4c-19.1-11.1-32-31.7-32-55.4c0-35.3 28.7-64 64-64s64 28.7 64 64M170.6 76.8C163.8 92.4 160 109.7 160 128s3.8 35.6 10.6 51.2c7.1 16.2-.3 35.1-16.5 42.1S119 221 112 204.8c-10.3-23.6-16-49.6-16-76.8s5.7-53.2 16-76.8c7.1-16.2 25.9-23.6 42.1-16.5s23.6 25.9 16.5 42.1M464 51.2c10.3 23.6 16 49.6 16 76.8s-5.7 53.2-16 76.8c-7.1 16.2-25.9 23.6-42.1 16.5s-23.6-25.9-16.5-42.1c6.8-15.6 10.6-32.9 10.6-51.2s-3.8-35.6-10.6-51.2c-7.1-16.2.3-35.1 16.5-42.1S457 35 464 51.2\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":165},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"\u002F>\u003Cpath d=\"m16.24 7.76l-1.804 5.411a2 2 0 0 1-1.265 1.265L7.76 16.24l1.804-5.411a2 2 0 0 1 1.265-1.265z\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":148,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":167},"\u003Cpath fill=\"currentColor\" d=\"M380.9 97.1C339 55.1 283.2 32 223.9 32c-122.4 0-222 99.6-222 222c0 39.1 10.2 77.3 29.6 111L0 480l117.7-30.9c32.4 17.7 68.9 27 106.1 27h.1c122.3 0 224.1-99.6 224.1-222c0-59.3-25.2-115-67.1-157m-157 341.6c-33.2 0-65.7-8.9-94-25.7l-6.7-4l-69.8 18.3L72 359.2l-4.4-7c-18.5-29.4-28.2-63.3-28.2-98.2c0-101.7 82.8-184.5 184.6-184.5c49.3 0 95.6 19.2 130.4 54.1s56.2 81.2 56.1 130.5c0 101.8-84.9 184.6-186.6 184.6m101.2-138.2c-5.5-2.8-32.8-16.2-37.9-18c-5.1-1.9-8.8-2.8-12.5 2.8s-14.3 18-17.6 21.8c-3.2 3.7-6.5 4.2-12 1.4c-32.6-16.3-54-29.1-75.5-66c-5.7-9.8 5.7-9.1 16.3-30.3c1.8-3.7.9-6.9-.5-9.7s-12.5-30.1-17.1-41.2c-4.5-10.8-9.1-9.3-12.5-9.5c-3.2-.2-6.9-.2-10.6-.2s-9.7 1.4-14.8 6.9c-5.1 5.6-19.4 19-19.4 46.3s19.9 53.7 22.6 57.4c2.8 3.7 39.1 59.7 94.8 83.8c35.2 15.2 49 16.5 66.6 13.9c10.7-1.6 32.8-13.4 37.4-26.4s4.6-24.1 3.2-26.4c-1.3-2.5-5-3.9-10.5-6.6\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":169},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Ccircle cx=\"12\" cy=\"12\" r=\"10\"\u002F>\u003Cpath d=\"m4.93 4.93l4.24 4.24m5.66 0l4.24-4.24m-4.24 9.9l4.24 4.24m-9.9-4.24l-4.24 4.24\"\u002F>\u003Ccircle cx=\"12\" cy=\"12\" r=\"4\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":171},"\u003Cpath fill=\"currentColor\" d=\"M495.9 166.6c3.2 8.7.5 18.4-6.4 24.6l-43.3 39.4c1.1 8.3 1.7 16.8 1.7 25.4s-.6 17.1-1.7 25.4l43.3 39.4c6.9 6.2 9.6 15.9 6.4 24.6c-4.4 11.9-9.7 23.3-15.8 34.3l-4.7 8.1c-6.6 11-14 21.4-22.1 31.2c-5.9 7.2-15.7 9.6-24.5 6.8l-55.7-17.7c-13.4 10.3-28.2 18.9-44 25.4l-12.5 57.1c-2 9.1-9 16.3-18.2 17.8c-13.8 2.3-28 3.5-42.5 3.5s-28.7-1.2-42.5-3.5c-9.2-1.5-16.2-8.7-18.2-17.8l-12.5-57.1c-15.8-6.5-30.6-15.1-44-25.4l-55.6 17.8c-8.8 2.8-18.6.3-24.5-6.8c-8.1-9.8-15.5-20.2-22.1-31.2l-4.7-8.1c-6.1-11-11.4-22.4-15.8-34.3c-3.2-8.7-.5-18.4 6.4-24.6l43.3-39.4c-1.1-8.4-1.7-16.9-1.7-25.5s.6-17.1 1.7-25.4l-43.3-39.4c-6.9-6.2-9.6-15.9-6.4-24.6c4.4-11.9 9.7-23.3 15.8-34.3l4.7-8.1c6.6-11 14-21.4 22.1-31.2c5.9-7.2 15.7-9.6 24.5-6.8l55.7 17.7c13.4-10.3 28.2-18.9 44-25.4l12.5-57.1c2-9.1 9-16.3 18.2-17.8C227.3 1.2 241.5 0 256 0s28.7 1.2 42.5 3.5c9.2 1.5 16.2 8.7 18.2 17.8l12.5 57.1c15.8 6.5 30.6 15.1 44 25.4l55.7-17.7c8.8-2.8 18.6-.3 24.5 6.8c8.1 9.8 15.5 20.2 22.1 31.2l4.7 8.1c6.1 11 11.4 22.4 15.8 34.3zM256 336a80 80 0 1 0 0-160a80 80 0 1 0 0 160\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":173},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M12 8V4H8\"\u002F>\u003Crect width=\"16\" height=\"12\" x=\"4\" y=\"8\" rx=\"2\"\u002F>\u003Cpath d=\"M2 14h2m16 0h2m-7-1v2m-6-2v2\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":175},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M3 3v16a2 2 0 0 0 2 2h16m-3-4V9m-5 8V5M8 17v-3\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":177},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"M7 7h10v10M7 17L17 7\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":179},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M11.017 2.814a1 1 0 0 1 1.966 0l1.051 5.558a2 2 0 0 0 1.594 1.594l5.558 1.051a1 1 0 0 1 0 1.966l-5.558 1.051a2 2 0 0 0-1.594 1.594l-1.051 5.558a1 1 0 0 1-1.966 0l-1.051-5.558a2 2 0 0 0-1.594-1.594l-5.558-1.051a1 1 0 0 1 0-1.966l5.558-1.051a2 2 0 0 0 1.594-1.594zM20 2v4m2-2h-4\"\u002F>\u003Ccircle cx=\"4\" cy=\"20\" r=\"2\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":181},"\u003Cpath fill=\"currentColor\" d=\"M336 352c97.2 0 176-78.8 176-176S433.2 0 336 0S160 78.8 160 176c0 18.7 2.9 36.8 8.3 53.7L7 391c-4.5 4.5-7 10.6-7 17v80c0 13.3 10.7 24 24 24h80c13.3 0 24-10.7 24-24v-40h40c13.3 0 24-10.7 24-24v-40h40c6.4 0 12.5-2.5 17-7l33.3-33.3c16.9 5.4 35 8.3 53.7 8.3m40-256a40 40 0 1 1 0 80a40 40 0 1 1 0-80\"\u002F>",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":183},"\u003Cpath fill=\"currentColor\" d=\"M152.1 38.2c9.9 8.9 10.7 24 1.8 33.9l-72 80c-4.4 4.9-10.6 7.8-17.2 7.9s-12.9-2.4-17.6-7L7 113c-9.3-9.4-9.3-24.6 0-34s24.6-9.4 33.9 0L63 101.1l55.1-61.2c8.9-9.9 24-10.7 33.9-1.8zm0 160c9.9 8.9 10.7 24 1.8 33.9l-72 80c-4.4 4.9-10.6 7.8-17.2 7.9s-12.9-2.4-17.6-7L7 273c-9.4-9.4-9.4-24.6 0-33.9s24.6-9.4 33.9 0L63 261.2l55.1-61.2c8.9-9.9 24-10.7 33.9-1.8zM224 96c0-17.7 14.3-32 32-32h224c17.7 0 32 14.3 32 32s-14.3 32-32 32H256c-17.7 0-32-14.3-32-32m0 160c0-17.7 14.3-32 32-32h224c17.7 0 32 14.3 32 32s-14.3 32-32 32H256c-17.7 0-32-14.3-32-32m-64 160c0-17.7 14.3-32 32-32h288c17.7 0 32 14.3 32 32s-14.3 32-32 32H192c-17.7 0-32-14.3-32-32M48 368a48 48 0 1 1 0 96a48 48 0 1 1 0-96\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":185},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Cpath d=\"M18 16.98h-5.99c-1.1 0-1.95.94-2.48 1.9A4 4 0 0 1 2 17c.01-.7.2-1.4.57-2\"\u002F>\u003Cpath d=\"m6 17l3.13-5.78c.53-.97.1-2.18-.5-3.1a4 4 0 1 1 6.89-4.06\"\u002F>\u003Cpath d=\"m12 6l3.13 5.73C15.66 12.7 16.9 13 18 13a4 4 0 0 1 0 8\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":162,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":187},"\u003Cpath fill=\"currentColor\" d=\"M264.5 5.2c14.9-6.9 32.1-6.9 47 0l218.6 101c8.5 3.9 13.9 12.4 13.9 21.8s-5.4 17.9-13.9 21.8l-218.6 101c-14.9 6.9-32.1 6.9-47 0l-218.6-101c-8.5-4-13.9-12.5-13.9-21.8s5.4-17.9 13.9-21.8zm212.4 204.4l53.2 24.6c8.5 3.9 13.9 12.4 13.9 21.8s-5.4 17.9-13.9 21.8l-218.6 101c-14.9 6.9-32.1 6.9-47 0l-218.6-101c-8.5-4-13.9-12.5-13.9-21.8s5.4-17.9 13.9-21.8l53.2-24.6l152 70.2a88.1 88.1 0 0 0 73.8 0zm-152 198.2l152-70.2l53.2 24.6c8.5 3.9 13.9 12.4 13.9 21.8s-5.4 17.9-13.9 21.8l-218.6 101c-14.9 6.9-32.1 6.9-47 0l-218.6-101c-8.5-4-13.9-12.5-13.9-21.8s5.4-17.9 13.9-21.8l53.2-24.6l152 70.2a88.1 88.1 0 0 0 73.8 0\"\u002F>",{"left":143,"top":143,"width":189,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":190},384,"\u003Cpath fill=\"currentColor\" d=\"M96 0C78.3 0 64 14.3 64 32v96h64V32c0-17.7-14.3-32-32-32m192 0c-17.7 0-32 14.3-32 32v96h64V32c0-17.7-14.3-32-32-32M32 160c-17.7 0-32 14.3-32 32s14.3 32 32 32v32c0 77.4 55 142 128 156.8V480c0 17.7 14.3 32 32 32s32-14.3 32-32v-67.2C297 398 352 333.4 352 256v-32c17.7 0 32-14.3 32-32s-14.3-32-32-32z\"\u002F>",{"id":192,"title":24,"body":193,"description":25,"extension":830,"hidden":145,"icon":26,"meta":831,"navigation":832,"path":23,"seo":833,"stem":834,"__hash__":835},"docs\u002Fen\u002Fapi-reference\u002Fv3\u002Fconventions.md",{"type":194,"value":195,"toc":818},"minimark",[196,201,205,240,306,331,334,420,425,435,446,466,469,473,476,482,531,542,545,579,589,593,708,712,718,721,733,737,744,753,757,764,772,775,790,794,797,808,814],[197,198,200],"h2",{"id":199},"pagination","Pagination",[202,203,204],"p",{},"Several page-based list endpoints take these query parameters and return the same envelope.",[206,207,212],"pre",{"className":208,"code":209,"language":210,"meta":211,"style":211},"language-bash shiki shiki-themes github-light github-dark","curl \"https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fhelpdesk\u002Fcontacts?page=2&per_page=50&s=ana\" \\\n  -H \"apikey: sk_live_...\"\n","bash","",[51,213,214,231],{"__ignoreMap":211},[215,216,219,223,227],"span",{"class":217,"line":218},"line",1,[215,220,222],{"class":221},"sScJk","curl",[215,224,226],{"class":225},"sZZnC"," \"https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fhelpdesk\u002Fcontacts?page=2&per_page=50&s=ana\"",[215,228,230],{"class":229},"sj4cs"," \\\n",[215,232,234,237],{"class":217,"line":233},2,[215,235,236],{"class":229},"  -H",[215,238,239],{"class":225}," \"apikey: sk_live_...\"\n",[241,242,243,259],"table",{},[244,245,246],"thead",{},[247,248,249,253,256],"tr",{},[250,251,252],"th",{},"Parameter",[250,254,255],{},"Default",[250,257,258],{},"Notes",[260,261,262,278,293],"tbody",{},[247,263,264,270,275],{},[265,266,267],"td",{},[51,268,269],{},"page",[265,271,272],{},[51,273,274],{},"1",[265,276,277],{},"1-based.",[247,279,280,285,290],{},[265,281,282],{},[51,283,284],{},"per_page",[265,286,287],{},[51,288,289],{},"10",[265,291,292],{},"The allowed range is endpoint-specific.",[247,294,295,300,303],{},[265,296,297],{},[51,298,299],{},"s",[265,301,302],{},"—",[265,304,305],{},"Free-text search. What it searches depends on the resource.",[307,308,309],"warning",{},[202,310,311,312,317,318,322,323,326,327,330],{},"The wire names are ",[313,314,315],"strong",{},[51,316,284],{}," and ",[313,319,320],{},[51,321,299],{}," — snake_case and short. Sending ",[51,324,325],{},"perPage"," or ",[51,328,329],{},"search"," does not fail; it is silently ignored and you get the defaults back. This trips people up, so check the parameter names on the endpoint page.",[202,332,333],{},"When page pagination is used, the envelope has this shape:",[206,335,339],{"className":336,"code":337,"language":338,"meta":211,"style":211},"language-json shiki shiki-themes github-light github-dark","{\n  \"data\": [ ... ],\n  \"total\": 137,\n  \"totalPages\": 3,\n  \"currentPage\": 2,\n  \"perPage\": 50\n}\n","json",[51,340,341,347,362,377,390,403,414],{"__ignoreMap":211},[215,342,343],{"class":217,"line":218},[215,344,346],{"class":345},"sVt8B","{\n",[215,348,349,352,355,359],{"class":217,"line":233},[215,350,351],{"class":229},"  \"data\"",[215,353,354],{"class":345},": [ ",[215,356,358],{"class":357},"s7hpK","...",[215,360,361],{"class":345}," ],\n",[215,363,365,368,371,374],{"class":217,"line":364},3,[215,366,367],{"class":229},"  \"total\"",[215,369,370],{"class":345},": ",[215,372,373],{"class":229},"137",[215,375,376],{"class":345},",\n",[215,378,380,383,385,388],{"class":217,"line":379},4,[215,381,382],{"class":229},"  \"totalPages\"",[215,384,370],{"class":345},[215,386,387],{"class":229},"3",[215,389,376],{"class":345},[215,391,393,396,398,401],{"class":217,"line":392},5,[215,394,395],{"class":229},"  \"currentPage\"",[215,397,370],{"class":345},[215,399,400],{"class":229},"2",[215,402,376],{"class":345},[215,404,406,409,411],{"class":217,"line":405},6,[215,407,408],{"class":229},"  \"perPage\"",[215,410,370],{"class":345},[215,412,413],{"class":229},"50\n",[215,415,417],{"class":217,"line":416},7,[215,418,419],{"class":345},"}\n",[421,422,424],"h3",{"id":423},"the-exception-messages","The exception: messages",[202,426,427,430,431,434],{},[51,428,429],{},"GET \u002Fv3\u002Fhelpdesk\u002Fconversations\u002F{id}\u002Fmessages"," is ",[313,432,433],{},"cursor","-paginated, because a conversation grows from the bottom while you read it and page numbers would shift under you.",[202,436,437,438,441,442,445],{},"It returns a ",[313,439,440],{},"bare array",", not an envelope, ordered ",[313,443,444],{},"oldest first",". To walk backwards through history, pass the id of the oldest message you already hold:",[206,447,449],{"className":208,"code":448,"language":210,"meta":211,"style":211},"curl \"https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fhelpdesk\u002Fconversations\u002F{id}\u002Fmessages?limit=30&cursor={oldestMessageId}\" \\\n  -H \"apikey: sk_live_...\"\n",[51,450,451,460],{"__ignoreMap":211},[215,452,453,455,458],{"class":217,"line":218},[215,454,222],{"class":221},[215,456,457],{"class":225}," \"https:\u002F\u002Fapi.pingonotify.com\u002Fv3\u002Fhelpdesk\u002Fconversations\u002F{id}\u002Fmessages?limit=30&cursor={oldestMessageId}\"",[215,459,230],{"class":229},[215,461,462,464],{"class":217,"line":233},[215,463,236],{"class":229},[215,465,239],{"class":225},[202,467,468],{},"You have reached the beginning of the conversation when you get back fewer messages than you asked for.",[197,470,472],{"id":471},"errors","Errors",[202,474,475],{},"There are two common error shapes, and which one you get depends on where the failure happened.",[202,477,478,481],{},[313,479,480],{},"Validation and permission failures"," use the standard shape:",[206,483,485],{"className":336,"code":484,"language":338,"meta":211,"style":211},"{\n  \"statusCode\": 400,\n  \"message\": [\"name must be a string\"],\n  \"error\": \"Bad Request\"\n}\n",[51,486,487,491,503,517,527],{"__ignoreMap":211},[215,488,489],{"class":217,"line":218},[215,490,346],{"class":345},[215,492,493,496,498,501],{"class":217,"line":233},[215,494,495],{"class":229},"  \"statusCode\"",[215,497,370],{"class":345},[215,499,500],{"class":229},"400",[215,502,376],{"class":345},[215,504,505,508,511,514],{"class":217,"line":364},[215,506,507],{"class":229},"  \"message\"",[215,509,510],{"class":345},": [",[215,512,513],{"class":225},"\"name must be a string\"",[215,515,516],{"class":345},"],\n",[215,518,519,522,524],{"class":217,"line":379},[215,520,521],{"class":229},"  \"error\"",[215,523,370],{"class":345},[215,525,526],{"class":225},"\"Bad Request\"\n",[215,528,529],{"class":217,"line":392},[215,530,419],{"class":345},[202,532,533,534,537,538,541],{},"Note that ",[51,535,536],{},"message"," is an ",[313,539,540],{},"array"," for validation failures — one entry per broken rule — and a plain string otherwise.",[202,543,544],{},"Many business failures use a coded shape, with a machine-readable code and a localized message:",[206,546,548],{"className":336,"code":547,"language":338,"meta":211,"style":211},"{\n  \"message\": \"CONNECTION_NOT_FOUND\",\n  \"hint\": \"Connection not found.\"\n}\n",[51,549,550,554,565,575],{"__ignoreMap":211},[215,551,552],{"class":217,"line":218},[215,553,346],{"class":345},[215,555,556,558,560,563],{"class":217,"line":233},[215,557,507],{"class":229},[215,559,370],{"class":345},[215,561,562],{"class":225},"\"CONNECTION_NOT_FOUND\"",[215,564,376],{"class":345},[215,566,567,570,572],{"class":217,"line":364},[215,568,569],{"class":229},"  \"hint\"",[215,571,370],{"class":345},[215,573,574],{"class":225},"\"Connection not found.\"\n",[215,576,577],{"class":217,"line":379},[215,578,419],{"class":345},[202,580,581,582,584,585,588],{},"When ",[51,583,536],{}," is a documented code, branch on it rather than on ",[51,586,587],{},"hint"," — the hint is written for humans and its wording may change. Some business failures use the standard shape instead, as documented by each endpoint.",[421,590,592],{"id":591},"status-codes","Status codes",[241,594,595,605],{},[244,596,597],{},[247,598,599,602],{},[250,600,601],{},"Code",[250,603,604],{},"What it means",[260,606,607,617,631,641,650,664,674,688,698],{},[247,608,609,614],{},[265,610,611],{},[51,612,613],{},"200",[265,615,616],{},"Success.",[247,618,619,624],{},[265,620,621],{},[51,622,623],{},"201",[265,625,626,627,630],{},"Created. This is the default for ",[51,628,629],{},"POST"," unless noted otherwise.",[247,632,633,638],{},[265,634,635],{},[51,636,637],{},"204",[265,639,640],{},"Success, no body. Only assume it when the endpoint documents it.",[247,642,643,647],{},[265,644,645],{},[51,646,500],{},[265,648,649],{},"Your request was malformed, or a business rule rejected it.",[247,651,652,657],{},[265,653,654],{},[51,655,656],{},"401",[265,658,659,660,663],{},"Your ",[51,661,662],{},"apikey"," is missing, wrong, or revoked.",[247,665,666,671],{},[265,667,668],{},[51,669,670],{},"403",[265,672,673],{},"Your role does not allow this, or your plan does not include it.",[247,675,676,681],{},[265,677,678],{},[51,679,680],{},"404",[265,682,683,684,687],{},"It does not exist — ",[313,685,686],{},"or you cannot see it",". See below.",[247,689,690,695],{},[265,691,692],{},[51,693,694],{},"409",[265,696,697],{},"It collides with something that already exists.",[247,699,700,705],{},[265,701,702],{},[51,703,704],{},"422",[265,706,707],{},"The request is valid, but the current resource state cannot process it — for example, a closed WhatsApp window or AI that is not configured.",[421,709,711],{"id":710},"why-you-get-a-404-instead-of-a-403","Why you get a 404 instead of a 403",[202,713,714,715,717],{},"When an Agent asks for a conversation in an inbox they do not belong to, the API answers ",[313,716,680],{},", not 403.",[202,719,720],{},"That is deliberate. A 403 would confirm the conversation exists, which leaks information to someone who should not know. The same rule applies to helpdesk resources protected by inbox visibility.",[202,722,723,724,728,729,732],{},"So a 404 means ",[725,726,727],"em",{},"\"not visible to you\"",", which is a slightly broader statement than ",[725,730,731],{},"\"not there\"",".",[197,734,736],{"id":735},"ids","Ids",[202,738,739,740,743],{},"Pingo-generated resource ids are ",[313,741,742],{},"UUIDs",". Most are UUID v7, so they sort chronologically — but do not depend on that; treat them as opaque strings. Provider and external ids, such as WhatsApp message ids, are opaque strings and may use other formats.",[202,745,746,747,752],{},"A conversation also has a ",[313,748,749],{},[51,750,751],{},"displayId",": a small integer, sequential per workspace, that exists so your agents can say \"ticket 214\" out loud. It is not accepted anywhere as a path parameter.",[197,754,756],{"id":755},"dates","Dates",[202,758,759,760,763],{},"Every timestamp in and out is ",[313,761,762],{},"ISO 8601 in UTC",":",[206,765,770],{"className":766,"code":768,"language":769},[767],"language-text","2026-07-14T12:34:56.000Z\n","text",[51,771,768],{"__ignoreMap":211},[202,773,774],{},"Report ranges are inclusive on both ends. Where a report buckets by day, the buckets are UTC days.",[202,776,777,778,781,782,785,786,789],{},"The one place a timezone matters is an ",[313,779,780],{},"inbox",": its ",[51,783,784],{},"timezone"," (an IANA name such as ",[51,787,788],{},"America\u002FSao_Paulo",") is what working hours, out-of-office replies and business-hours SLAs are measured against.",[197,791,793],{"id":792},"rate-limits-and-metering","Rate limits and metering",[202,795,796],{},"There is no request-per-second rate limit on the API.",[202,798,799,800,803,804,807],{},"What ",[725,801,802],{},"is"," metered is ",[313,805,806],{},"messages",". Every message you send consumes one credit from your plan, and campaigns reserve credits for the whole audience up front — if your plan cannot cover every recipient, the campaign is not created at all. Cancelling a campaign refunds the credits for recipients that were never sent.",[202,809,810,811,732],{},"Check your remaining headroom with ",[51,812,813],{},"GET \u002Fv3\u002Fsummary",[815,816,817],"style",{},"html pre.shiki code .sScJk, html code.shiki .sScJk{--shiki-default:#6F42C1;--shiki-dark:#B392F0}html pre.shiki code .sZZnC, html code.shiki .sZZnC{--shiki-default:#032F62;--shiki-dark:#9ECBFF}html pre.shiki code .sj4cs, html code.shiki .sj4cs{--shiki-default:#005CC5;--shiki-dark:#79B8FF}html .default .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .shiki span {color: var(--shiki-default);background: var(--shiki-default-bg);font-style: var(--shiki-default-font-style);font-weight: var(--shiki-default-font-weight);text-decoration: var(--shiki-default-text-decoration);}html .dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html.dark .shiki span {color: var(--shiki-dark);background: var(--shiki-dark-bg);font-style: var(--shiki-dark-font-style);font-weight: var(--shiki-dark-font-weight);text-decoration: var(--shiki-dark-text-decoration);}html pre.shiki code .sVt8B, html code.shiki .sVt8B{--shiki-default:#24292E;--shiki-dark:#E1E4E8}html pre.shiki code .s7hpK, html code.shiki .s7hpK{--shiki-default:#B31D28;--shiki-default-font-style:italic;--shiki-dark:#FDAEB7;--shiki-dark-font-style:italic}",{"title":211,"searchDepth":364,"depth":364,"links":819},[820,823,827,828,829],{"id":199,"depth":233,"text":200,"children":821},[822],{"id":423,"depth":364,"text":424},{"id":471,"depth":233,"text":472,"children":824},[825,826],{"id":591,"depth":364,"text":592},{"id":710,"depth":364,"text":711},{"id":735,"depth":233,"text":736},{"id":755,"depth":233,"text":756},{"id":792,"depth":233,"text":793},"md",{},true,{"title":24,"description":25},"en\u002Fapi-reference\u002Fv3\u002Fconventions","q0rlOCymGkHMls6Xd_XTBrLt-Rbrt06qhdYJNQ-crao",{"left":143,"top":143,"width":149,"height":149,"rotate":143,"vFlip":145,"hFlip":145,"body":837},"\u003Cpath fill=\"currentColor\" d=\"M256 32c14.2 0 27.3 7.5 34.5 19.8l216 368c7.3 12.4 7.3 27.7.2 40.1S486.3 480 472 480H40c-14.3 0-27.6-7.7-34.7-20.1s-7-27.8.2-40.1l216-368C228.7 39.5 241.8 32 256 32m0 128c-13.3 0-24 10.7-24 24v112c0 13.3 10.7 24 24 24s24-10.7 24-24V184c0-13.3-10.7-24-24-24m32 224a32 32 0 1 0-64 0a32 32 0 1 0 64 0\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":839},"\u003Cg fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\">\u003Crect width=\"14\" height=\"14\" x=\"8\" y=\"8\" rx=\"2\" ry=\"2\"\u002F>\u003Cpath d=\"M4 16c-1.1 0-2-.9-2-2V4c0-1.1.9-2 2-2h10c1.1 0 2 .9 2 2\"\u002F>\u003C\u002Fg>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":841},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m15 18l-6-6l6-6\"\u002F>",{"left":143,"top":143,"width":144,"height":144,"rotate":143,"vFlip":145,"hFlip":145,"body":843},"\u003Cpath fill=\"none\" stroke=\"currentColor\" stroke-linecap=\"round\" stroke-linejoin=\"round\" stroke-width=\"2\" d=\"m9 18l6-6l-6-6\"\u002F>",1787698191288]