{ "variable": [ { "id": "baseUrl", "key": "baseUrl", "type": "string", "name": "string", "value": "https:\/\/metzi-messages.axolotesource.io" } ], "info": { "name": "Metzi Message API Documentation", "_postman_id": "e930d348-b4d0-4a66-a220-f0a25418a9d8", "description": "A multi-channel API to send messages via email and WhatsApp using different providers. Flexible, scalable, and easy to integrate.", "schema": "https:\/\/schema.getpostman.com\/json\/collection\/v2.1.0\/collection.json" }, "item": [ { "name": "Campaigns", "description": "", "item": [ { "name": "List all campaigns.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of campaigns with their channel, WhatsApp template and status. Supports search by name." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"01a1c240-3857-7193-9352-16c9c2462118\",\"name\":\"aut adipisci quidem\",\"channel_id\":62,\"channel_name\":\"Iure odit.\",\"status_name\":\"Pending\",\"whatsapp_template_id\":\"01a1c240-3854-707d-b788-a429dbc6fa3c\",\"template_name\":\"enim non facere\",\"started_at\":\"2026-11-08T11:57:32.000000Z\",\"finished_at\":\"2026-10-26T03:50:40.000000Z\",\"created_at\":\"2026-11-09T21:39:11.000000Z\"},{\"id\":\"01a1c240-385f-7399-8211-84426013286b\",\"name\":\"laboriosam praesentium quis\",\"channel_id\":63,\"channel_name\":\"Eum.\",\"status_name\":\"Sending\",\"whatsapp_template_id\":\"01a1c240-385d-71d4-81b7-761ddb6719a4\",\"template_name\":\"nemo odit quia\",\"started_at\":\"2026-10-15T22:36:16.000000Z\",\"finished_at\":\"2026-11-07T21:00:15.000000Z\",\"created_at\":\"2026-11-09T21:39:11.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "multipart\/form-data" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "formdata", "formdata": [ { "key": "channel_id", "value": "4326.41688", "type": "text", "description": "The id<\/code> of an existing record in the channels table." }, { "key": "whatsapp_template_id", "value": "architecto", "type": "text", "description": "The id<\/code> of an existing record in the whatsapp_templates table." }, { "key": "name", "value": "n", "type": "text", "description": "Must not be greater than 255 characters." }, { "key": "started_at", "value": "2026-11-09T21:39:11", "type": "text", "description": "Must be a valid date." }, { "key": "finished_at", "value": "2026-11-09T21:39:11", "type": "text", "description": "Must be a valid date." }, { "key": "campaign_status_id", "value": "4326.41688", "type": "text", "description": "" }, { "key": "file", "src": [], "type": "file" } ] }, "description": "Creates a new campaign from a CSV\/TXT file containing the recipient phone numbers. The campaign is created with pending status." }, "response": [] }, { "name": "Get a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The campaign ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Returns the details of the campaign identified by its ID, including its channel, status, WhatsApp template and recipients." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01a1c240-38d0-7294-9ee8-6a3404533f41\",\"name\":\"eius et animi\",\"channel_id\":65,\"channel_name\":\"Sunt.\",\"status_name\":\"Cancelled\",\"whatsapp_template_id\":\"01a1c240-38cf-734a-916b-015120eb161d\",\"template_name\":\"adipisci quidem nostrum\",\"whatsapp_template\":{\"id\":\"01a1c240-38cf-734a-916b-015120eb161d\",\"name\":\"adipisci quidem nostrum\",\"language\":\"es_MX\",\"category\":\"MARKETING\",\"status\":\"APPROVED\",\"components\":[]},\"started_at\":\"2026-10-19T03:18:21.000000Z\",\"finished_at\":\"2026-10-15T09:31:38.000000Z\",\"created_at\":\"2026-11-09T21:39:11.000000Z\",\"updated_at\":\"2026-11-09T21:39:11.000000Z\"}}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The campaign ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\",\"channel_id\":4326.41688,\"whatsapp_template_id\":\"architecto\",\"name\":\"n\"}" }, "description": "Updates the name, channel, WhatsApp template and scheduling dates of the campaign identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01a1c240-3903-70b1-84bc-3996d3d314f8\",\"name\":\"et animi quos\",\"channel_id\":67,\"channel_name\":\"Sunt.\",\"status_name\":\"Pending\",\"whatsapp_template_id\":\"01a1c240-3901-7395-a260-62ce3ab08aa9\",\"template_name\":\"nostrum qui commodi\",\"whatsapp_template\":{\"id\":\"01a1c240-3901-7395-a260-62ce3ab08aa9\",\"name\":\"nostrum qui commodi\",\"language\":\"en_US\",\"category\":\"MARKETING\",\"status\":\"PENDING\",\"components\":[]},\"started_at\":null,\"finished_at\":\"2026-10-15T09:31:38.000000Z\",\"created_at\":\"2026-11-09T21:39:11.000000Z\",\"updated_at\":\"2026-11-09T21:39:11.000000Z\"}}", "name": "" } ] }, { "name": "Delete a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The campaign ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Removes the campaign identified by its ID." }, "response": [] }, { "name": "List the phones of a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:id\/phones", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:id\/phones", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The campaign ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Returns a paginated list of phone numbers associated with the campaign identified by its ID. Supports search by phone." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":13,\"phone\":\"+12038673351\",\"whatsapp_status\":\"true\"},{\"id\":14,\"phone\":\"+13375699723\",\"whatsapp_status\":\"true\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Send a campaign.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/campaigns\/:id\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/campaigns\/:id\/send", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The campaign ID." } ] }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\",\"campaign_status_id\":4326.41688}" }, "description": "Starts sending the campaign identified by its ID. Only pending campaigns can be sent: the status changes to sending and the messages are queued for delivery." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01a1c240-3993-7246-88be-4eb3c13995c2\",\"name\":\"quos velit et\",\"channel_id\":69,\"channel_name\":\"Harum.\",\"status_name\":\"Pending\",\"whatsapp_template_id\":\"01a1c240-398f-70b6-b842-f34253ed19e0\",\"template_name\":\"commodi incidunt iure\",\"whatsapp_template\":{\"id\":\"01a1c240-398f-70b6-b842-f34253ed19e0\",\"name\":\"commodi incidunt iure\",\"language\":\"pt_BR\",\"category\":\"AUTHENTICATION\",\"status\":\"PENDING\",\"components\":[]},\"started_at\":\"2026-10-23T16:40:34.000000Z\",\"finished_at\":\"2026-10-31T13:10:43.000000Z\",\"created_at\":\"2026-11-09T21:39:11.000000Z\",\"updated_at\":\"2026-11-09T21:39:11.000000Z\"}}", "name": "" } ] } ] }, { "name": "Channels", "description": "", "item": [ { "name": "List all channels.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/channels", "query": [], "raw": "{{baseUrl}}\/api\/v1\/channels" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of messaging channels. Supports search by name." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":71,\"name\":\"Aut.\"},{\"id\":72,\"name\":\"Et et.\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Devices", "description": "", "item": [ { "name": "List the registered devices.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/firebase\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/firebase\/devices" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of active devices with their FCM token, operating system and owner." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":44,\"fcm_token\":\"optio-laboriosam-cumque-incidunt-ipsa-non-laborum-rerum-officiis-reiciendis-necessitatibus-officiis-nihil\",\"os\":\"web\",\"active\":true,\"user_id\":\"e12c547f-177d-3325-99be-76a71ba70b94\"},{\"id\":45,\"fcm_token\":\"dolore-consequatur-dolorum-est-voluptas-expedita-eos-molestiae-aliquid\",\"os\":\"android\",\"active\":true,\"user_id\":\"ccb45e30-4579-3bc3-a503-50d70daf2067\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Register a device.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/firebase\/devices", "query": [], "raw": "{{baseUrl}}\/api\/v1\/firebase\/devices" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fcm_token\":\"architecto\",\"os\":\"architecto\"}" }, "description": "Validates the FCM token against Firebase and stores it with its operating system for the authenticated user. If the token already exists, the existing device is updated." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"fcm_token\":\"quos-velit-et-fugiat-sunt-nihil-accusantium-harum-mollitia-modi-deserunt-aut-ab\",\"active\":true}}", "name": "" } ] }, { "name": "Update a device.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/firebase\/devices\/:fcm_token", "query": [], "raw": "{{baseUrl}}\/api\/v1\/firebase\/devices\/:fcm_token", "variable": [ { "id": "fcm_token", "key": "fcm_token", "value": "architecto", "description": "The FCM token that identifies the device." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"fcm_token\":\"architecto\",\"active\":true}" }, "description": "Enables or disables the device identified by its FCM token. If the token is not registered, no changes are made." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"fcm_token\":\"perspiciatis-quo-omnis-nostrum-aut-adipisci-quidem-nostrum-qui-commodi-incidunt-iure-odit-et\",\"active\":true}}", "name": "" } ] } ] }, { "name": "Drivers", "description": "", "item": [ { "name": "List all drivers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/drivers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/drivers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of messaging drivers. Supports search by name." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":1,\"name\":\"smtp\",\"config_key\":\"mail.mailers.smtp\",\"created_at\":\"2026-09-10T19:37:57.000000Z\",\"updated_at\":\"2026-11-09T21:39:07.000000Z\"},{\"id\":1,\"name\":\"smtp\",\"config_key\":\"mail.mailers.smtp\",\"created_at\":\"2026-09-10T19:37:57.000000Z\",\"updated_at\":\"2026-11-09T21:39:07.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a driver.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/drivers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/drivers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"config_key\":\"n\"}" }, "description": "Creates a new messaging driver with its name and configuration key." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":1,\"name\":\"smtp\",\"config_key\":\"mail.mailers.smtp\",\"created_at\":\"2026-09-10T19:37:57.000000Z\",\"updated_at\":\"2026-11-09T21:39:07.000000Z\"}}", "name": "" } ] }, { "name": "Get a driver.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/drivers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/drivers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The driver ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":4326.41688}" }, "description": "Returns the driver identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"smtp\",\"config_key\":\"mail.mailers.smtp\",\"created_at\":\"2026-09-10T19:37:57.000000Z\",\"updated_at\":\"2026-11-09T21:39:07.000000Z\"}}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a driver.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/drivers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/drivers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The driver ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":4326.41688,\"name\":\"m\",\"config_key\":\"i\"}" }, "description": "Updates the name and configuration key of the driver identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":1,\"name\":\"smtp\",\"config_key\":\"mail.mailers.smtp\",\"created_at\":\"2026-09-10T19:37:57.000000Z\",\"updated_at\":\"2026-11-09T21:39:07.000000Z\"}}", "name": "" } ] }, { "name": "Delete a driver.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/drivers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/drivers\/:id", "variable": [ { "id": "id", "key": "id", "value": "16", "description": "The driver ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":4326.41688}" }, "description": "Removes the driver identified by its ID. Drivers associated with provider configurations cannot be deleted." }, "response": [] } ] }, { "name": "Emails", "description": "", "item": [ { "name": "List all email templates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/emails", "query": [], "raw": "{{baseUrl}}\/api\/v1\/emails" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of email templates with their variables. Supports search by name." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"01a1c240-372a-73e4-be02-3b10d961b409\",\"name\":\"aut\",\"description\":\"Quidem nostrum qui commodi incidunt iure odit.\",\"view_path\":\"emails.templates.aut\",\"subject\":\"Et modi ipsum nostrum omnis autem et consequatur.\",\"variables\":[],\"raw_data\":null,\"created_at\":\"2026-11-09T21:39:10.000000Z\"},{\"id\":\"01a1c240-3731-7309-bada-2999cb74c1a5\",\"name\":\"dolores\",\"description\":\"Non facere tempora ex voluptatem laboriosam praesentium.\",\"view_path\":\"emails.templates.dolores\",\"subject\":\"Adipisci molestias fugit deleniti distinctio eum doloremque id.\",\"variables\":[],\"raw_data\":null,\"created_at\":\"2026-11-09T21:39:10.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "Messages", "description": "", "item": [ { "name": "Send a WhatsApp template message.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/messages\/whatsapp\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/messages\/whatsapp\/send" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"template_name\":\"architecto\",\"phone_number\":\"architecto\"}" }, "description": "Sends a WhatsApp template message to a phone number using the default Meta provider, with optional parameters and buttons." }, "response": [] }, { "name": "Send a WhatsApp document by URL.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/messages\/whatsapp\/send-document-by-url", "query": [], "raw": "{{baseUrl}}\/api\/v1\/messages\/whatsapp\/send-document-by-url" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"country_code\":\"architecto\",\"phone_number\":\"8225697751\",\"url\":\"http:\\\/\\\/crooks.biz\\\/et-fugiat-sunt-nihil-accusantium\",\"filename\":\"architecto\"}" }, "description": "Sends a document to a WhatsApp number using a publicly accessible URL and the given filename." }, "response": [] }, { "name": "Send an email message.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/messages\/email\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/messages\/email\/send" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"template_name\":\"architecto\",\"subject\":\"architecto\",\"to\":\"architecto\",\"cc\":\"architecto\"}" }, "description": "Sends an email using the given template and the default email provider. A message record is created along with its history and details." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":24,\"channel_provider_id\":\"01a1c240-360a-72b0-bceb-658f71fc8ff5\",\"created_user_id\":\"6806\",\"message_status_id\":13,\"attempts\":53,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\",\"deleted_at\":null}}", "name": "" } ] }, { "name": "Send a push notification.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/messages\/push-notifications\/send", "query": [], "raw": "{{baseUrl}}\/api\/v1\/messages\/push-notifications\/send" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"push_notification_id\":\"architecto\"}" }, "description": "Sends a pending push notification to specific users, a user list, or all users." }, "response": [] } ] }, { "name": "Providers", "description": "", "item": [ { "name": "List all providers.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/providers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/providers" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of messaging providers with their channels and configuration. Supports search by name." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"01a1c240-3b13-7289-80ec-612c18699585\",\"name\":\"Aut.\",\"active\":true,\"channels\":[],\"driver_name\":null,\"default\":false,\"provider_config\":null},{\"id\":\"01a1c240-3b1b-716c-b50c-5ee841fee79c\",\"name\":\"Nostrum.\",\"active\":true,\"channels\":[],\"driver_name\":null,\"default\":false,\"provider_config\":null}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a provider.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/providers", "query": [], "raw": "{{baseUrl}}\/api\/v1\/providers" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"name\":\"b\",\"active\":false,\"channel_ids\":[16],\"provider_config\":{\"name\":\"b\",\"driver_id\":16,\"active\":false,\"default\":true}}" }, "description": "Creates a provider with its channels and a single provider configuration." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":\"01a1c240-3b4e-7032-8f21-60fc13309704\",\"name\":\"Eius et.\",\"active\":true,\"channels\":[],\"driver_name\":null,\"default\":false,\"provider_config\":null}}", "name": "" } ] }, { "name": "Get a provider.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/providers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/providers\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The provider UUID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Returns the provider identified by its ID, including its channels and configuration." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01a1c240-3ba6-71e3-acda-13acc3b6c322\",\"name\":\"Eius et.\",\"active\":true,\"channels\":[],\"driver_name\":null,\"default\":false,\"provider_config\":null}}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a provider.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/providers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/providers\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The provider UUID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\",\"name\":\"n\",\"active\":true,\"channel_ids\":[16],\"provider_config\":{\"name\":\"b\",\"driver_id\":16,\"active\":false,\"default\":true}}" }, "description": "Updates the name, active state, channels and configuration of the provider identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01a1c240-3bcc-71ee-8bc9-c0c63b1942c1\",\"name\":\"Eius et.\",\"active\":true,\"channels\":[],\"driver_name\":null,\"default\":false,\"provider_config\":null}}", "name": "" } ] }, { "name": "Delete a provider.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/providers\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/providers\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The provider UUID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Removes the provider identified by its ID. Providers with associated messages cannot be deleted." }, "response": [] } ] }, { "name": "Push Notifications", "description": "", "item": [ { "name": "List all push notifications.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push-notifications", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push-notifications" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of push notifications with their status. Supports search by title or body." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"01a1c240-377b-7004-b0b8-a5ea2c9ab912\",\"title\":\"Adipisci quidem nostrum qui commodi incidunt iure.\",\"body\":\"Et modi ipsum nostrum omnis autem et consequatur. Dolores enim non facere tempora. Voluptatem laboriosam praesentium quis adipisci.\",\"status_name\":\"Pending\",\"total_devices\":0,\"success_count\":0,\"failure_count\":0,\"created_at\":\"2026-11-09T21:39:10.000000Z\"},{\"id\":\"01a1c240-3780-72f2-a615-6c518dbfc024\",\"title\":\"Distinctio eum doloremque id aut libero aliquam veniam corporis.\",\"body\":\"Deleniti nemo odit quia officia. Dignissimos neque blanditiis odio. Excepturi doloribus delectus fugit qui repudiandae laboriosam.\",\"status_name\":\"Pending\",\"total_devices\":0,\"success_count\":0,\"failure_count\":0,\"created_at\":\"2026-11-09T21:39:10.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a push notification.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push-notifications", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push-notifications" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"title\":\"architecto\",\"body\":\"architecto\"}" }, "description": "Creates a new push notification with a title, body and optional data payload." }, "response": [] }, { "name": "Get a push notification.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push-notifications\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push-notifications\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The push notification ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Returns the push notification identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"01a1c240-37d9-71ee-b271-e0f023ecc697\",\"title\":\"Et animi quos velit et fugiat.\",\"body\":\"Accusantium harum mollitia modi deserunt aut ab. Perspiciatis quo omnis nostrum aut adipisci quidem nostrum qui. Incidunt iure odit et et modi ipsum.\",\"data\":null,\"user_ids\":[\"d98239dc-1582-3bf2-b93a-df3a18e121d1\"],\"status_name\":\"Pending\",\"push_notification_status_id\":1,\"total_devices\":0,\"success_count\":0,\"failure_count\":0,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Update a push notification.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push-notifications\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push-notifications\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The push notification ID." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\",\"title\":\"architecto\",\"body\":\"architecto\"}" }, "description": "Updates the title, body and optional data payload of the push notification identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"id\":\"01a1c240-37fb-731a-9315-3dfb9185fabc\",\"title\":\"Et animi quos velit et fugiat.\",\"body\":\"Accusantium harum mollitia modi deserunt aut ab. Perspiciatis quo omnis nostrum aut adipisci quidem nostrum qui. Incidunt iure odit et et modi ipsum.\",\"data\":null,\"user_ids\":[\"d98239dc-1582-3bf2-b93a-df3a18e121d1\"],\"status_name\":\"Pending\",\"push_notification_status_id\":1,\"total_devices\":0,\"success_count\":0,\"failure_count\":0,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}", "name": "" } ] }, { "name": "Delete a push notification.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/push-notifications\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/push-notifications\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The push notification ID." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Removes the push notification identified by its ID." }, "response": [] } ] }, { "name": "WhatsApp", "description": "", "item": [ { "name": "Get the WhatsApp account information.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/info", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/info" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns the ID, verified name and quality information of the configured WhatsApp phone number." }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Send a WhatsApp text message.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/send-text", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/send-text" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"phone_number\":\"architecto\",\"text\":\"n\"}" }, "description": "Sends a plain text message to a WhatsApp number using the default Meta provider." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":27,\"phone_number\":\"+14636223498\",\"text\":\"Et fugiat sunt nihil accusantium.\",\"direction\":\"inbound\",\"status\":null,\"created_at\":\"2026-11-09T21:39:09.000000Z\"}}", "name": "" } ] } ] }, { "name": "WhatsApp Incoming", "description": "", "item": [ { "name": "List all incoming WhatsApp contacts.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/incoming\/contacts", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/incoming\/contacts" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of contacts that have interacted via WhatsApp, including their last message and unread count. Supports search by phone or profile name." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":49,\"phone\":\"+16198290034\",\"name\":\"Ferne Fritsch\",\"last_message_text\":\"Omnis autem et consequatur.\",\"last_message_at\":\"2026-11-09T21:39:09.000000Z\",\"unread_count\":0,\"created_at\":\"2026-11-09T21:39:09.000000Z\"},{\"id\":50,\"phone\":\"+15405072316\",\"name\":\"Sebastian Haag I\",\"last_message_text\":\"Distinctio eum doloremque id aut libero aliquam veniam corporis.\",\"last_message_at\":\"2026-11-09T21:39:09.000000Z\",\"unread_count\":0,\"created_at\":\"2026-11-09T21:39:09.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get an incoming WhatsApp contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/incoming\/contacts\/:contact", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/incoming\/contacts\/:contact", "variable": [ { "id": "contact", "key": "contact", "value": "architecto", "description": "The WhatsApp contact ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact\":\"architecto\"}" }, "description": "Returns the contact identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":52,\"phone\":\"+18433596343\",\"name\":\"Misael Runte\",\"last_message_text\":\"Aut ab provident perspiciatis quo omnis nostrum aut.\",\"last_message_at\":\"2026-11-09T21:39:09.000000Z\",\"unread_count\":0,\"messages_count\":0,\"created_at\":\"2026-11-09T21:39:09.000000Z\",\"updated_at\":\"2026-11-09T21:39:09.000000Z\"}}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "List the messages of an incoming WhatsApp contact.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/incoming\/contacts\/:contact\/messages", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/incoming\/contacts\/:contact\/messages", "variable": [ { "id": "contact", "key": "contact", "value": "architecto", "description": "The WhatsApp contact ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"contact\":\"architecto\"}" }, "description": "Returns a paginated list of messages exchanged with the contact identified by its ID. Supports search by message text or WhatsApp message ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":29,\"contact_id\":54,\"wa_message_id\":\"wamid.a4855dc5-0acb-33c3-b921-f4291f719ca0\",\"direction\":\"inbound\",\"status\":null,\"type\":\"text\",\"text\":\"Velit et fugiat sunt nihil accusantium.\",\"media\":null,\"wa_timestamp\":1712589330,\"created_at\":\"2026-11-09T21:39:09.000000Z\"},{\"id\":30,\"contact_id\":55,\"wa_message_id\":\"wamid.5c77ccef-fec6-3e83-b8b6-08a373c85aef\",\"direction\":\"inbound\",\"status\":null,\"type\":\"text\",\"text\":\"Tempora ex voluptatem laboriosam praesentium quis.\",\"media\":null,\"wa_timestamp\":1719197123,\"created_at\":\"2026-11-09T21:39:10.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get an incoming WhatsApp message.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/incoming\/messages\/:message", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/incoming\/messages\/:message", "variable": [ { "id": "message", "key": "message", "value": "architecto", "description": "The WhatsApp message ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"message\":\"architecto\"}" }, "description": "Returns the message identified by its ID, including its type, content and timestamp." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":32,\"contact_id\":57,\"wa_message_id\":\"wamid.c90237e9-ced5-3af6-88ea-84aeaa148878\",\"direction\":\"inbound\",\"status\":null,\"type\":\"text\",\"text\":\"Fugiat sunt nihil accusantium harum mollitia.\",\"media\":null,\"raw\":[],\"wa_timestamp\":1729000538,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] } ] }, { "name": "WhatsApp Replicate URLs", "description": "", "item": [ { "name": "List all WhatsApp replicate URLs.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/replicate-urls", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/replicate-urls" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of replicate URLs, with optional search by URL." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":45,\"url\":\"http:\\\/\\\/www.price.org\\\/\",\"is_active\":true,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"},{\"id\":46,\"url\":\"http:\\\/\\\/www.dare.org\\\/iure-odit-et-et-modi-ipsum-nostrum-omnis\",\"is_active\":true,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Create a new WhatsApp replicate URL.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/replicate-urls", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/replicate-urls" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"url\":\"http:\\\/\\\/www.bailey.biz\\\/quos-velit-et-fugiat-sunt-nihil-accusantium-harum.html\"}" }, "description": "Stores a new replicate URL with an optional active status (active by default)." }, "response": [ { "header": [], "code": 201, "body": "{\"data\":{\"id\":48,\"url\":\"https:\\\/\\\/www.runte.com\\\/ab-provident-perspiciatis-quo-omnis-nostrum-aut-adipisci\",\"is_active\":true,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}}", "name": "" } ] }, { "name": "Update an existing WhatsApp replicate URL.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/replicate-urls\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/replicate-urls\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the replicate url." } ] }, "method": "PUT", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\",\"url\":\"http:\\\/\\\/bailey.com\\\/\"}" }, "description": "Updates the URL and, optionally, the active status of the replicate URL identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":50,\"url\":\"http:\\\/\\\/rempel.com\\\/sunt-nihil-accusantium-harum-mollitia\",\"is_active\":true,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}}", "name": "" } ] }, { "name": "Delete a WhatsApp replicate URL.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/replicate-urls\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/replicate-urls\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the replicate url." } ] }, "method": "DELETE", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Removes the replicate URL identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":52,\"url\":\"http:\\\/\\\/bailey.com\\\/\",\"is_active\":true,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}}", "name": "" } ] }, { "name": "Toggle the active status of a WhatsApp replicate URL.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/replicate-urls\/:id\/toggle", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/replicate-urls\/:id\/toggle", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The ID of the replicate url." } ] }, "method": "PATCH", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Switches the active status of the replicate URL identified by its ID." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":54,\"url\":\"https:\\\/\\\/nitzsche.net\\\/aliquam-veniam-corporis-dolorem-mollitia-deleniti-nemo.html\",\"is_active\":true,\"created_at\":\"2026-11-09T21:39:10.000000Z\",\"updated_at\":\"2026-11-09T21:39:10.000000Z\"}}", "name": "" } ] } ] }, { "name": "WhatsApp Templates", "description": "", "item": [ { "name": "List all WhatsApp templates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/templates", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/templates" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Returns a paginated list of WhatsApp templates with their components and variables." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":[{\"id\":\"01a1c240-32b9-7131-874f-0896a8afea63\",\"name\":\"quidem nostrum qui\",\"language\":\"en_US\",\"category\":\"MARKETING\",\"status\":\"APPROVED\",\"components\":[],\"created_at\":\"2026-11-09T21:39:09.000000Z\"},{\"id\":\"01a1c240-32c1-724f-9e9a-0fc677470258\",\"name\":\"et modi ipsum\",\"language\":\"en_US\",\"category\":\"MARKETING\",\"status\":\"APPROVED\",\"components\":[],\"created_at\":\"2026-11-09T21:39:09.000000Z\"}]}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Get a WhatsApp template.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/templates\/:id", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/templates\/:id", "variable": [ { "id": "id", "key": "id", "value": "architecto", "description": "The WhatsApp template ID." } ] }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"id\":\"architecto\"}" }, "description": "Returns the template identified by its ID, including its components and variables." }, "response": [ { "header": [], "code": 200, "body": "{\"data\":{\"id\":\"01a1c240-3321-72b7-86ce-6ceac61f1dd4\",\"whatsapp_template_id\":\"1374491711936806\",\"name\":\"animi quos velit\",\"language\":\"en_US\",\"category\":\"MARKETING\",\"status\":\"REJECTED\",\"raw_data\":[],\"components\":[],\"created_at\":\"2026-11-09T21:39:09.000000Z\",\"updated_at\":\"2026-11-09T21:39:09.000000Z\"}}", "name": "" }, { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 401, "body": "{\"message\":\"Unauthenticated.\"}", "name": "" } ] }, { "name": "Sync WhatsApp templates.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/templates\/sync", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/templates\/sync" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": null, "description": "Fetches the templates from the WhatsApp provider and creates or updates them locally." }, "response": [] } ] }, { "name": "WhatsApp Webhook", "description": "", "item": [ { "name": "Handle the WhatsApp webhook verification.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/webhook", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/webhook" }, "method": "GET", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"hub\":{\"mode\":\"architecto\",\"verify_token\":\"architecto\",\"challenge\":\"architecto\"}}" }, "description": "Validates the verification request sent by Meta and returns the challenge token. This endpoint is called by WhatsApp, not by API clients.", "auth": { "type": "noauth" } }, "response": [ { "header": [ { "key": "cache-control", "value": "no-cache, private" }, { "key": "content-type", "value": "application\/json" }, { "key": "access-control-allow-origin", "value": "*" } ], "code": 422, "body": "{\"status\":\"error\",\"message\":\"La configuraci\\u00f3n laravel-whatsapp-api.verify_token no existe o es inv\\u00e1lida\",\"data\":null}", "name": "" } ] }, { "name": "Process incoming WhatsApp webhook events.", "request": { "url": { "host": "{{baseUrl}}", "path": "api\/v1\/whatsapp\/webhook", "query": [], "raw": "{{baseUrl}}\/api\/v1\/whatsapp\/webhook" }, "method": "POST", "header": [ { "key": "Content-Type", "value": "application\/json" }, { "key": "Accept", "value": "application\/json" } ], "body": { "mode": "raw", "raw": "{\"object\":\"architecto\",\"entry\":[]}" }, "description": "Processes the incoming messages and status updates sent by WhatsApp. This endpoint is called by WhatsApp, not by API clients.", "auth": { "type": "noauth" } }, "response": [] } ] } ], "auth": { "type": "bearer", "bearer": [ { "key": "key", "type": "string" } ] } }