{
  "info": {
    "name": "walpio API",
    "description": "Send WhatsApp messages from your own number, follow what happens to them, and manage templates, text rules, consent and callbacks.\n\nEvery path starts with /v1 (Meta's versioned send path aside). Authenticate with `Authorization: Bearer wp_live_…` — an API key from the dashboard. Every error is `{ \"error\": { \"code\", \"message\", \"retryable\", …, \"request_id\" } }`: build on `code` and `retryable`, never on `message`. /v1 only grows: ignore fields you do not know. The reference — with every example run against walpio on each change — is walpio.com/docs.\n\nMade from the OpenAPI description (GET /v1/openapi.json, docs/openapi.json) — do not edit by hand; run node scripts/openapi/postman.mjs.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "auth": {
    "type": "bearer",
    "bearer": [
      {
        "key": "token",
        "value": "{{apiKey}}",
        "type": "string"
      }
    ]
  },
  "variable": [
    {
      "key": "baseUrl",
      "value": "https://api.walpio.com"
    },
    {
      "key": "apiKey",
      "value": "",
      "description": "Your wp_live_… API key (dashboard → API keys). Set it in your own copy or environment, never in a shared file."
    }
  ],
  "item": [
    {
      "name": "Messages",
      "item": [
        {
          "name": "List messages",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages"
              ],
              "query": [
                {
                  "key": "status",
                  "value": "",
                  "description": "One or more of sending, queued, accepted, held, unknown, sent, delivered, read, failed, received, separated by commas.",
                  "disabled": true
                },
                {
                  "key": "direction",
                  "value": "",
                  "description": "in (received) or out (sent).",
                  "disabled": true
                },
                {
                  "key": "from",
                  "value": "",
                  "description": "One of the workspace's numbers (phone_number_id or walpio's id).",
                  "disabled": true
                },
                {
                  "key": "to",
                  "value": "",
                  "description": "A customer: a number or a business-scoped user id.",
                  "disabled": true
                },
                {
                  "key": "client_reference",
                  "value": "",
                  "description": "Your biz_opaque_callback_data.",
                  "disabled": true
                },
                {
                  "key": "since",
                  "value": "",
                  "description": "An ISO 8601 time (2026-09-25T10:00:00Z) or milliseconds since 1970.",
                  "disabled": true
                },
                {
                  "key": "until",
                  "value": "",
                  "description": "An ISO 8601 time or milliseconds since 1970; after since.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "Messages per page: 1–100 (50 when not given).",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "The previous page's next_cursor, exactly as it came.",
                  "disabled": true
                }
              ]
            },
            "description": "The workspace's messages, sent and received, newest first, a page at a time behind `next_cursor`. 60 pages a minute per workspace. Needs the `messages:read` scope (read messages).\n\nReference: https://walpio.com/docs#list-messages"
          },
          "response": []
        },
        {
          "name": "Send a message",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "",
                "description": "1–200 characters. The same key again answers the first request's result, and never sends twice.",
                "disabled": true
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"+971501234567\",\n  \"type\": \"template\",\n  \"template\": {\n    \"name\": \"order_update\",\n    \"language\": \"en\",\n    \"params\": [\n      \"#42\"\n    ]\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages"
              ],
              "query": [
                {
                  "key": "dry_run",
                  "value": "",
                  "description": "true: answer what the send would do, and send, store and count nothing.",
                  "disabled": true
                }
              ]
            },
            "description": "A text (sent as written inside the customer's 24-hour window, through a text rule's template outside it), an approved template by name, or — inside the window — media, an interactive message, a location, contact cards or a reaction. `Idempotency-Key` makes it safe to retry; `?dry_run=true` answers what it would do and sends nothing. Needs the `messages:send` scope (send messages).\n\nReference: https://walpio.com/docs#send-a-message"
          },
          "response": []
        },
        {
          "name": "Send a message on Meta's path (base …/v1)",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "",
                "description": "1–200 characters. The same key again answers the first request's result, and never sends twice.",
                "disabled": true
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"messaging_product\": \"whatsapp\",\n  \"recipient_type\": \"individual\",\n  \"to\": \"971501234567\",\n  \"type\": \"text\",\n  \"text\": {\n    \"body\": \"Your order #42 is on the way.\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/:phone_number_id/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                ":phone_number_id",
                "messages"
              ],
              "query": [
                {
                  "key": "dry_run",
                  "value": "",
                  "description": "As for POST /v1/messages.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "phone_number_id",
                  "value": "",
                  "description": "The sending number's phone_number_id (digits)."
                }
              ]
            },
            "description": "Meta's Cloud API path with the base https://api.walpio.com/v1: the send, from the number in the path. Everything else is POST /v1/messages. Needs the `messages:send` scope (send messages).\n\nReference: https://walpio.com/docs#moving-from-the-cloud-api"
          },
          "response": []
        },
        {
          "name": "Send a message on Meta's versioned path",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "",
                "description": "1–200 characters. The same key again answers the first request's result, and never sends twice.",
                "disabled": true
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"messaging_product\": \"whatsapp\",\n  \"recipient_type\": \"individual\",\n  \"to\": \"971501234567\",\n  \"type\": \"text\",\n  \"text\": {\n    \"body\": \"Your order #42 is on the way.\"\n  }\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/:version/:phone_number_id/messages",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                ":version",
                ":phone_number_id",
                "messages"
              ],
              "query": [
                {
                  "key": "dry_run",
                  "value": "",
                  "description": "As for POST /v1/messages.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "version",
                  "value": "",
                  "description": "Meta's Graph API version, such as v25.0 (any)."
                },
                {
                  "key": "phone_number_id",
                  "value": "",
                  "description": "The sending number's phone_number_id (digits)."
                }
              ]
            },
            "description": "Meta's Cloud API path with the base https://api.walpio.com and any version (v25.0 …): the send, from the number in the path. Needs the `messages:send` scope (send messages).\n\nReference: https://walpio.com/docs#moving-from-the-cloud-api"
          },
          "response": []
        },
        {
          "name": "A message and its status",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/messages/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "The id (walpio's; for a message, walpio's id or Meta's wamid)."
                }
              ]
            },
            "description": "Any message of the workspace, by walpio's id or Meta's wamid, with its status timeline. Needs the `messages:read` scope (read messages).\n\nReference: https://walpio.com/docs#message-status"
          },
          "response": []
        },
        {
          "name": "Mark a customer's message read (and show \"typing…\")",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"typing\": true\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/messages/:id/read",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages",
                ":id",
                "read"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "The id (walpio's; for a message, walpio's id or Meta's wamid)."
                }
              ]
            },
            "description": "WhatsApp's read receipt for a message the customer sent (and every earlier one); with typing: true, \"typing…\" until the business answers or 25 seconds pass. Needs the `messages:send` scope (send messages).\n\nReference: https://walpio.com/docs#read-receipts-and-the-typing-indicator"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Batches",
      "item": [
        {
          "name": "Send a batch",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Idempotency-Key",
                "value": "",
                "description": "1–200 characters. The same key again answers the first request's result, and never sends twice.",
                "disabled": true
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"template\": {\n    \"name\": \"order_update\",\n    \"language\": \"en\"\n  },\n  \"items\": [\n    {\n      \"to\": \"+971501234567\",\n      \"params\": [\n        \"#50\"\n      ],\n      \"biz_opaque_callback_data\": \"order-50\"\n    },\n    {\n      \"to\": \"+971509876543\",\n      \"params\": [\n        \"#51\"\n      ],\n      \"idempotency_key\": \"order-51-ready\"\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/messages/batch",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages",
                "batch"
              ]
            },
            "description": "One approved template to up to 1,000 customers, each with its own values, key and reference, sent through the queue. `template.language: \"auto\"` sends each item in its customer's own language when the template is approved in it, else in the workspace's default language, else in the template's first approved one. Checked whole: one bad item and nothing is stored. Needs the `messages:send` scope (send messages).\n\nReference: https://walpio.com/docs#send-a-batch"
          },
          "response": []
        },
        {
          "name": "A batch's progress and results",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/messages/batch/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "messages",
                "batch",
                ":id"
              ],
              "query": [
                {
                  "key": "status",
                  "value": "",
                  "description": "Only the items in this state.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "Items per page: 1–1,000 (100 when not given).",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "The previous page's next_cursor, exactly as it came.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "The id (walpio's; for a message, walpio's id or Meta's wamid)."
                }
              ]
            },
            "description": "The batch, and each item's result in the order sent, a page at a time. Counts with the message lists: 60 a minute per workspace. Needs the `messages:read` scope (read messages).\n\nReference: https://walpio.com/docs#send-a-batch"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Media",
      "item": [
        {
          "name": "Upload a file",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "file",
                  "type": "file",
                  "src": [],
                  "description": "The file, with its type: one of audio/aac, audio/amr, audio/mpeg, audio/mp4, audio/ogg, text/plain, application/vnd.ms-excel, application/vnd.openxmlformats-officedocument.spreadsheetml.sheet, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/vnd.ms-powerpoint, application/vnd.openxmlformats-officedocument.presentationml.presentation, application/pdf, image/jpeg, image/png, image/webp, video/3gpp, video/mp4; at most 16 MB (less for some types — Meta's limits)."
                },
                {
                  "key": "messaging_product",
                  "type": "text",
                  "value": "whatsapp",
                  "description": "",
                  "disabled": true
                },
                {
                  "key": "type",
                  "type": "text",
                  "value": "",
                  "description": "The file's type, when the file part does not carry it.",
                  "disabled": true
                },
                {
                  "key": "from",
                  "type": "text",
                  "value": "",
                  "description": "The number the file is for (a media id works only on the number it was uploaded to).",
                  "disabled": true
                }
              ]
            },
            "url": {
              "raw": "{{baseUrl}}/v1/media",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "media"
              ]
            },
            "description": "Meta's own multipart form: the file is checked against Meta's types and limits and passed to Meta; walpio keeps nothing. The answer's id is valid 30 days, on that number only. Needs the `messages:send` scope (send messages).\n\nReference: https://walpio.com/docs#upload-a-file"
          },
          "response": []
        },
        {
          "name": "A customer's photo, video, voice message or document",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/media/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "media",
                ":id"
              ],
              "query": [
                {
                  "key": "from",
                  "value": "",
                  "description": "The number: its phone_number_id or walpio's number id. Without it, the oldest active number.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "The id (walpio's; for a message, walpio's id or Meta's wamid)."
                }
              ]
            },
            "description": "The file a customer sent, by its media id, streamed from Meta (kept 7 days by Meta); walpio keeps nothing. Needs the `messages:read` scope (read messages).\n\nReference: https://walpio.com/docs#fetch-a-customers-media"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Numbers",
      "item": [
        {
          "name": "The workspace's numbers",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/numbers",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "numbers"
              ]
            },
            "description": "Each connected number, its health and what Meta says about it. Needs the `numbers:read` scope (list the numbers).\n\nReference: https://walpio.com/docs#numbers"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Templates",
      "item": [
        {
          "name": "List templates",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates"
              ],
              "query": [
                {
                  "key": "from",
                  "value": "",
                  "description": "The number: its phone_number_id or walpio's number id. Without it, the oldest active number.",
                  "disabled": true
                }
              ]
            },
            "description": "Every template of every number, sorted by name — or one number's with ?from=. Needs the `templates:read` scope (list templates).\n\nReference: https://walpio.com/docs#list-templates"
          },
          "response": []
        },
        {
          "name": "Create a template",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"delivery_window\",\n  \"language\": \"en\",\n  \"category\": \"UTILITY\",\n  \"components\": [\n    {\n      \"type\": \"BODY\",\n      \"text\": \"Hi {{1}}, your technician arrives between {{2}} today. Reply here to change it.\",\n      \"example\": {\n        \"body_text\": [\n          [\n            \"Aisha\",\n            \"2 and 4 pm\"\n          ]\n        ]\n      }\n    }\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/templates",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates"
              ]
            },
            "description": "Checked against Meta's published rules first, then created at Meta and submitted for review; approval arrives as a template.status callback. Needs the `templates:write` scope (create or delete templates).\n\nReference: https://walpio.com/docs#create-a-template"
          },
          "response": []
        },
        {
          "name": "Upload a media header's sample",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "formdata",
              "formdata": [
                {
                  "key": "file",
                  "type": "file",
                  "src": [],
                  "description": "The sample, with its type: image/jpeg (IMAGE, at most 5 MB), image/png (IMAGE, at most 5 MB), video/mp4 (VIDEO, at most 16 MB), application/pdf (DOCUMENT, at most 16 MB). Its first bytes must be that type's."
                },
                {
                  "key": "type",
                  "type": "text",
                  "value": "",
                  "description": "The file's type. Given, it is the type walpio checks and Meta is told, whatever the file part says.",
                  "disabled": true
                },
                {
                  "key": "from",
                  "type": "text",
                  "value": "",
                  "description": "The number whose account gets the template (phone_number_id or walpio's number id); without it, the oldest active number.",
                  "disabled": true
                }
              ]
            },
            "url": {
              "raw": "{{baseUrl}}/v1/templates/media",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates",
                "media"
              ]
            },
            "description": "For a template whose header is a document, an image or a video: the sample goes to Meta through its Resumable Upload API on the number's app; walpio keeps nothing. Put the answer's handle in the header's example.header_handle when you create the template. At most 10 a minute per workspace. Needs the `templates:write` scope (create or delete templates).\n\nReference: https://walpio.com/docs#a-media-headers-sample"
          },
          "response": []
        },
        {
          "name": "Delete a template",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/templates/:name",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "templates",
                ":name"
              ],
              "query": [
                {
                  "key": "language",
                  "value": "",
                  "description": "One language only, e.g. en.",
                  "disabled": true
                },
                {
                  "key": "from",
                  "value": "",
                  "description": "The number: its phone_number_id or walpio's number id. Without it, the oldest active number.",
                  "disabled": true
                }
              ],
              "variable": [
                {
                  "key": "name",
                  "value": "",
                  "description": "The template's name."
                }
              ]
            },
            "description": "Every language at Meta, or one with ?language= (once walpio has read it from Meta). A template belongs to the WhatsApp Business Account: it goes for every number of that account. Needs the `templates:write` scope (create or delete templates).\n\nReference: https://walpio.com/docs#delete-a-template"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Text rules",
      "item": [
        {
          "name": "List text rules",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/text-rules",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "text-rules"
              ]
            },
            "description": "Every rule, sorted by name, and what the workspace does with a text no rule matches. Needs the `text-rules:read` scope (list or test text rules).\n\nReference: https://walpio.com/docs#list-rules"
          },
          "response": []
        },
        {
          "name": "Create a text rule",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"name\": \"Invoice issued\",\n  \"pattern\": \"Your invoice {{number}} for AED {{amount}} is due on {{due}}.\",\n  \"templateName\": \"invoice_issued\",\n  \"templateLanguage\": \"en\",\n  \"params\": [\n    \"number\",\n    \"amount\",\n    \"due\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/text-rules",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "text-rules"
              ]
            },
            "description": "A wording you send, with {{placeholders}} for the parts that change, and the approved template to send instead outside the window. Checked against the template before it is saved. Needs the `text-rules:write` scope (create or delete text rules).\n\nReference: https://walpio.com/docs#create-a-rule"
          },
          "response": []
        },
        {
          "name": "Delete a text rule",
          "request": {
            "method": "DELETE",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/text-rules/:id",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "text-rules",
                ":id"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "The id (walpio's; for a message, walpio's id or Meta's wamid)."
                }
              ]
            },
            "description": "The rule is gone; a text it took is refused (or goes through the fallback) from then on. Needs the `text-rules:write` scope (create or delete text rules).\n\nReference: https://walpio.com/docs#delete-a-rule"
          },
          "response": []
        },
        {
          "name": "Test a text against the rules",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"text\": \"Your invoice INV-2041 for AED 1,250.00 is due on 30 September.\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/text-rules/test",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "text-rules",
                "test"
              ]
            },
            "description": "Which rule a text would use and the values it would send — or the closest rule and where the text departs from it. Sends nothing. Needs the `text-rules:read` scope (list or test text rules).\n\nReference: https://walpio.com/docs#test-a-text"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Contacts",
      "item": [
        {
          "name": "Record a customer's opt-in or opt-out",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"+971501234567\",\n  \"optedIn\": true,\n  \"source\": \"signup form\",\n  \"evidence\": \"web form v3, WhatsApp updates box ticked\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/contacts/consent",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "contacts",
                "consent"
              ]
            },
            "description": "From your own systems, on every number and every identifier the customer is known by. Undoing a STOP the customer texted needs evidence. Needs the `contacts:write` scope (record opt-ins and opt-outs).\n\nReference: https://walpio.com/docs#record-an-opt-in-or-an-opt-out"
          },
          "response": []
        },
        {
          "name": "Read a contact",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/contacts/:to",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "contacts",
                ":to"
              ],
              "variable": [
                {
                  "key": "to",
                  "value": "",
                  "description": "The customer: a number in international form, or a business-scoped user id."
                }
              ]
            },
            "description": "The customer under every identifier walpio has linked: consent, language, the 24-hour window, the ad they came from. Needs the `contacts:read` scope (read contacts).\n\nReference: https://walpio.com/docs#read-a-contact"
          },
          "response": []
        },
        {
          "name": "Set a customer's language",
          "request": {
            "method": "PATCH",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"language\": \"ar\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/contacts/:to",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "contacts",
                ":to"
              ],
              "variable": [
                {
                  "key": "to",
                  "value": "",
                  "description": "The customer: a number in international form, or a business-scoped user id."
                }
              ]
            },
            "description": "The language `\"language\": \"auto\"` sends their templates in; null forgets it (walpio infers it again from their texts). Needs the `contacts:write` scope (record opt-ins and opt-outs).\n\nReference: https://walpio.com/docs#a-customers-language"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Callbacks",
      "item": [
        {
          "name": "The callback URL and its events",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks"
              ]
            },
            "description": "Where walpio posts its callbacks, and which events and statuses they carry. The URL and the secret are set in the dashboard. Needs the `webhooks:read` scope (read the callback settings and deliveries).\n\nReference: https://walpio.com/docs#choosing-the-events"
          },
          "response": []
        },
        {
          "name": "Choose the events",
          "request": {
            "method": "PUT",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"events\": [\n    \"message.status\",\n    \"message.inbound\"\n  ],\n  \"message_statuses\": [\n    \"failed\"\n  ]\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/events",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                "events"
              ]
            },
            "description": "The events the callbacks carry (message.status, message.inbound, template.status, number.health, number.quality), and for message.status the statuses (left out: every status). Needs the `webhooks:write` scope (choose callback events or redeliver callbacks).\n\nReference: https://walpio.com/docs#choosing-the-events"
          },
          "response": []
        },
        {
          "name": "List callback deliveries",
          "request": {
            "method": "GET",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/deliveries",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                "deliveries"
              ],
              "query": [
                {
                  "key": "status",
                  "value": "",
                  "description": "Only the deliveries in this state.",
                  "disabled": true
                },
                {
                  "key": "since",
                  "value": "",
                  "description": "An ISO 8601 time, such as 2026-10-01T00:00:00Z.",
                  "disabled": true
                },
                {
                  "key": "until",
                  "value": "",
                  "description": "An ISO 8601 time.",
                  "disabled": true
                },
                {
                  "key": "limit",
                  "value": "",
                  "description": "Deliveries per page: 1–100 (50 when not given).",
                  "disabled": true
                },
                {
                  "key": "cursor",
                  "value": "",
                  "description": "The previous page's next_cursor, exactly as it came.",
                  "disabled": true
                }
              ]
            },
            "description": "Each callback of the last 30 days, newest first, with what walpio sent and what your server answered. 60 pages a minute per workspace. Needs the `webhooks:read` scope (read the callback settings and deliveries).\n\nReference: https://walpio.com/docs#deliveries-and-redelivery"
          },
          "response": []
        },
        {
          "name": "Send a failed callback again",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "url": {
              "raw": "{{baseUrl}}/v1/webhooks/deliveries/:id/redeliver",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "webhooks",
                "deliveries",
                ":id",
                "redeliver"
              ],
              "variable": [
                {
                  "key": "id",
                  "value": "",
                  "description": "The id (walpio's; for a message, walpio's id or Meta's wamid)."
                }
              ]
            },
            "description": "The same id and body, a new signature, to the callback URL set now. 1,000 a day per workspace. Needs the `webhooks:write` scope (choose callback events or redeliver callbacks).\n\nReference: https://walpio.com/docs#deliveries-and-redelivery"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Verification",
      "item": [
        {
          "name": "Send a one-time code",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"971509876543\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/verify/start",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "verify",
                "start"
              ]
            },
            "description": "A 6-digit code through the number's approved authentication template; walpio keeps only a keyed hash of it. Needs the `verifications:write` scope (send and check one-time verification codes).\n\nReference: https://walpio.com/docs#verify-a-customer-one-time-codes"
          },
          "response": []
        },
        {
          "name": "Check a one-time code",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"to\": \"971509876543\",\n  \"code\": \"123456\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/verify/check",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "verify",
                "check"
              ]
            },
            "description": "The code the customer typed (Arabic-Indic digits, spaces and dashes are fine); 5 wrong codes end it, and so does the customer’s 20th wrong code in 24 hours. Needs the `verifications:write` scope (send and check one-time verification codes).\n\nReference: https://walpio.com/docs#verify-a-customer-one-time-codes"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Sandbox",
      "item": [
        {
          "name": "The sandbox's customer replies",
          "request": {
            "method": "POST",
            "header": [
              {
                "key": "Content-Type",
                "value": "application/json"
              },
              {
                "key": "Walpio-Error-Format",
                "value": "",
                "description": "meta: every error in the shape Meta's Graph API answers (walpio's code and retryable stay in error.walpio).",
                "disabled": true
              }
            ],
            "body": {
              "mode": "raw",
              "raw": "{\n  \"from\": \"+971501234567\",\n  \"text\": \"Hi, when does the technician arrive?\"\n}",
              "options": {
                "raw": {
                  "language": "json"
                }
              }
            },
            "url": {
              "raw": "{{baseUrl}}/v1/sandbox/inbound",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "sandbox",
                "inbound"
              ]
            },
            "description": "A test key only (`wp_test_…`): a text from `from` to the sandbox's simulated number, as a customer's message would arrive — its callback, its contact, and the 24-hour window opened. A live key is refused (403 `sandbox_only`). Needs the `messages:send` scope (send messages).\n\nReference: https://walpio.com/docs#the-sandbox-test-keys"
          },
          "response": []
        }
      ]
    },
    {
      "name": "Reference",
      "item": [
        {
          "name": "This description",
          "request": {
            "auth": {
              "type": "noauth"
            },
            "method": "GET",
            "header": [],
            "url": {
              "raw": "{{baseUrl}}/v1/openapi.json",
              "host": [
                "{{baseUrl}}"
              ],
              "path": [
                "v1",
                "openapi.json"
              ]
            },
            "description": "The client API as OpenAPI 3.1 — no key needed. Also at walpio.com/docs, with a Postman collection made from it. No API key needed.\n\nReference: https://walpio.com/docs#openapi-and-postman"
          },
          "response": []
        }
      ]
    }
  ]
}
