Skip to content
PaalChat Docs

AI Version / Markdown

Everything on this site is also plain Markdown, so an AI coding assistant can read the same documentation you do. Give your assistant one of these links:

llms.txt

The rules, endpoint and error tables, and task recipes - start here.

llms-full.txt

Every guide and every reference page in one Markdown file.

openapi.yaml

The OpenAPI 3.1 contract, for tools and client generators.

Prompt for your assistant

"Read https://chat.paaltech.org/llms.txt and follow its rules exactly. Use https://chat.paaltech.org/llms-full.txt for details. Integrate our product with PaalChat: ..."

Guides as Markdown

API Reference as Markdown

GET Get product api/get-me.md GET Get usage api/get-usage.md GET List businesses api/list-businesses.md POST Create or update business api/upsert-business.md GET Get business api/get-business.md GET List library templates api/list-template-library.md POST Create connect link api/create-connect-link.md GET Get WhatsApp state api/get-whatsapp.md GET List phone numbers api/list-phone-numbers.md GET List templates api/list-templates.md POST Create template api/create-template.md POST Create template from library api/create-template-from-library.md GET List template versions api/list-template-versions.md DELETE Delete template api/delete-template.md GET List account transfers api/list-transfers.md POST Approve or reject a transfer api/decide-transfer.md DELETE Disconnect WABA api/disconnect-waba.md POST Send message api/send-message.md GET Get message api/get-message.md DELETE Cancel scheduled message api/cancel-message.md GET Get Meta usage api/get-meta-usage.md POST Estimate Meta cost api/estimate-meta-cost.md GET List plans api/list-plans.md GET Get billing api/get-billing.md POST Pay invoice api/pay-invoice.md GET Get provider health api/get-providers.md GET List channels api/list-channels.md PUT Set up SMS or email api/enable-channel.md DELETE Turn off SMS or email api/disable-channel.md POST Send notification api/send-notification.md GET Get notification api/get-notification.md GET List segments api/list-segments.md POST Create segment api/create-segment.md POST Preview segment api/preview-segment.md GET Get segment api/get-segment.md PATCH Update segment api/update-segment.md DELETE Delete segment api/delete-segment.md GET List segment contacts api/list-segment-contacts.md GET List campaigns api/list-campaigns.md POST Create campaign api/create-campaign.md GET Get campaign api/get-campaign.md POST Preview campaign api/preview-campaign.md POST Launch campaign api/launch-campaign.md POST Pause, resume or cancel campaign api/change-campaign.md GET List automations api/list-automations.md POST Create automation api/create-automation.md GET Get automation api/get-automation.md PATCH Update automation api/update-automation.md DELETE Delete automation api/delete-automation.md GET List automation runs api/list-automation-runs.md DELETE Erase contact api/erase-contact.md GET Get consent and preferences api/get-consents.md PUT Record consent api/set-consent.md PUT Set notification preferences api/set-preferences.md GET List suppressed numbers api/list-suppressions.md POST Suppress a number api/add-suppression.md DELETE Remove a suppressed number api/remove-suppression.md POST Export business data api/create-export.md GET Get export api/get-export.md POST Simulate an incoming message api/sandbox-incoming.md POST Simulate a delivery status api/sandbox-status.md POST Sign staff in to the inbox api/inbox-sign-in.md GET List inbox members api/list-inbox-members.md DELETE Remove inbox access api/disable-inbox-member.md POST Upload media api/upload-media.md GET Get media api/get-media.md GET List contacts api/list-contacts.md POST Create or update contact api/upsert-contact.md GET Get contact api/get-contact.md PATCH Update contact api/update-contact.md GET List contact fields api/list-contact-fields.md PUT Define a contact field api/define-contact-field.md GET List conversations api/list-conversations.md GET Get conversation api/get-conversation.md PATCH Update conversation api/update-conversation.md GET List conversation messages api/list-conversation-messages.md GET List notes api/list-conversation-notes.md POST Add note api/add-conversation-note.md Event message.received api/callbacks/message-received.md Event message.status api/callbacks/message-status.md Event template.status api/callbacks/template-status.md Event whatsapp.connection api/callbacks/whatsapp-connection.md Event contact.created api/callbacks/contact-created.md Event contact.updated api/callbacks/contact-updated.md Event conversation.created api/callbacks/conversation-created.md Event conversation.updated api/callbacks/conversation-updated.md Event media.updated api/callbacks/media-updated.md Event contact.consent api/callbacks/contact-consent.md Event campaign.updated api/callbacks/campaign-updated.md Event automation.action api/callbacks/automation-action.md Event notification.updated api/callbacks/notification-updated.md