Skip to content

Instaply API overview

Instaply’s me.instaply.com/api/… surface is best thought of as a command/query API over HTTP: discrete endpoints for actions such as sending a message or updating thread state, and read-style calls where you need channel context (for example WhatsApp messaging windows). It is not a full REST resource model—expect purpose-named paths and JSON bodies rather than a uniform CRUD layout.

You also use HTTPS for webhooks (Instaply calls your URL with event payloads).

Request an API token from your Instaply customer representative. The token is tied to a specific user in the Instaply UI; you can only access and modify threads that user can access.

See Authentication for required headers. For how this credential relates to the mobile SDK, see Credentials.

  • Commands / queries — Send messages, update threads, fetch thread or template data, and read/update customer profiles via GET/POST under https://me.instaply.com/api/….
  • Webhooks — Receive events (messages, transfers) at your own HTTPS URL. Prefer the Webhook API for new integrations.
  • Widget embed — Start a customer→business thread from a web embed via Widget (POST /api/widget/send-message-to-business).