Developers

Inboxy API reference

Connect your systems to Inboxy — send every kind of WhatsApp message, create templates, campaigns and scheduled messages, and manage contacts, conversations, leads, tickets, orders, products and webhooks — with one API token.

547 endpoints

Quick start

In the dashboard open API and create a token.
Pick only the scopes your integration needs. The token is shown once — store it safely.
Send it in the Authorization header on every request.

curl "https://api.inboxy.chat/api/v1/public/contacts?pageSize=5" \
  -H "Authorization: Bearer inboxy_your_token"

Send your first WhatsApp message

Outside the 24-hour window WhatsApp needs an approved template (GET /whatsapp/templates); inside it, plain text works. The key needs messages:send.

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/template" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{"to":"966500000000","templateName":"order_shipped","languageCode":"ar"}'

Download Postman collection OpenAPI spec (JSON)

Scopes

ai:readai:writeanalytics:readautomations:readautomations:writecampaigns:readcampaigns:writechannels:readchannels:writecontacts:readcontacts:writeconversations:readconversations:writeecommerce:readecommerce:writeknowledge:readknowledge:writeleads:readleads:writelibrary:readlibrary:writemeetings:readmeetings:writemessages:readmessages:sendorders:readorders:writeproducts:readproducts:writetasks:readtasks:writeteam:readtemplates:readtemplates:writetickets:readtickets:writewebhooks:readwebhooks:write

Responses & errors

The /public routes return this success shape; every other route returns its own JSON object. Every error on every route called with a token has the second shape, with any extra fields under details.

{
  "success": true,
  "data": [ ... ],
  "meta": { "total": 120, "page": 1, "pageSize": 20, "totalPages": 6 }
}

{
  "success": false,
  "error": {
    "code": "INSUFFICIENT_PERMISSIONS",
    "message": "API token lacks required permission: templates:write",
    "details": { }
  }
}

400	`BAD_REQUEST · VALIDATION_ERROR`	The body or query is invalid. The message says which field.
401	`UNAUTHORIZED`	Missing, revoked or expired token, or a route keys cannot call.
403	`INSUFFICIENT_PERMISSIONS`	The token lacks the scope this route needs.
403	`SUBSCRIPTION_NOT_ACTIVE · FORBIDDEN`	The plan or channel does not allow this action.
404	`NOT_FOUND`	The resource is not in your company.
409	`CONFLICT`	The resource is not in a state that allows this (for example a template missing its media).
429	`TOO_MANY_REQUESTS`	60 requests per minute per token.
500	`INTERNAL_ERROR`	Our fault. Retry later; quote the X-Request-Id header to support.

Webhooks

Register a public HTTPS URL and Inboxy calls it the moment something happens: messages on every channel, button taps, delivery and read receipts, tickets, leads, and every order change from connected stores.

curl -X POST "https://api.inboxy.chat/api/v1/webhooks" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{"name":"CRM sync","url":"https://example.com/inboxy","events":["message.received","ecommerce.order.*","ticket.*"]}'

Subscribe to exact event names, "*" for everything, or a prefix like "whatsapp.*".
Any 2xx within 30 seconds is a success. Otherwise we retry 3 times by default (up to 9) with exponential backoff starting at 1 second.
After 50 consecutive failures (configurable) the webhook pauses and your admins are notified. Redeliver the last 7 days of failures with /replay.
A retry can deliver the same event twice — deduplicate on the payload id.

Payload

{
  "id": "cmfk2x9q10001abcd",
  "event": "ecommerce.order.shipped",
  "timestamp": "2026-09-15T18:42:10.512Z",
  "data": {
    "source": "orders",
    "occurredAt": "2026-09-15T18:42:09.000Z",
    "channelId": null,
    "conversationId": "cmfk1...",
    "contactId": "cmfk0...",
    "messageId": null,
    "externalMessageId": null,
    "payload": { "orderId": "...", "platform": "SHOPIFY", "status": "shipped" }
  }
}

Verify the signature

Every request carries X-Inboxy-Timestamp and X-Inboxy-Signature = sha256=HMAC_SHA256(secret, "timestamp.body"). Get the secret from GET /webhooks/:id/secret.

import crypto from 'node:crypto';

// Use the raw request body — not a re-serialized object.
export function isFromInboxy(rawBody, headers, secret) {
  const timestamp = headers['x-inboxy-timestamp'];
  const received = headers['x-inboxy-signature'] || '';
  if (Math.abs(Date.now() / 1000 - Number(timestamp)) > 300) return false; // 5-minute window
  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(`${timestamp}.${rawBody}`)
    .digest('hex');
  return received.length === expected.length &&
    crypto.timingSafeEqual(Buffer.from(received), Buffer.from(expected));
}

Events (77)

message.*
`message.received`	When a new message is received
`message.sent`	When a message is sent
`message.status_updated`	When an outbound message is delivered, read or fails
contact.*
`contact.created`	When a new contact is created
`contact.updated`	When a contact is updated
conversation.*
`conversation.opened`	When a conversation is opened
`conversation.closed`	When a conversation is closed/resolved
`conversation.assigned`	When a conversation is assigned to an agent
`conversation.created`	A new conversation starts on any channel
`conversation.resolved`	A conversation is resolved or closed (by an agent, AI or automation)
order.*
`order.created`	When an order is created
`order.updated`	When an order status changes
`order.completed`	When an order is completed
`order.cancelled`	When an order is cancelled
campaign.*
`campaign.started`	When a campaign starts running
`campaign.completed`	When a campaign finishes
agent.*
`agent.response`	When an AI agent responds
whatsapp.*
`whatsapp.message.received`	WhatsApp: a text message arrives
`whatsapp.media.received`	WhatsApp: an image, video, audio, document or sticker arrives
`whatsapp.voice.received`	WhatsApp: a voice note arrives
`whatsapp.location.received`	WhatsApp: the customer shares a location
`whatsapp.contact_card.received`	WhatsApp: the customer shares a contact card
`whatsapp.reaction.received`	WhatsApp: the customer reacts to a message
`whatsapp.button.clicked`	WhatsApp: the customer taps a reply button
`whatsapp.list.selected`	WhatsApp: the customer picks a list row
`whatsapp.template.reply`	WhatsApp: the customer taps a template quick-reply button
`whatsapp.flow.completed`	WhatsApp: the customer submits a WhatsApp Flow
`whatsapp.order.placed`	WhatsApp: the customer sends a cart from the catalog
`whatsapp.referral.received`	WhatsApp: a conversation starts from a click-to-WhatsApp ad
`whatsapp.message.status_changed`	WhatsApp: an outbound message is sent, delivered, read or fails
instagram.*
`instagram.message.received`	Instagram: a DM arrives
`instagram.media.received`	Instagram: a DM with media arrives
`instagram.reaction.received`	Instagram: the customer reacts to a message
`instagram.button.clicked`	Instagram: the customer taps a button or quick reply
`instagram.story.reply`	Instagram: the customer replies to your story
`instagram.story.mention`	Instagram: the customer mentions you in their story
`instagram.referral.received`	Instagram: a conversation starts from an ad or link
`instagram.first.inbound`	Instagram: a customer's first message ever
messenger.*
`messenger.message.received`	Messenger: a message arrives
`messenger.media.received`	Messenger: a message with media arrives
`messenger.voice.received`	Messenger: a voice message arrives
`messenger.location.received`	Messenger: the customer shares a location
`messenger.reaction.received`	Messenger: the customer reacts to a message
`messenger.button.clicked`	Messenger: the customer taps a button or quick reply
`messenger.template.reply`	Messenger: the customer answers a template
`messenger.referral.received`	Messenger: a conversation starts from an ad or m.me link
`messenger.first.inbound`	Messenger: a customer's first message ever
telegram.*
`telegram.message.received`	Telegram: a message arrives
`telegram.media.received`	Telegram: a message with media arrives
`telegram.location.received`	Telegram: the customer shares a location
`telegram.command.received`	Telegram: the customer sends a /command
`telegram.button.clicked`	Telegram: the customer taps an inline button
`telegram.first.inbound`	Telegram: a customer's first message ever
widget.*
`widget.chat.opened`	Website chat: a visitor opens the chat
`widget.message.received`	Website chat: a visitor sends a message
`widget.media.received`	Website chat: a visitor sends a file
`widget.button.clicked`	Website chat: a visitor taps a button
`widget.form.submitted`	Website chat: a visitor submits a form
`widget.first.inbound`	Website chat: a visitor's first message ever
lead.*
`lead.created`	A lead is created
ticket.*
`ticket.created`	A support ticket is created
`ticket.assigned`	A ticket is assigned
`ticket.status_changed`	A ticket changes status
task.*
`task.created`	A task is created
`task.assigned`	A task is assigned
`task.completed`	A task is completed
web_event.*
`web_event.received`	Your website sends a tracked event (web events API)
ecommerce.*
`ecommerce.order.created`	Store: a new order is placed
`ecommerce.order.confirmed`	Store: an order is confirmed
`ecommerce.order.paid`	Store: an order is paid
`ecommerce.order.shipped`	Store: an order ships
`ecommerce.order.delivered`	Store: an order is delivered
`ecommerce.order.cancelled`	Store: an order is cancelled
`ecommerce.order.refunded`	Store: an order is refunded
`ecommerce.order.status_changed`	Store: any other order status change
`ecommerce.cart.abandoned`	Store: a cart is abandoned
`ecommerce.customer.created`	Store: a new customer registers

Contacts

GET/api/v1/contactscontacts:read

List contacts

Requires contacts:read permission.

Query parameters

`search`	`string`	Name, phone or email.
`tagIds`	`string`	Comma-separated tag ids.
`hasPhone`	`boolean`
`hasEmail`	`boolean`
`hasOrders`	`boolean`
`channelType`	`string`	Channel the contact came from.
`source`	`string`	Comma-separated sources (MANUAL, WHATSAPP, SHOPIFY, …).
`status`	`string`	Comma-separated: ACTIVE, INACTIVE, ARCHIVED.
`label`	`string`	Comma-separated: HOT_LEAD, WARM_LEAD, COLD_LEAD, FOLLOW_UP, VIP, CHURNED, DO_NOT_CONTACT.
`lifecycleStage`	`string`	Comma-separated: LEAD, SUBSCRIBER, OPPORTUNITY, CUSTOMER, REPEAT_CUSTOMER, EVANGELIST.
`assignedAgentId`	`string`
`minTotalSpent`	`number`
`maxTotalSpent`	`number`
`lastInteractionAfter`	`string`	ISO date-time.
`lastInteractionBefore`	`string`	ISO date-time.
`createdAfter`	`string`	ISO date-time.
`createdBefore`	`string`	ISO date-time.
`page`	`integer`	Page number (default 1).
`limit`	`integer`	Page size.
`sortBy`	`name \| createdAt \| updatedAt`
`sortOrder`	`asc \| desc`	Sort direction.

curl -X GET "https://api.inboxy.chat/api/v1/contacts" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/contactscontacts:write

Create a contact

Requires contacts:write permission.

Body

`name`required	`string`	Contact display name.
`firstName`	`string`	First name.
`lastName`	`string`	Last name.
`phone`	`string`	Phone number, digits only (no leading +).
`email`	`string`	Email address.
`avatar`	`string`	Avatar image URL.
`externalId`	`string`	ID of this contact in an external system.
`customFields`	`object`	Arbitrary key/value custom fields.
`tagIds`	`string[]`	Tag IDs to attach to the contact.

curl -X POST "https://api.inboxy.chat/api/v1/contacts" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Ahmed Al-Otaibi",
  "firstName": "firstName",
  "lastName": "lastName",
  "phone": "966500000000",
  "email": "ahmed@example.com",
  "avatar": "avatar",
  "externalId": "externalId",
  "customFields": {},
  "tagIds": [
    "tagIds"
  ]
}'

GET/api/v1/contacts/searchcontacts:read

Search contacts

Requires contacts:read permission.

Query parameters

`q`required	`string`	Name, phone or email to search for.
`limit`	`integer`	Max results (default 10).

curl -X GET "https://api.inboxy.chat/api/v1/contacts/search" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/contacts/find-or-createcontacts:write

Find a contact or create it

Requires contacts:write permission.

Body

`phone`required	`string`	Phone number to search for, or create if no contact matches.
`name`	`string`	Name to use if a new contact is created. Defaults to the phone number.

curl -X POST "https://api.inboxy.chat/api/v1/contacts/find-or-create" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "phone": "966500000000",
  "name": "Ahmed Al-Otaibi"
}'

GET/api/v1/contacts/custom-field-keyscontacts:read

List custom field keys

Requires contacts:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/contacts/custom-field-keys" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/contacts/{id}contacts:read

Get a contact

Requires contacts:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/contacts/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/contacts/{id}contacts:write

Update a contact

Requires contacts:write permission.

Path parameters

idrequired string

Body

`name`	`string`	Contact display name.
`firstName`	`string`	First name.
`lastName`	`string`	Last name.
`phone`	`string`	Phone number, digits only (no leading +).
`email`	`string`	Email address.
`avatar`	`string`	Avatar image URL.
`externalId`	`string`	ID of this contact in an external system.
`customFields`	`object`	Arbitrary key/value custom fields.
`tagIds`	`string[]`	Tag IDs to attach to the contact.
`label`	`HOT_LEAD \| WARM_LEAD \| COLD_LEAD \| FOLLOW_UP \| VIP \| CHURNED \| DO_NOT_CONTACT`	CDP label, or null to clear.
`status`	`ACTIVE \| INACTIVE \| ARCHIVED`	Contact status.
`lifecycleStage`	`LEAD \| SUBSCRIBER \| OPPORTUNITY \| CUSTOMER \| REPEAT_CUSTOMER \| EVANGELIST`	CDP lifecycle stage.
`assignedAgentId`	`string`	User ID of the assigned agent, or null to unassign.
`notes`	`string`	Free-text notes on the contact.

curl -X PUT "https://api.inboxy.chat/api/v1/contacts/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Ahmed Al-Otaibi",
  "firstName": "firstName",
  "lastName": "lastName",
  "phone": "966500000000",
  "email": "ahmed@example.com",
  "avatar": "avatar",
  "externalId": "externalId",
  "customFields": {},
  "tagIds": [
    "tagIds"
  ],
  "label": "HOT_LEAD",
  "status": "ACTIVE",
  "lifecycleStage": "LEAD",
  "assignedAgentId": "assignedAgentId",
  "notes": "notes"
}'

DELETE/api/v1/contacts/{id}contacts:write

Delete a contact

Requires contacts:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/contacts/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/contacts/{id}/tags/{tagId}contacts:write

Add a tag to a contact

Requires contacts:write permission.

Path parameters

`id`required	`string`
`tagId`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/contacts/{id}/tags/{tagId}" \
  -H "Authorization: Bearer inboxy_your_token"

DELETE/api/v1/contacts/{id}/tags/{tagId}contacts:write

Remove a tag from a contact

Requires contacts:write permission.

Path parameters

`id`required	`string`
`tagId`required	`string`

curl -X DELETE "https://api.inboxy.chat/api/v1/contacts/{id}/tags/{tagId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/contacts/tags/allcontacts:read

List tags

Requires contacts:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/contacts/tags/all" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/contacts/tagscontacts:write

Create a tag

Requires contacts:write permission.

Body

`name`required	`string`	Tag name, max 100 characters. Letters, numbers, spaces and - _ . , & ( ) # only.
`color`	`string`	Hex color for the tag.

curl -X POST "https://api.inboxy.chat/api/v1/contacts/tags" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "VIP",
  "color": "#3bc1a8"
}'

PUT/api/v1/contacts/tags/{tagId}contacts:write

Update a tag

Requires contacts:write permission.

Path parameters

tagIdrequired string

Body

`name`	`string`	Tag name.
`color`	`string`	Hex color for the tag.

curl -X PUT "https://api.inboxy.chat/api/v1/contacts/tags/{tagId}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "color": "color"
}'

DELETE/api/v1/contacts/tags/{tagId}contacts:write

Delete a tag

Requires contacts:write permission.

Path parameters

tagIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/contacts/tags/{tagId}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/contacts/{id}/statuscontacts:write

Set contact status

Requires contacts:write permission.

Path parameters

idrequired string

Body

statusrequired ACTIVE | INACTIVE | ARCHIVED New contact status.

curl -X PATCH "https://api.inboxy.chat/api/v1/contacts/{id}/status" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "ACTIVE"
}'

PATCH/api/v1/contacts/{id}/stagecontacts:write

Set contact lifecycle stage

Requires contacts:write permission.

Path parameters

idrequired string

Body

curl -X PATCH "https://api.inboxy.chat/api/v1/contacts/{id}/stage" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "lifecycleStage": "CUSTOMER"
}'

PATCH/api/v1/contacts/{id}/assigncontacts:write

Assign a contact to an agent

Requires contacts:write permission.

Path parameters

idrequired string

Body

agentId string User ID to assign the contact to, or null to unassign.

curl -X PATCH "https://api.inboxy.chat/api/v1/contacts/{id}/assign" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "agentId": "agentId"
}'

POST/api/v1/contacts/{id}/notecontacts:write

Add a note to a contact

Requires contacts:write permission.

Path parameters

idrequired string

Body

noterequired string Note text to append to the contact.

curl -X POST "https://api.inboxy.chat/api/v1/contacts/{id}/note" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "note": "note"
}'

GET/api/v1/contacts/{id}/timelinecontacts:read

Get a contact timeline

Requires contacts:read permission.

Path parameters

idrequired string

Query parameters

`limit`	`integer`
`offset`	`integer`	Rows to skip (default 0).
`types`	`string`	Comma-separated activity types, e.g. MESSAGE_SENT,TAG_ADDED.

curl -X GET "https://api.inboxy.chat/api/v1/contacts/{id}/timeline" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/contacts/bulk/tagscontacts:write

Tag many contacts

Requires contacts:write permission.

Body

`contactIds`required	`string[]`	Contact IDs to update.
`tagIds`required	`string[]`	Tag IDs to add or remove.
`action`required	`add \| remove`	Whether to add or remove the tags.

curl -X POST "https://api.inboxy.chat/api/v1/contacts/bulk/tags" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "contactIds": [
    "contactIds"
  ],
  "tagIds": [
    "tagIds"
  ],
  "action": "add"
}'

GET/api/v1/public/contactscontacts:read

List contacts

Get a paginated list of contacts. Requires contacts:read permission.

Query parameters

`page`	`integer`
`pageSize`	`integer`
`search`	`string`	Search by name, phone, or email
`tagIds`	`string`	Comma-separated tag IDs
`status`	`string`
`createdAfter`	`string`
`createdBefore`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/public/contacts" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/contacts/{id}contacts:read

Get contact by ID

Get a single contact with tags and conversation count. Requires contacts:read permission.

Path parameters

idrequired string Resource ID

curl -X GET "https://api.inboxy.chat/api/v1/public/contacts/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Messages

POST/api/v1/whatsapp/messages/catalog-cardmessages:send

Send an Inboxy product or service card

Requires messages:send permission.

Body

`conversationId`required	`string`	WhatsApp conversation to send into.
`itemType`required	`product \| service`
`itemId`required	`string`	Product or service id.
`language`required	`ar \| en`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/catalog-card" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationId": "conversationId",
  "itemType": "product",
  "itemId": "itemId",
  "language": "ar"
}'

POST/api/v1/whatsapp/media/uploadmessages:send

Upload media to WhatsApp and get a media id for sends

Requires messages:send permission.

Body

`mediaType`required	`image \| video \| audio \| document`
`mediaUrl`	`string`
`base64`	`string`
`filename`	`string`
`mimeType`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/media/upload" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "mediaType": "image",
  "mediaUrl": "mediaUrl",
  "base64": "base64",
  "filename": "filename",
  "mimeType": "mimeType"
}'

POST/api/v1/whatsapp/messages/textmessages:send

Send a WhatsApp text message

Requires messages:send permission.

Body

`to`required	`string`
`body`required	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/text" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "body": "body",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/templatemessages:send

Send an approved WhatsApp template

Requires messages:send permission.

Body

`to`required	`string`
`templateName`required	`string`
`languageCode`required	`string`
`components`	`string[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/template" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "templateName": "templateName",
  "languageCode": "languageCode",
  "components": [],
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/buttonsmessages:send

Send a WhatsApp reply-buttons message

Requires messages:send permission.

Body

`to`required	`string`
`body`required	`string`
`buttons`required	`object[]`
`header`	`string`
`headerImage`	`string`
`footer`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/buttons" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "body": "body",
  "buttons": [
    {
      "id": "id",
      "title": "title"
    }
  ],
  "header": "header",
  "headerImage": "headerImage",
  "footer": "footer",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/listmessages:send

Send a WhatsApp list message

Requires messages:send permission.

Body

`to`required	`string`
`body`required	`string`
`buttonText`required	`string`
`sections`required	`string[]`
`header`	`string`
`footer`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/list" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "body": "body",
  "buttonText": "buttonText",
  "sections": [],
  "header": "header",
  "footer": "footer",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/cta-urlmessages:send

Send a WhatsApp call-to-action URL button

Requires messages:send permission.

Body

`to`required	`string`
`body`required	`string`
`displayText`required	`string`
`url`required	`string`
`header`	`string`
`headerImage`	`string`
`footer`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/cta-url" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "body": "body",
  "displayText": "displayText",
  "url": "url",
  "header": "header",
  "headerImage": "headerImage",
  "footer": "footer",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/location-requestmessages:send

Ask the customer to share their location

Requires messages:send permission.

Body

`to`required	`string`
`body`required	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/location-request" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "body": "body",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/catalogmessages:send

Send the WhatsApp catalog

Requires messages:send permission.

Body

`to`required	`string`
`body`required	`string`
`footer`	`string`
`thumbnailProductRetailerId`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/catalog" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "body": "body",
  "footer": "footer",
  "thumbnailProductRetailerId": "thumbnailProductRetailerId",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/productmessages:send

Send one catalog product

Requires messages:send permission.

Body

`to`required	`string`
`catalogId`required	`string`
`productRetailerId`required	`string`
`body`	`string`
`footer`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/product" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "catalogId": "catalogId",
  "productRetailerId": "productRetailerId",
  "body": "body",
  "footer": "footer",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/product-listmessages:send

Send a multi-product message

Requires messages:send permission.

Body

`to`required	`string`
`header`required	`string`
`body`required	`string`
`catalogId`required	`string`
`sections`required	`object[]`
`footer`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/product-list" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "header": "header",
  "body": "body",
  "catalogId": "catalogId",
  "sections": [
    {
      "title": "title",
      "productRetailerIds": [
        "productRetailerIds"
      ]
    }
  ],
  "footer": "footer",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/mediamessages:send

Send WhatsApp media (image, video, audio, document)

Requires messages:send permission.

Body

`to`required	`string`
`mediaType`required	`image \| video \| audio \| document`
`mediaUrl`required	`string`
`caption`	`string`
`filename`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/media" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "mediaType": "image",
  "mediaUrl": "mediaUrl",
  "caption": "caption",
  "filename": "filename",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/locationmessages:send

Send a location pin

Requires messages:send permission.

Body

`to`required	`string`
`latitude`required	`number`
`longitude`required	`number`
`name`	`string`
`address`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/location" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "latitude": 1,
  "longitude": 1,
  "name": "name",
  "address": "address",
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/contactsmessages:send

Send contact cards

Requires messages:send permission.

Body

`to`required	`string`
`contacts`	`string[]`
`contact`	`object`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/contacts" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "contacts": [],
  "contact": {},
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/contactmessages:send

Send one contact card

Requires messages:send permission.

Body

`to`required	`string`
`contacts`	`string[]`
`contact`	`object`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/contact" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "contacts": [],
  "contact": {},
  "conversationId": "conversationId"
}'

POST/api/v1/whatsapp/messages/{messageId}/readmessages:send

Mark an inbound WhatsApp message as read

Requires messages:send permission.

Path parameters

messageIdrequired string

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/messages/{messageId}/read" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/inbox/conversations/{conversationId}/messagesmessages:send

Reply in a conversation on any channel

Requires messages:send permission.

Path parameters

conversationIdrequired string

Body

`content`	`string`	Message text. Required when type is "text"; optional caption for media types.
`type`	`text \| image \| video \| audio \| document`	Message type. Defaults to "text".
`fileData`	`string`	Base64-encoded file content. Required when type is image, video, audio or document.
`fileName`	`string`	Original file name for media messages.
`mimeType`	`string`	MIME type of the media file.

curl -X POST "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/messages" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "مرحباً، كيف يمكنني مساعدتك؟",
  "type": "text",
  "fileData": "fileData",
  "fileName": "invoice.pdf",
  "mimeType": "image/jpeg"
}'

POST/api/v1/interactive-messages/send-savedmessages:send

Send a saved interactive message into a conversation

Requires messages:send permission.

Body

`conversationId`required	`string`
`messageId`required	`string`	Id of a saved interactive message (GET /api/v1/interactive-messages).
`channel`required	`WHATSAPP \| INSTAGRAM \| MESSENGER \| WEB`

curl -X POST "https://api.inboxy.chat/api/v1/interactive-messages/send-saved" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationId": "conversationId",
  "messageId": "messageId",
  "channel": "WHATSAPP"
}'

GET/api/v1/public/conversations/{id}/messagesmessages:read

List messages in a conversation

Get paginated messages for a conversation in chronological order. Requires messages:read permission.

Path parameters

idrequired string Resource ID

Query parameters

`page`	`integer`
`pageSize`	`integer`
`before`	`string`	Fetch messages before this date (cursor pagination)

curl -X GET "https://api.inboxy.chat/api/v1/public/conversations/{id}/messages" \
  -H "Authorization: Bearer inboxy_your_token"

Templates

POST/api/v1/whatsapp/media/upload-for-templatetemplates:write

Upload a template header file and get its media handle

Requires templates:write permission.

Body

`mediaType`required	`image \| video \| document`
`mediaUrl`	`string`	Public URL to fetch. Send this or base64.
`base64`	`string`	File content, base64-encoded.
`filename`	`string`
`mimeType`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/media/upload-for-template" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "mediaType": "image",
  "mediaUrl": "https://cdn.example.com/banner.jpg",
  "base64": "base64",
  "filename": "banner.jpg",
  "mimeType": "image/jpeg"
}'

GET/api/v1/whatsapp/templatestemplates:read

List WhatsApp templates

Requires templates:read permission.

Query parameters

status PENDING | APPROVED | REJECTED | PAUSED | DISABLED

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/templates" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/whatsapp/templatestemplates:write

Create a WhatsApp template and submit it to Meta for review

Requires templates:write permission.

Body

`name`required	`string`	Lowercase letters, digits and underscores. Unique per language.
`category`required	`MARKETING \| UTILITY \| AUTHENTICATION`
`language`required	`string`	Meta language code.
`templateType`	`STANDARD \| CAROUSEL \| LIMITED_TIME_OFFER`
`headerType`	`NONE \| TEXT \| IMAGE \| VIDEO \| DOCUMENT`
`headerText`	`string`	TEXT headers: up to 60 characters, at most one {{1}}.
`headerExample`	`string`	TEXT headers: sample for {{1}}. IMAGE/VIDEO/DOCUMENT headers: the media handle from POST /api/v1/whatsapp/media/upload-for-template.
`headerMediaUrl`	`string`	Media headers: the public URL of the same file, stored so every send attaches it automatically.
`bodyText`required	`string`	Up to 1,024 characters. Variables are {{1}}, {{2}}, … in order.
`bodyExamples`	`string[]`	One sample value per body variable, in order. Meta reviews the template with these.
`footerText`	`string`	Up to 60 characters, no variables.
`buttons`	`object[]`	Up to 10 buttons.
`carouselCards`	`object[]`	CAROUSEL templates: 2–10 cards, each with a media header, body and buttons.
`ltoText`	`string`	LIMITED_TIME_OFFER: the offer headline.
`ltoExpiration`	`string`	LIMITED_TIME_OFFER: when the offer ends.
`ltoCouponCode`	`string`	LIMITED_TIME_OFFER: coupon shown on a copy-code button.
`authSecurityDisclaimer`	`boolean`	AUTHENTICATION: add "Do not share this code" (default true).
`authExpirationMinutes`	`number`	AUTHENTICATION: code lifetime shown to the customer.
`variableMapping`	`object`	Required when bodyText has variables: one entry per variable number, saying where the value comes from at send time. Types: `static` (value used as-is), `contact_field` (firstName, lastName, name, email, phone), `custom_field` (a contact custom-field key), `order_field` (last.order.total, last.order.product, last.order.status, last.order.date, last.order.shipping_address, last.order.tracking_number), `web_event_field` (a path in the triggering web event).

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/templates" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "order_shipped",
  "category": "UTILITY",
  "language": "ar",
  "templateType": "STANDARD",
  "headerType": "TEXT",
  "headerText": "Your order is on its way",
  "headerExample": "headerExample",
  "headerMediaUrl": "headerMediaUrl",
  "bodyText": "مرحباً {{1}}، طلبك رقم {{2}} في الطريق إليك.",
  "bodyExamples": [
    "سارة",
    "10234"
  ],
  "footerText": "Inboxy Store",
  "buttons": [
    {
      "type": "QUICK_REPLY",
      "text": "Track order",
      "url": "https://shop.example.com/orders/{{1}}",
      "urlExample": "urlExample",
      "phoneNumber": "+966500000000",
      "couponCode": "couponCode",
      "otpType": "COPY_CODE",
      "flowId": "flowId",
      "flowAction": "navigate"
    }
  ],
  "carouselCards": [
    {
      "headerMediaHandle": "headerMediaHandle",
      "headerMediaUrl": "headerMediaUrl",
      "headerFormat": "IMAGE",
      "bodyText": "bodyText",
      "bodyExamples": [
        "bodyExamples"
      ],
      "buttons": [
        {
          "type": "QUICK_REPLY",
          "text": "Track order",
          "url": "https://shop.example.com/orders/{{1}}",
          "urlExample": "urlExample",
          "phoneNumber": "+966500000000",
          "couponCode": "couponCode",
          "otpType": "COPY_CODE",
          "flowId": "flowId",
          "flowAction": "navigate"
        }
      ]
    }
  ],
  "ltoText": "ltoText",
  "ltoExpiration": "2026-01-01T00:00:00.000Z",
  "ltoCouponCode": "ltoCouponCode",
  "authSecurityDisclaimer": true,
  "authExpirationMinutes": 1,
  "variableMapping": {
    "1": {
      "type": "contact_field",
      "value": "firstName"
    },
    "2": {
      "type": "order_field",
      "value": "last.order.tracking_number"
    }
  }
}'

GET/api/v1/whatsapp/templates/{templateId}templates:read

Get a WhatsApp template

Requires templates:read permission.

Path parameters

templateIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/templates/{templateId}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/whatsapp/templates/{templateId}/mediatemplates:write

Attach the media every send of this template uses

Requires templates:write permission.

Path parameters

templateIdrequired string

Body

`headerMediaId`	`string`	Media id (from POST /api/v1/whatsapp/media/upload) to attach as the header on every send.
`carouselCards`	`object[]`

curl -X PATCH "https://api.inboxy.chat/api/v1/whatsapp/templates/{templateId}/media" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "headerMediaId": "headerMediaId",
  "carouselCards": [
    {
      "index": 1,
      "mediaId": "mediaId"
    }
  ]
}'

POST/api/v1/whatsapp/templates/synctemplates:write

Sync templates and their approval status from Meta

Requires templates:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/templates/sync" \
  -H "Authorization: Bearer inboxy_your_token"

DELETE/api/v1/whatsapp/templates/{templateName}templates:write

Delete a WhatsApp template (all languages) from Meta and Inboxy

Requires templates:write permission.

Path parameters

templateNamerequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/whatsapp/templates/{templateName}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/templates/{templateName}/usagetemplates:read

Delivery ledger for a template

Requires templates:read permission.

Path parameters

templateNamerequired string

Query parameters

language string One language variant of the template.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/templates/{templateName}/usage" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/whatsapp/templates/{templateName}/mappingtemplates:write

Change where template variables get their values

Requires templates:write permission.

Path parameters

templateNamerequired string

Body

variableMappingrequired object Same shape as variableMapping on create. Stored in Inboxy only; Meta is not called.

curl -X PATCH "https://api.inboxy.chat/api/v1/whatsapp/templates/{templateName}/mapping" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "variableMapping": {
    "1": {
      "type": "contact_field",
      "value": "firstName"
    }
  }
}'

WhatsApp analytics

GET/api/v1/whatsapp/statsanalytics:read

WhatsApp message and conversation totals

Requires analytics:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/summaryanalytics:read

WhatsApp analytics summary

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/summary" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/messagesanalytics:read

Message volume

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/messages" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/messages/trendsanalytics:read

Message trends

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/messages/trends" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/response-timesanalytics:read

Response times

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/response-times" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/templatesanalytics:read

Template performance

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.
`limit`	`integer`	Max templates (default 10).

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/templates" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/conversationsanalytics:read

Conversation metrics

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/conversations" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/agentsanalytics:read

Agent performance

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.
`limit`	`integer`	Max agents (default 10).

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/agents" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/analytics/channelsanalytics:read

Channel breakdown

Requires analytics:read permission.

Query parameters

`startDate`	`string`	ISO date; use with endDate for an explicit range.
`endDate`	`string`	ISO date; use with startDate.
`days`	`integer`	Trailing N-day range, ignored when startDate and endDate are given. No range = all time.

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/analytics/channels" \
  -H "Authorization: Bearer inboxy_your_token"

Campaigns

GET/api/v1/whatsapp/campaignscampaigns:read

List WhatsApp campaigns

Requires campaigns:read permission.

Query parameters

`status`	`DRAFT \| SCHEDULED \| RUNNING \| PAUSED \| COMPLETED \| CANCELLED \| FAILED`	Must be one of the listed values.
`search`	`string`	Campaign name.
`limit`	`integer`	Max rows (default 50).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/campaigns" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/whatsapp/campaignscampaigns:write

Create a campaign

Requires campaigns:write permission.

Body

`name`required	`string`
`templateId`required	`string`	An APPROVED template id (GET /api/v1/whatsapp/templates).
`audience`required	`object`	Who receives the campaign. `ALL`: every opted-in contact. `TAGS`: contacts with any of `tagIds`. `CONTACTS`: exactly `contactIds` (max 5,000). `IMPORT_BATCH`: the `batchId` returned by import-audience.
`templateComponents`	`object[]`	Meta template components; omit to use the template’s saved variable mapping.
`scheduledAt`	`string`	Omit to create a draft; run it with POST /campaigns/:id/run.
`messagesPerSecond`	`number`	1–20.
`messagesPerDay`	`number`	Daily cap; the send spreads across days.
`aiEnabled`	`boolean`	Let the AI agent answer replies to this campaign.

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Ramadan offer",
  "templateId": "templateId",
  "audience": {
    "type": "TAGS",
    "tagIds": [
      "tagIds"
    ],
    "contactIds": [
      "contactIds"
    ],
    "batchId": "batchId"
  },
  "templateComponents": [
    {}
  ],
  "scheduledAt": "2026-01-01T00:00:00.000Z",
  "messagesPerSecond": 10,
  "messagesPerDay": 1,
  "aiEnabled": true
}'

GET/api/v1/whatsapp/campaigns/{id}campaigns:read

Get a campaign

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/whatsapp/campaigns/{id}campaigns:write

Update a draft or scheduled campaign

Requires campaigns:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`templateId`	`string`
`audience`	`object`	Who receives the campaign. `ALL`: every opted-in contact. `TAGS`: contacts with any of `tagIds`. `CONTACTS`: exactly `contactIds` (max 5,000). `IMPORT_BATCH`: the `batchId` returned by import-audience.
`templateComponents`	`object[]`
`scheduledAt`	`string \| null`
`autoRetry`	`boolean`
`maxRetries`	`number`

curl -X PUT "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "templateId": "templateId",
  "audience": {
    "type": "TAGS",
    "tagIds": [
      "tagIds"
    ],
    "contactIds": [
      "contactIds"
    ],
    "batchId": "batchId"
  },
  "templateComponents": [
    {}
  ],
  "scheduledAt": "2026-01-01T00:00:00.000Z",
  "autoRetry": true,
  "maxRetries": 1
}'

DELETE/api/v1/whatsapp/campaigns/{id}campaigns:write

Delete a campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/whatsapp/campaigns/{id}/runcampaigns:write

Start sending a campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/run" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/whatsapp/campaigns/{id}/cancelcampaigns:write

Cancel a campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/cancel" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/whatsapp/campaigns/{id}/pausecampaigns:write

Pause a running campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/pause" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/whatsapp/campaigns/{id}/resumecampaigns:write

Resume a paused campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/resume" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/campaigns/{id}/recipientscampaigns:read

List campaign recipients

Requires campaigns:read permission.

Path parameters

idrequired string

Query parameters

`status`	`PENDING \| CLAIMED \| SKIPPED \| SENT \| DELIVERED \| READ \| FAILED \| REPLIED`	Must be one of the listed values.
`limit`	`integer`	Max rows (default 50).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/recipients" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/campaigns/{id}/detailscampaigns:read

Get campaign details and counts

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/details" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/whatsapp/campaigns/previewcampaigns:read

Preview audience size and cost without creating

Requires campaigns:read permission.

Body

`templateId`required	`string`
`audience`required	`object`	Who receives the campaign. `ALL`: every opted-in contact. `TAGS`: contacts with any of `tagIds`. `CONTACTS`: exactly `contactIds` (max 5,000). `IMPORT_BATCH`: the `batchId` returned by import-audience.

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns/preview" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "templateId": "templateId",
  "audience": {
    "type": "TAGS",
    "tagIds": [
      "tagIds"
    ],
    "contactIds": [
      "contactIds"
    ],
    "batchId": "batchId"
  }
}'

POST/api/v1/whatsapp/campaigns/import-audiencecampaigns:write

Import an audience (matches or creates contacts)

Requires campaigns:write permission.

Body

`data`required	`object[]`
`createMissing`	`boolean`	Create contacts that do not exist yet (default true).
`defaultCountryCode`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns/import-audience" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "data": [
    {
      "name": "Sara",
      "phone": "966500000000",
      "email": "customer@example.com",
      "tags": "tags"
    }
  ],
  "createMissing": true,
  "defaultCountryCode": "966"
}'

POST/api/v1/whatsapp/campaigns/{id}/retrycampaigns:write

Retry failed recipients

Requires campaigns:write permission.

Path parameters

idrequired string

Body

`recipientIds`	`string[]`
`failureCategories`	`string[]`

curl -X POST "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/retry" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientIds": [
    "recipientIds"
  ],
  "failureCategories": [
    "failureCategories"
  ]
}'

GET/api/v1/whatsapp/campaigns/{id}/analyticscampaigns:read

Get campaign link clicks

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/analytics" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/whatsapp/campaigns/{id}/timeseriescampaigns:read

Get deliveries over time

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/whatsapp/campaigns/{id}/timeseries" \
  -H "Authorization: Bearer inboxy_your_token"

Instagram

POST/api/v1/instagram/sendmessages:send

Send an Instagram DM

Requires messages:send permission.

Body

`to`required	`string`
`content`required	`string`
`conversationId`	`string`
`mediaType`	`image \| video \| audio \| file`
`mediaUrl`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/send" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "content": "content",
  "conversationId": "conversationId",
  "mediaType": "image",
  "mediaUrl": "mediaUrl"
}'

POST/api/v1/instagram/send/quick-repliesmessages:send

Send Instagram quick replies

Requires messages:send permission.

Body

`to`required	`string`
`text`required	`string`
`quickReplies`required	`object[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/send/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "text": "text",
  "quickReplies": [
    {
      "title": "title",
      "payload": "payload"
    }
  ],
  "conversationId": "conversationId"
}'

POST/api/v1/instagram/send/carouselmessages:send

Send an Instagram carousel

Requires messages:send permission.

Body

`to`required	`string`
`elements`required	`object[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/send/carousel" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "elements": [
    {
      "title": "title",
      "subtitle": "subtitle",
      "image_url": "image_url",
      "default_action": {
        "type": "type",
        "url": "url"
      },
      "buttons": []
    }
  ],
  "conversationId": "conversationId"
}'

POST/api/v1/instagram/send/buttonsmessages:send

Send an Instagram DM with buttons

Requires messages:send permission.

Body

`to`required	`string`
`text`required	`string`
`buttons`required	`object[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/send/buttons" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "text": "text",
  "buttons": [
    {
      "type": "type",
      "title": "title",
      "url": "url",
      "payload": "payload"
    }
  ],
  "conversationId": "conversationId"
}'

POST/api/v1/instagram/send/media-templatemessages:send

Send an Instagram media template

Requires messages:send permission.

Body

`to`required	`string`
`mediaType`required	`image \| video`
`mediaUrl`required	`string`
`buttons`	`string[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/send/media-template" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "to": "966500000000",
  "mediaType": "image",
  "mediaUrl": "mediaUrl",
  "buttons": [],
  "conversationId": "conversationId"
}'

GET/api/v1/instagram/conversations/{conversationId}/windowconversations:read

Check the Instagram messaging window

Requires conversations:read permission.

Path parameters

conversationIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/conversations/{conversationId}/window" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/statsanalytics:read

Instagram message totals

Requires analytics:read permission.

Query parameters

period today | 7days | month Reporting window (default month).

curl -X GET "https://api.inboxy.chat/api/v1/instagram/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/interactive-messageslibrary:read

List Instagram interactive messages

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/instagram/interactive-messages" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/interactive-messageslibrary:write

Save an Instagram interactive message

Requires library:write permission.

Body

`name`required	`string`
`type`required	`buttons \| quick_replies`
`config`required	`object`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/interactive-messages" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "type": "buttons",
  "config": {}
}'

GET/api/v1/instagram/interactive-messages/{id}library:read

Get an Instagram interactive message

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/instagram/interactive-messages/{id}library:write

Update an Instagram interactive message

Requires library:write permission.

Path parameters

idrequired string

Body

`name`required	`string`
`type`required	`buttons \| quick_replies`
`config`required	`object`

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "type": "buttons",
  "config": {}
}'

DELETE/api/v1/instagram/interactive-messages/{id}library:write

Delete an Instagram interactive message

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/rate-limitchannels:read

Remaining Instagram send quota

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/instagram/rate-limit" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/templatestemplates:read

List saved Instagram templates

Requires templates:read permission.

Query parameters

`page`	`integer`
`limit`	`integer`
`search`	`string`
`isActive`	`boolean`

curl -X GET "https://api.inboxy.chat/api/v1/instagram/templates" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/templatestemplates:write

Save an Instagram template

Requires templates:write permission.

Body

`name`required	`string`
`description`	`string`
`cards`required	`object[]`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/templates" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "cards": [
    {
      "title": "title",
      "subtitle": "subtitle",
      "imageUrl": "imageUrl",
      "defaultActionUrl": "defaultActionUrl",
      "buttons": [
        {
          "type": "web_url",
          "title": "title",
          "url": "url",
          "payload": "payload"
        }
      ]
    }
  ]
}'

GET/api/v1/instagram/templates/{id}templates:read

Get a saved Instagram template

Requires templates:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/instagram/templates/{id}templates:write

Update a saved Instagram template

Requires templates:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`description`	`string`
`isActive`	`boolean`
`cards`	`object[]`

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "isActive": true,
  "cards": [
    {
      "title": "title",
      "subtitle": "subtitle",
      "imageUrl": "imageUrl",
      "defaultActionUrl": "defaultActionUrl",
      "buttons": [
        {
          "type": "web_url",
          "title": "title",
          "url": "url",
          "payload": "payload"
        }
      ]
    }
  ]
}'

DELETE/api/v1/instagram/templates/{id}templates:write

Delete a saved Instagram template

Requires templates:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/templates/{id}/detailtemplates:read

Get template detail and usage

Requires templates:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/templates/{id}/detail" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/templates/{id}/sendmessages:send

Send a saved Instagram template

Requires messages:send permission.

Path parameters

idrequired string

Body

`recipientId`required	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/templates/{id}/send" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "conversationId": "conversationId"
}'

GET/api/v1/instagram/quick-replieslibrary:read

List Instagram quick replies

Requires library:read permission.

Query parameters

`page`	`integer`
`limit`	`integer`
`search`	`string`
`category`	`string`
`isActive`	`boolean`

curl -X GET "https://api.inboxy.chat/api/v1/instagram/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/quick-replieslibrary:write

Create an Instagram quick reply

Requires library:write permission.

Body

`name`required	`string`
`description`	`string`
`message`required	`string`
`quickReplies`required	`object[]`
`category`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "message": "message",
  "quickReplies": [
    {
      "title": "title",
      "payload": "payload",
      "imageUrl": "imageUrl"
    }
  ],
  "category": "category"
}'

GET/api/v1/instagram/quick-replies/categorieslibrary:read

List quick reply categories

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/instagram/quick-replies/categories" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/quick-replies/{id}library:read

Get an Instagram quick reply

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/instagram/quick-replies/{id}library:write

Update an Instagram quick reply

Requires library:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`description`	`string`
`message`	`string`
`quickReplies`	`object[]`
`category`	`string`
`isActive`	`boolean`

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "message": "message",
  "quickReplies": [
    {
      "title": "title",
      "payload": "payload",
      "imageUrl": "imageUrl"
    }
  ],
  "category": "category",
  "isActive": true
}'

DELETE/api/v1/instagram/quick-replies/{id}library:write

Delete an Instagram quick reply

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/ice-breakerschannels:read

List Instagram ice breakers

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/instagram/ice-breakers" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/ice-breakerschannels:write

Replace Instagram ice breakers

Requires channels:write permission.

Body

iceBreakersrequired object[]

curl -X POST "https://api.inboxy.chat/api/v1/instagram/ice-breakers" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "iceBreakers": [
    {
      "question": "question",
      "payload": "payload"
    }
  ]
}'

DELETE/api/v1/instagram/ice-breakerschannels:write

Remove all ice breakers

Requires channels:write permission.

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/ice-breakers" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/ice-breakers/addchannels:write

Add an ice breaker

Requires channels:write permission.

Body

`question`required	`string`
`payload`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/ice-breakers/add" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "question",
  "payload": "payload"
}'

PUT/api/v1/instagram/ice-breakers/{index}channels:write

Update an ice breaker

Requires channels:write permission.

Path parameters

indexrequired string

Body

`question`required	`string`
`payload`required	`string`

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/ice-breakers/{index}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "question",
  "payload": "payload"
}'

DELETE/api/v1/instagram/ice-breakers/{index}channels:write

Delete an ice breaker

Requires channels:write permission.

Path parameters

indexrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/ice-breakers/{index}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/ice-breakers/reorderchannels:write

Reorder ice breakers

Requires channels:write permission.

Body

newOrderrequired integer[]

curl -X POST "https://api.inboxy.chat/api/v1/instagram/ice-breakers/reorder" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "newOrder": [
    0
  ]
}'

GET/api/v1/instagram/story-mentions/configautomations:read

Story mention auto-reply settings

Requires automations:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/instagram/story-mentions/config" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/instagram/story-mentions/configautomations:write

Change story mention auto-reply settings

Requires automations:write permission.

Body

`enabled`	`boolean`
`autoReplyEnabled`	`boolean`
`autoReplyMessage`	`string`
`autoReplyDelay`	`integer`
`trackMentions`	`boolean`
`notifyOnMention`	`boolean`

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/story-mentions/config" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "autoReplyEnabled": true,
  "autoReplyMessage": "autoReplyMessage",
  "autoReplyDelay": 0,
  "trackMentions": true,
  "notifyOnMention": true
}'

GET/api/v1/instagram/story-mentions/statsanalytics:read

Story mention stats

Requires analytics:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/instagram/story-mentions/stats" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/story-mentions/responsesautomations:write

Add a story mention reply

Requires automations:write permission.

Body

`condition`required	`follower \| non_follower \| verified \| any`
`message`required	`string`
`isActive`	`boolean`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/story-mentions/responses" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "condition": "follower",
  "message": "message",
  "isActive": true
}'

PUT/api/v1/instagram/story-mentions/responses/{id}automations:write

Update a story mention reply

Requires automations:write permission.

Path parameters

idrequired string

Body

`condition`	`follower \| non_follower \| verified \| any`
`message`	`string`
`isActive`	`boolean`

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/story-mentions/responses/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "condition": "follower",
  "message": "message",
  "isActive": true
}'

DELETE/api/v1/instagram/story-mentions/responses/{id}automations:write

Delete a story mention reply

Requires automations:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/story-mentions/responses/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/campaignscampaigns:read

List Instagram campaigns

Requires campaigns:read permission.

Query parameters

`status`	`DRAFT \| SCHEDULED \| RUNNING \| PAUSED \| COMPLETED \| CANCELLED \| FAILED`
`search`	`string`
`limit`	`string`
`offset`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/instagram/campaigns" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/campaignscampaigns:write

Create an Instagram campaign

Requires campaigns:write permission.

Body

`name`required	`string`
`description`	`string`
`messageType`required	`TEXT \| TEMPLATE \| IMAGE`
`messageText`	`string`
`messageContent`	`string`
`templateId`	`string`
`imageUrl`	`string`
`messageConfig`	`object`
`scheduledAt`	`string`
`messagesPerSecond`	`number`
`recipientContactIds`	`string[]`
`recipientIds`	`string[]`
`recipientIGSIDs`	`string[]`
`filters`	`object`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/campaigns" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "messageType": "TEXT",
  "messageText": "messageText",
  "messageContent": "messageContent",
  "templateId": "templateId",
  "imageUrl": "imageUrl",
  "messageConfig": {},
  "scheduledAt": "2026-01-01T00:00:00.000Z",
  "messagesPerSecond": 1,
  "recipientContactIds": [
    "recipientContactIds"
  ],
  "recipientIds": [
    "recipientIds"
  ],
  "recipientIGSIDs": [
    "recipientIGSIDs"
  ],
  "filters": {
    "tags": [
      "tags"
    ],
    "lifecycleStage": "lifecycleStage",
    "source": "source"
  }
}'

GET/api/v1/instagram/campaigns/{id}campaigns:read

Get an Instagram campaign

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/instagram/campaigns/{id}campaigns:write

Update an Instagram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`description`	`string`
`messageType`	`TEXT \| TEMPLATE \| IMAGE`
`messageText`	`string`
`messageContent`	`string`
`templateId`	`string`
`imageUrl`	`string`
`messageConfig`	`object`
`scheduledAt`	`string`
`messagesPerSecond`	`number`

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "messageType": "TEXT",
  "messageText": "messageText",
  "messageContent": "messageContent",
  "templateId": "templateId",
  "imageUrl": "imageUrl",
  "messageConfig": {},
  "scheduledAt": "2026-01-01T00:00:00.000Z",
  "messagesPerSecond": 1
}'

DELETE/api/v1/instagram/campaigns/{id}campaigns:write

Delete an Instagram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/campaigns/{id}/runcampaigns:write

Start an Instagram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/run" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/campaigns/{id}/cancelcampaigns:write

Cancel an Instagram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/cancel" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/campaigns/{id}/pausecampaigns:write

Pause an Instagram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/pause" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/campaigns/{id}/resumecampaigns:write

Resume an Instagram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/resume" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/campaigns/{id}/statscampaigns:read

Campaign delivery stats

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/campaigns/{id}/recipientscampaigns:read

List campaign recipients

Requires campaigns:read permission.

Path parameters

idrequired string

Query parameters

`page`	`string`
`pageSize`	`string`
`status`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/recipients" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/campaigns/{id}/recipientscampaigns:write

Add campaign recipients

Requires campaigns:write permission.

Path parameters

idrequired string

Body

`contactIds`	`string[]`
`igsids`	`string[]`
`filters`	`object`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/recipients" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "contactIds": [
    "contactIds"
  ],
  "igsids": [
    "igsids"
  ],
  "filters": {
    "tags": [
      "tags"
    ],
    "lifecycleStage": "lifecycleStage",
    "source": "source"
  }
}'

POST/api/v1/instagram/campaigns/{id}/duplicatecampaigns:write

Duplicate an Instagram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/instagram/campaigns/{id}/duplicate" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/marketing/sendmessages:send

Send an Instagram marketing message to opted-in users

Requires messages:send permission.

Body

`recipientId`required	`string`
`tag`required	`string`
`text`	`string`
`attachment`	`object`

curl -X POST "https://api.inboxy.chat/api/v1/instagram/marketing/send" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "tag": "tag",
  "text": "text",
  "attachment": {
    "type": "type",
    "payload": {}
  }
}'

GET/api/v1/instagram/comment-automationsautomations:read

List comment-to-DM automations

Requires automations:read permission.

Query parameters

`page`	`integer`	Page number (default 1).
`limit`	`integer`	Rows per page, max 50 (default 20).

curl -X GET "https://api.inboxy.chat/api/v1/instagram/comment-automations" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/instagram/comment-automationsautomations:write

Auto-reply to comments on a post (public reply and/or DM)

Requires automations:write permission.

Body

`channelId`required	`string`	The Instagram or Messenger channel id (GET /api/v1/me/channels).
`mediaId`required	`string`	Post id from GET …/comment-automations/posts.
`postCaption`	`string`
`postThumbnail`	`string`
`postPermalink`	`string`
`keywords`	`string[]`	Reply only to comments containing one of these words; empty = every comment.
`publicReplies`	`string[]`	Public replies under the comment; one is picked at random.
`dmMessage`	`string`	Plain private reply (use dmConfig for rich DMs).
`dmConfig`	`object`	Private reply. `{type:"text", text}`, `{type:"image", imageUrl, text?}`, `{type:"card", title, subtitle?, imageUrl?, buttons?:[{title,url}] (max 3)}`, `{type:"buttons", text, buttons:[{title,url}] (1–3)}`, `{type:"quick_replies", text, quickReplies:[string] (1–13)}`.
`hideComment`	`boolean`	Hide the original comment after replying.

curl -X POST "https://api.inboxy.chat/api/v1/instagram/comment-automations" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "channelId": "channelId",
  "mediaId": "mediaId",
  "postCaption": "postCaption",
  "postThumbnail": "postThumbnail",
  "postPermalink": "postPermalink",
  "keywords": [
    "price",
    "السعر"
  ],
  "publicReplies": [
    "Sent you a DM 📩"
  ],
  "dmMessage": "dmMessage",
  "dmConfig": {
    "type": "buttons",
    "text": "Here is the price list",
    "buttons": [
      {
        "title": "Open",
        "url": "https://example.com/prices"
      }
    ]
  },
  "hideComment": true
}'

GET/api/v1/instagram/comment-automations/postschannels:read

List your Instagram posts

Requires channels:read permission.

Query parameters

after string Pagination cursor from the previous page of posts.

curl -X GET "https://api.inboxy.chat/api/v1/instagram/comment-automations/posts" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/comment-automations/posts/{mediaId}/commentschannels:read

List comments on an Instagram post

Requires channels:read permission.

Path parameters

mediaIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/comment-automations/posts/{mediaId}/comments" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/comment-automations/{id}automations:read

Get a comment-to-DM automation

Requires automations:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/instagram/comment-automations/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/instagram/comment-automations/{id}automations:write

Update a comment-to-DM automation

Requires automations:write permission.

Path parameters

idrequired string

Body

`channelId`required	`string`	The Instagram or Messenger channel id (GET /api/v1/me/channels).
`mediaId`required	`string`	Post id from GET …/comment-automations/posts.
`postCaption`	`string`
`postThumbnail`	`string`
`postPermalink`	`string`
`keywords`	`string[]`	Reply only to comments containing one of these words; empty = every comment.
`publicReplies`	`string[]`	Public replies under the comment; one is picked at random.
`dmMessage`	`string`	Plain private reply (use dmConfig for rich DMs).
`dmConfig`	`object`	Private reply. `{type:"text", text}`, `{type:"image", imageUrl, text?}`, `{type:"card", title, subtitle?, imageUrl?, buttons?:[{title,url}] (max 3)}`, `{type:"buttons", text, buttons:[{title,url}] (1–3)}`, `{type:"quick_replies", text, quickReplies:[string] (1–13)}`.
`hideComment`	`boolean`	Hide the original comment after replying.

curl -X PUT "https://api.inboxy.chat/api/v1/instagram/comment-automations/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "channelId": "channelId",
  "mediaId": "mediaId",
  "postCaption": "postCaption",
  "postThumbnail": "postThumbnail",
  "postPermalink": "postPermalink",
  "keywords": [
    "price",
    "السعر"
  ],
  "publicReplies": [
    "Sent you a DM 📩"
  ],
  "dmMessage": "dmMessage",
  "dmConfig": {
    "type": "buttons",
    "text": "Here is the price list",
    "buttons": [
      {
        "title": "Open",
        "url": "https://example.com/prices"
      }
    ]
  },
  "hideComment": true
}'

DELETE/api/v1/instagram/comment-automations/{id}automations:write

Delete a comment-to-DM automation

Requires automations:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/instagram/comment-automations/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/instagram/comment-automations/{id}/toggleautomations:write

Turn a comment-to-DM automation on or off

Requires automations:write permission.

Path parameters

idrequired string

curl -X PATCH "https://api.inboxy.chat/api/v1/instagram/comment-automations/{id}/toggle" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/top-performersanalytics:read

Top Instagram templates and replies

Requires analytics:read permission.

Query parameters

window string Lookback window as "<n>d", 1–90 days (default 7d).

curl -X GET "https://api.inboxy.chat/api/v1/instagram/top-performers" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/instagram/volume-timelineanalytics:read

Instagram message volume over time

Requires analytics:read permission.

Query parameters

window string Lookback window as "<n>d", 1–90 days (default 7d).

curl -X GET "https://api.inboxy.chat/api/v1/instagram/volume-timeline" \
  -H "Authorization: Bearer inboxy_your_token"

Messenger

POST/api/v1/messenger/sendmessages:send

Send a Messenger message

Requires messages:send permission.

Body

`recipientId`required	`string`
`text`required	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "text": "text",
  "conversationId": "conversationId"
}'

POST/api/v1/messenger/send/tagmessages:send

Send outside the 24-hour window with a message tag

Requires messages:send permission.

Body

`recipientId`required	`string`
`text`required	`string`
`tag`required	`HUMAN_AGENT`
`conversationId`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send/tag" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "text": "text",
  "tag": "HUMAN_AGENT",
  "conversationId": "conversationId"
}'

POST/api/v1/messenger/send/quick-repliesmessages:send

Send Messenger quick replies

Requires messages:send permission.

Body

`recipientId`required	`string`
`text`required	`string`
`quickReplies`required	`string[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "text": "text",
  "quickReplies": [],
  "conversationId": "conversationId"
}'

POST/api/v1/messenger/send/buttonsmessages:send

Send a Messenger button template

Requires messages:send permission.

Body

`recipientId`required	`string`
`text`required	`string`
`buttons`required	`string[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send/buttons" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "text": "text",
  "buttons": [],
  "conversationId": "conversationId"
}'

POST/api/v1/messenger/send/mediamessages:send

Send Messenger media

Requires messages:send permission.

Body

`recipientId`required	`string`
`mediaType`required	`image \| video \| audio \| file`
`mediaUrl`required	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send/media" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "mediaType": "image",
  "mediaUrl": "mediaUrl",
  "conversationId": "conversationId"
}'

POST/api/v1/messenger/send/carouselmessages:send

Send a Messenger carousel

Requires messages:send permission.

Body

`recipientId`required	`string`
`elements`required	`object[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send/carousel" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "elements": [
    {
      "title": "title",
      "subtitle": "subtitle",
      "image_url": "image_url",
      "default_action": {
        "type": "type",
        "url": "url"
      },
      "buttons": []
    }
  ],
  "conversationId": "conversationId"
}'

POST/api/v1/messenger/send/media-templatemessages:send

Send a Messenger media template

Requires messages:send permission.

Body

`recipientId`required	`string`
`mediaType`required	`image \| video`
`mediaUrl`required	`string`
`buttons`	`string[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send/media-template" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "mediaType": "image",
  "mediaUrl": "mediaUrl",
  "buttons": [],
  "conversationId": "conversationId"
}'

POST/api/v1/messenger/send/receiptmessages:send

Send a Messenger order receipt

Requires messages:send permission.

Body

`recipientId`required	`string`
`recipientName`required	`string`
`orderNumber`required	`string`
`currency`required	`string`
`paymentMethod`required	`string`
`orderUrl`	`string`
`timestamp`	`string`
`summary`required	`object`
`elements`required	`object[]`
`address`	`object`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/send/receipt" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "recipientName": "recipientName",
  "orderNumber": "orderNumber",
  "currency": "currency",
  "paymentMethod": "paymentMethod",
  "orderUrl": "orderUrl",
  "timestamp": "timestamp",
  "summary": {
    "subtotal": 1,
    "shipping_cost": 1,
    "total_tax": 1,
    "total_cost": 1
  },
  "elements": [
    {
      "title": "title",
      "subtitle": "subtitle",
      "quantity": 1,
      "price": 1,
      "currency": "currency",
      "image_url": "image_url"
    }
  ],
  "address": {
    "street_1": "street_1",
    "street_2": "street_2",
    "city": "city",
    "postal_code": "postal_code",
    "state": "state",
    "country": "country"
  },
  "conversationId": "conversationId"
}'

GET/api/v1/messenger/window/{conversationId}conversations:read

Check the Messenger messaging window

Requires conversations:read permission.

Path parameters

conversationIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/window/{conversationId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/statsanalytics:read

Messenger message totals

Requires analytics:read permission.

Query parameters

period today | 7days | month Reporting window (default month).

curl -X GET "https://api.inboxy.chat/api/v1/messenger/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/analytics/summaryanalytics:read

Messenger analytics summary

Requires analytics:read permission.

Query parameters

days integer Days to analyze, 1–365 (default 30).

curl -X GET "https://api.inboxy.chat/api/v1/messenger/analytics/summary" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/rate-limitchannels:read

Remaining Messenger send quota

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/rate-limit" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/interactive-messageslibrary:read

List Messenger interactive messages

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/interactive-messages" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/interactive-messageslibrary:write

Save a Messenger interactive message

Requires library:write permission.

Body

`name`required	`string`
`type`required	`buttons \| quick_replies`
`config`required	`object`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/interactive-messages" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "type": "buttons",
  "config": {}
}'

GET/api/v1/messenger/interactive-messages/{id}library:read

Get a Messenger interactive message

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/messenger/interactive-messages/{id}library:write

Update a Messenger interactive message

Requires library:write permission.

Path parameters

idrequired string

Body

`name`required	`string`
`type`required	`buttons \| quick_replies`
`config`required	`object`

curl -X PUT "https://api.inboxy.chat/api/v1/messenger/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "type": "buttons",
  "config": {}
}'

DELETE/api/v1/messenger/interactive-messages/{id}library:write

Delete a Messenger interactive message

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/templatestemplates:read

List saved Messenger templates

Requires templates:read permission.

Query parameters

`type`	`BUTTON \| GENERIC \| RECEIPT \| MEDIA`
`isActive`	`string`
`search`	`string`
`limit`	`string`
`offset`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/messenger/templates" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/templatestemplates:write

Save a Messenger template

Requires templates:write permission.

Body

`name`required	`string`
`description`	`string`
`type`required	`BUTTON \| GENERIC \| RECEIPT \| MEDIA`
`config`required	`object`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/templates" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "type": "BUTTON",
  "config": {}
}'

GET/api/v1/messenger/templates/{id}templates:read

Get a saved Messenger template

Requires templates:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/messenger/templates/{id}templates:write

Update a saved Messenger template

Requires templates:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`description`	`string`
`type`	`BUTTON \| GENERIC \| RECEIPT \| MEDIA`
`config`	`object`
`isActive`	`boolean`

curl -X PUT "https://api.inboxy.chat/api/v1/messenger/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "type": "BUTTON",
  "config": {},
  "isActive": true
}'

DELETE/api/v1/messenger/templates/{id}templates:write

Delete a saved Messenger template

Requires templates:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/templates/{id}/sendmessages:send

Send a saved Messenger template

Requires messages:send permission.

Path parameters

idrequired string

Body

`recipientId`required	`string`
`variables`	`object`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/templates/{id}/send" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "recipientId": "recipientId",
  "variables": {},
  "conversationId": "conversationId"
}'

GET/api/v1/messenger/templates/{id}/detailtemplates:read

Get template detail and usage

Requires templates:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/templates/{id}/detail" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/templates/{id}/duplicatetemplates:write

Duplicate a Messenger template

Requires templates:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/templates/{id}/duplicate" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/quick-replieslibrary:read

List Messenger quick replies

Requires library:read permission.

Query parameters

`category`	`string`
`isActive`	`string`
`search`	`string`
`limit`	`string`
`offset`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/messenger/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/quick-replieslibrary:write

Create a Messenger quick reply

Requires library:write permission.

Body

`name`required	`string`
`description`	`string`
`quickReplies`required	`object[]`
`category`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "title",
      "payload": "payload",
      "image_url": "image_url"
    }
  ],
  "category": "category"
}'

GET/api/v1/messenger/quick-replies/categorieslibrary:read

List quick reply categories

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/quick-replies/categories" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/quick-replies/{id}library:read

Get a Messenger quick reply

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/messenger/quick-replies/{id}library:write

Update a Messenger quick reply

Requires library:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`description`	`string`
`quickReplies`	`object[]`
`category`	`string`
`isActive`	`boolean`

curl -X PUT "https://api.inboxy.chat/api/v1/messenger/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "quickReplies": [
    {
      "content_type": "text",
      "title": "title",
      "payload": "payload",
      "image_url": "image_url"
    }
  ],
  "category": "category",
  "isActive": true
}'

DELETE/api/v1/messenger/quick-replies/{id}library:write

Delete a Messenger quick reply

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/quick-replies/{id}/duplicatelibrary:write

Duplicate a Messenger quick reply

Requires library:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/quick-replies/{id}/duplicate" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/profilechannels:read

Messenger profile (greeting, menu, ice breakers)

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/profile" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/profile/persistent-menuchannels:write

Set the persistent menu

Requires channels:write permission.

Body

`locale`	`string`
`composer_input_disabled`	`boolean`
`call_to_actions`	`object[]`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/profile/persistent-menu" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "locale": "locale",
  "composer_input_disabled": true,
  "call_to_actions": [
    {
      "id": "id",
      "type": "postback",
      "title": "title",
      "payload": "payload",
      "url": "url",
      "webview_height_ratio": "compact",
      "call_to_actions": []
    }
  ]
}'

GET/api/v1/messenger/profile/greetingchannels:read

Greeting text

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/profile/greeting" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/profile/greetingchannels:write

Set the greeting text

Requires channels:write permission.

Body

`getStartedPayload`	`string`
`greetings`	`object[]`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/profile/greeting" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "getStartedPayload": "getStartedPayload",
  "greetings": [
    {
      "locale": "locale",
      "text": "text"
    }
  ]
}'

DELETE/api/v1/messenger/profile/greetingchannels:write

Remove the greeting text

Requires channels:write permission.

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/profile/greeting" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/profile/get-startedchannels:read

Get Started button

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/profile/get-started" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/profile/get-startedchannels:write

Set the Get Started button

Requires channels:write permission.

Body

payloadrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/profile/get-started" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "payload": "payload"
}'

DELETE/api/v1/messenger/profile/get-startedchannels:write

Remove the Get Started button

Requires channels:write permission.

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/profile/get-started" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/profile/ice-breakerschannels:read

Ice breakers

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/profile/ice-breakers" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/profile/ice-breakerschannels:write

Set ice breakers

Requires channels:write permission.

Body

ice_breakers object[]

curl -X POST "https://api.inboxy.chat/api/v1/messenger/profile/ice-breakers" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "ice_breakers": [
    {
      "id": "id",
      "question": "question",
      "payload": "payload"
    }
  ]
}'

DELETE/api/v1/messenger/profile/ice-breakerschannels:write

Remove ice breakers

Requires channels:write permission.

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/profile/ice-breakers" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/campaignscampaigns:read

List Messenger campaigns

Requires campaigns:read permission.

Query parameters

`status`	`DRAFT \| SCHEDULED \| RUNNING \| PAUSED \| COMPLETED \| CANCELLED \| FAILED`
`search`	`string`
`limit`	`string`
`offset`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/messenger/campaigns" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/campaignscampaigns:write

Create a Messenger campaign

Requires campaigns:write permission.

Body

`name`required	`string`
`description`	`string`
`messageType`required	`TEXT \| TEMPLATE \| QUICK_REPLIES`
`messageText`	`string`
`templateId`	`string`
`quickReplySetId`	`string`
`messageConfig`	`object`
`scheduledAt`	`string`
`messagesPerSecond`	`number`
`recipientContactIds`	`string[]`
`recipientPSIDs`	`string[]`
`filters`	`object`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/campaigns" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "messageType": "TEXT",
  "messageText": "messageText",
  "templateId": "templateId",
  "quickReplySetId": "quickReplySetId",
  "messageConfig": {},
  "scheduledAt": "2026-01-01T00:00:00.000Z",
  "messagesPerSecond": 1,
  "recipientContactIds": [
    "recipientContactIds"
  ],
  "recipientPSIDs": [
    "recipientPSIDs"
  ],
  "filters": {
    "tags": [
      "tags"
    ],
    "lifecycleStage": "lifecycleStage",
    "source": "source"
  }
}'

GET/api/v1/messenger/campaigns/{id}campaigns:read

Get a Messenger campaign

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/messenger/campaigns/{id}campaigns:write

Update a Messenger campaign

Requires campaigns:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`description`	`string`
`messageType`	`TEXT \| TEMPLATE \| QUICK_REPLIES`
`messageText`	`string`
`templateId`	`string`
`quickReplySetId`	`string`
`messageConfig`	`object`
`scheduledAt`	`string`
`messagesPerSecond`	`number`
`messageTag`	`null`

curl -X PUT "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "messageType": "TEXT",
  "messageText": "messageText",
  "templateId": "templateId",
  "quickReplySetId": "quickReplySetId",
  "messageConfig": {},
  "scheduledAt": "2026-01-01T00:00:00.000Z",
  "messagesPerSecond": 1,
  "messageTag": null
}'

DELETE/api/v1/messenger/campaigns/{id}campaigns:write

Delete a Messenger campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/campaigns/{id}/runcampaigns:write

Start a Messenger campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/run" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/campaigns/{id}/cancelcampaigns:write

Cancel a Messenger campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/cancel" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/campaigns/{id}/pausecampaigns:write

Pause a Messenger campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/pause" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/campaigns/{id}/resumecampaigns:write

Resume a Messenger campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/resume" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/campaigns/{id}/statscampaigns:read

Campaign delivery stats

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/campaigns/{id}/recipientscampaigns:read

List campaign recipients

Requires campaigns:read permission.

Path parameters

idrequired string

Query parameters

`status`	`string`	Delivery status, e.g. SENT.
`limit`	`integer`	Max rows (default 20).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/recipients" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/campaigns/{id}/recipientscampaigns:write

Add campaign recipients

Requires campaigns:write permission.

Path parameters

idrequired string

Body

`contactIds`	`string[]`
`psids`	`string[]`
`filters`	`object`

curl -X POST "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/recipients" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "contactIds": [
    "contactIds"
  ],
  "psids": [
    "psids"
  ],
  "filters": {
    "tags": [
      "tags"
    ],
    "lifecycleStage": "lifecycleStage",
    "source": "source"
  }
}'

POST/api/v1/messenger/campaigns/{id}/duplicatecampaigns:write

Duplicate a Messenger campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/messenger/campaigns/{id}/duplicate" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/comment-automationsautomations:read

List comment-to-DM automations

Requires automations:read permission.

Query parameters

`page`	`integer`	Page number (default 1).
`limit`	`integer`	Rows per page, max 50 (default 20).

curl -X GET "https://api.inboxy.chat/api/v1/messenger/comment-automations" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/messenger/comment-automationsautomations:write

Auto-reply to comments on a Page post (public reply and/or DM)

Requires automations:write permission.

Body

`channelId`required	`string`	The Instagram or Messenger channel id (GET /api/v1/me/channels).
`mediaId`required	`string`	Post id from GET …/comment-automations/posts.
`postCaption`	`string`
`postThumbnail`	`string`
`postPermalink`	`string`
`keywords`	`string[]`	Reply only to comments containing one of these words; empty = every comment.
`publicReplies`	`string[]`	Public replies under the comment; one is picked at random.
`dmMessage`	`string`	Plain private reply (use dmConfig for rich DMs).
`dmConfig`	`object`	Private reply. `{type:"text", text}`, `{type:"image", imageUrl, text?}`, `{type:"card", title, subtitle?, imageUrl?, buttons?:[{title,url}] (max 3)}`, `{type:"buttons", text, buttons:[{title,url}] (1–3)}`, `{type:"quick_replies", text, quickReplies:[string] (1–13)}`.
`hideComment`	`boolean`	Hide the original comment after replying.

curl -X POST "https://api.inboxy.chat/api/v1/messenger/comment-automations" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "channelId": "channelId",
  "mediaId": "mediaId",
  "postCaption": "postCaption",
  "postThumbnail": "postThumbnail",
  "postPermalink": "postPermalink",
  "keywords": [
    "price",
    "السعر"
  ],
  "publicReplies": [
    "Sent you a DM 📩"
  ],
  "dmMessage": "dmMessage",
  "dmConfig": {
    "type": "buttons",
    "text": "Here is the price list",
    "buttons": [
      {
        "title": "Open",
        "url": "https://example.com/prices"
      }
    ]
  },
  "hideComment": true
}'

GET/api/v1/messenger/comment-automations/postschannels:read

List your Facebook Page posts

Requires channels:read permission.

Query parameters

after string Pagination cursor from the previous page of posts.

curl -X GET "https://api.inboxy.chat/api/v1/messenger/comment-automations/posts" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/comment-automations/posts/{mediaId}/commentschannels:read

List comments on a Page post

Requires channels:read permission.

Path parameters

mediaIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/comment-automations/posts/{mediaId}/comments" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/comment-automations/{id}automations:read

Get a comment-to-DM automation

Requires automations:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/messenger/comment-automations/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/messenger/comment-automations/{id}automations:write

Update a comment-to-DM automation

Requires automations:write permission.

Path parameters

idrequired string

Body

`channelId`required	`string`	The Instagram or Messenger channel id (GET /api/v1/me/channels).
`mediaId`required	`string`	Post id from GET …/comment-automations/posts.
`postCaption`	`string`
`postThumbnail`	`string`
`postPermalink`	`string`
`keywords`	`string[]`	Reply only to comments containing one of these words; empty = every comment.
`publicReplies`	`string[]`	Public replies under the comment; one is picked at random.
`dmMessage`	`string`	Plain private reply (use dmConfig for rich DMs).
`dmConfig`	`object`	Private reply. `{type:"text", text}`, `{type:"image", imageUrl, text?}`, `{type:"card", title, subtitle?, imageUrl?, buttons?:[{title,url}] (max 3)}`, `{type:"buttons", text, buttons:[{title,url}] (1–3)}`, `{type:"quick_replies", text, quickReplies:[string] (1–13)}`.
`hideComment`	`boolean`	Hide the original comment after replying.

curl -X PUT "https://api.inboxy.chat/api/v1/messenger/comment-automations/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "channelId": "channelId",
  "mediaId": "mediaId",
  "postCaption": "postCaption",
  "postThumbnail": "postThumbnail",
  "postPermalink": "postPermalink",
  "keywords": [
    "price",
    "السعر"
  ],
  "publicReplies": [
    "Sent you a DM 📩"
  ],
  "dmMessage": "dmMessage",
  "dmConfig": {
    "type": "buttons",
    "text": "Here is the price list",
    "buttons": [
      {
        "title": "Open",
        "url": "https://example.com/prices"
      }
    ]
  },
  "hideComment": true
}'

DELETE/api/v1/messenger/comment-automations/{id}automations:write

Delete a comment-to-DM automation

Requires automations:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/messenger/comment-automations/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/messenger/comment-automations/{id}/toggleautomations:write

Turn a comment-to-DM automation on or off

Requires automations:write permission.

Path parameters

idrequired string

curl -X PATCH "https://api.inboxy.chat/api/v1/messenger/comment-automations/{id}/toggle" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/top-performersanalytics:read

Top Messenger templates and replies

Requires analytics:read permission.

Query parameters

window string Lookback window as "<n>d", 1–90 days (default 7d).

curl -X GET "https://api.inboxy.chat/api/v1/messenger/top-performers" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/messenger/volume-timelineanalytics:read

Messenger message volume over time

Requires analytics:read permission.

Query parameters

window string Lookback window as "<n>d", 1–90 days (default 7d).

curl -X GET "https://api.inboxy.chat/api/v1/messenger/volume-timeline" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/sendmessages:send

Send a Telegram message

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`content`	`string`
`conversationId`	`string`
`mediaType`	`photo \| video \| document \| audio \| voice`
`mediaUrl`	`string`
`caption`	`string`
`parseMode`	`HTML \| Markdown \| MarkdownV2`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "content": "content",
  "conversationId": "conversationId",
  "mediaType": "photo",
  "mediaUrl": "mediaUrl",
  "caption": "caption",
  "parseMode": "HTML"
}'

POST/api/v1/telegram/send/inline-keyboardmessages:send

Send a message with inline buttons

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`text`required	`string`
`buttons`	`object[][]`
`inlineKeyboard`	`object[][]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/inline-keyboard" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "text": "text",
  "buttons": [
    [
      {
        "text": "text",
        "url": "url",
        "callback_data": "callback_data"
      }
    ]
  ],
  "inlineKeyboard": [
    [
      {
        "text": "text",
        "url": "url",
        "callback_data": "callback_data"
      }
    ]
  ],
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/reply-keyboardmessages:send

Send a message with a reply keyboard

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`text`required	`string`
`keyboard`required	`object[][]`
`conversationId`	`string`
`resize_keyboard`	`boolean`
`one_time_keyboard`	`boolean`
`input_field_placeholder`	`string`
`is_persistent`	`boolean`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/reply-keyboard" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "text": "text",
  "keyboard": [
    [
      {
        "text": "text",
        "request_contact": true,
        "request_location": true
      }
    ]
  ],
  "conversationId": "conversationId",
  "resize_keyboard": true,
  "one_time_keyboard": true,
  "input_field_placeholder": "input_field_placeholder",
  "is_persistent": true
}'

POST/api/v1/telegram/send/remove-keyboardmessages:send

Remove the reply keyboard

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`text`required	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/remove-keyboard" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "text": "text",
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/stickermessages:send

Send a sticker

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`sticker`required	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/sticker" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "sticker": "sticker",
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/locationmessages:send

Send a location

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`latitude`required	`number`
`longitude`required	`number`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/location" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "latitude": 1,
  "longitude": 1,
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/contactmessages:send

Send a contact

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`phoneNumber`required	`string`
`firstName`required	`string`
`lastName`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/contact" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "phoneNumber": "966500000000",
  "firstName": "firstName",
  "lastName": "lastName",
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/pollmessages:send

Send a poll

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`question`required	`string`
`options`required	`object[]`
`conversationId`	`string`
`is_anonymous`	`boolean`
`isAnonymous`	`boolean`
`type`	`regular \| quiz`
`allows_multiple_answers`	`boolean`
`allowsMultipleAnswers`	`boolean`
`correct_option_id`	`number`
`correctOptionId`	`number`
`explanation`	`string`
`open_period`	`number`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/poll" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "question": "question",
  "options": [
    "options"
  ],
  "conversationId": "conversationId",
  "is_anonymous": true,
  "isAnonymous": true,
  "type": "regular",
  "allows_multiple_answers": true,
  "allowsMultipleAnswers": true,
  "correct_option_id": 1,
  "correctOptionId": 1,
  "explanation": "explanation",
  "open_period": 1
}'

POST/api/v1/telegram/send/venuemessages:send

Send a venue

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`latitude`required	`number`
`longitude`required	`number`
`title`required	`string`
`address`required	`string`
`foursquareId`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/venue" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "latitude": 1,
  "longitude": 1,
  "title": "title",
  "address": "address",
  "foursquareId": "foursquareId",
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/dicemessages:send

Send an animated dice

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`emoji`	`🎲 \| 🎯 \| 🏀 \| ⚽ \| 🎳 \| 🎰`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/dice" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "emoji": "🎲",
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/animationmessages:send

Send a GIF / animation

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`animation`required	`string`
`caption`	`string`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/animation" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "animation": "animation",
  "caption": "caption",
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/video-notemessages:send

Send a round video note

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`videoNote`required	`string`
`duration`	`number`
`length`	`number`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/video-note" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "videoNote": "videoNote",
  "duration": 1,
  "length": 1,
  "conversationId": "conversationId"
}'

POST/api/v1/telegram/send/invoicemessages:send

Send an invoice

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`title`required	`string`
`description`required	`string`
`payload`required	`string`
`currency`required	`string`
`prices`required	`object[]`
`providerToken`	`string`
`startParameter`	`string`
`photoUrl`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/invoice" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "title": "title",
  "description": "description",
  "payload": "payload",
  "currency": "XTR",
  "prices": [
    {
      "label": "label",
      "amount": 1
    }
  ],
  "providerToken": "providerToken",
  "startParameter": "startParameter",
  "photoUrl": "photoUrl"
}'

POST/api/v1/telegram/create-invoice-linkmessages:send

Create a payment link

Requires messages:send permission.

Body

`title`required	`string`
`description`required	`string`
`payload`required	`string`
`currency`required	`string`
`prices`required	`object[]`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/create-invoice-link" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "title",
  "description": "description",
  "payload": "payload",
  "currency": "XTR",
  "prices": [
    {
      "label": "label",
      "amount": 1
    }
  ]
}'

POST/api/v1/telegram/forwardmessages:send

Forward a message

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`fromChatId`required	`string \| number`
`messageId`required	`number`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/forward" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "fromChatId": "fromChatId",
  "messageId": 1
}'

POST/api/v1/telegram/copymessages:send

Copy a message to another chat

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`fromChatId`required	`string \| number`
`messageId`required	`number`
`caption`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/copy" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "fromChatId": "fromChatId",
  "messageId": 1,
  "caption": "caption"
}'

PUT/api/v1/telegram/messagemessages:send

Edit a sent message

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`messageId`required	`number`
`text`required	`string`

curl -X PUT "https://api.inboxy.chat/api/v1/telegram/message" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "messageId": 1,
  "text": "text"
}'

DELETE/api/v1/telegram/messagemessages:send

Delete a message

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`messageId`required	`number`

curl -X DELETE "https://api.inboxy.chat/api/v1/telegram/message" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "messageId": 1
}'

POST/api/v1/telegram/send/media-groupmessages:send

Send an album

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`media`required	`object[]`
`conversationId`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/send/media-group" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "media": [
    {
      "type": "photo",
      "media": "media",
      "caption": "caption"
    }
  ],
  "conversationId": "conversationId"
}'

GET/api/v1/telegram/chat/{chatId}conversations:read

Get chat info

Requires conversations:read permission.

Path parameters

chatIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/telegram/chat/{chatId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/telegram/chat/{chatId}/member-countconversations:read

Get group member count

Requires conversations:read permission.

Path parameters

chatIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/telegram/chat/{chatId}/member-count" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/chat/banchannels:write

Ban a user from a group

Requires channels:write permission.

Body

`chatId`required	`string \| number`
`userId`required	`number`
`untilDate`	`number`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/chat/ban" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "userId": 1,
  "untilDate": 1
}'

POST/api/v1/telegram/chat/unbanchannels:write

Unban a user

Requires channels:write permission.

Body

`chatId`required	`string \| number`
`userId`required	`number`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/chat/unban" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "userId": 1
}'

POST/api/v1/telegram/message/pinmessages:send

Pin a message

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`messageId`required	`number`
`disableNotification`	`boolean`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/message/pin" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "messageId": 1,
  "disableNotification": true
}'

POST/api/v1/telegram/message/unpinmessages:send

Unpin a message

Requires messages:send permission.

Body

`chatId`required	`string \| number`
`messageId`	`number`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/message/unpin" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "messageId": 1
}'

POST/api/v1/telegram/chat/invite-linkchannels:write

Create a group invite link

Requires channels:write permission.

Body

`chatId`required	`string \| number`
`name`	`string`
`expireDate`	`number`
`memberLimit`	`number`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/chat/invite-link" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "chatId": "chatId",
  "name": "name",
  "expireDate": 1,
  "memberLimit": 1
}'

GET/api/v1/telegram/bot/profilechannels:read

Bot name, description and about text

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/telegram/bot/profile" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/telegram/bot/profilechannels:write

Change the bot name, description and about text

Requires channels:write permission.

Body

`name`	`string`
`description`	`string`
`shortDescription`	`string`

curl -X PUT "https://api.inboxy.chat/api/v1/telegram/bot/profile" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "shortDescription": "shortDescription"
}'

GET/api/v1/telegram/commandschannels:read

List bot commands

Requires channels:read permission.

Query parameters

languageCode string Command set for this language (omit for the default).

curl -X GET "https://api.inboxy.chat/api/v1/telegram/commands" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/commandschannels:write

Set bot commands

Requires channels:write permission.

Body

`commands`required	`object[]`
`languageCode`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/commands" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "commands": [
    {
      "command": "command",
      "description": "description"
    }
  ],
  "languageCode": "languageCode"
}'

DELETE/api/v1/telegram/commandschannels:write

Remove bot commands

Requires channels:write permission.

curl -X DELETE "https://api.inboxy.chat/api/v1/telegram/commands" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/telegram/statsanalytics:read

Telegram message totals

Requires analytics:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/telegram/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/telegram/campaignscampaigns:read

List Telegram campaigns

Requires campaigns:read permission.

Query parameters

curl -X GET "https://api.inboxy.chat/api/v1/telegram/campaigns" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/campaignscampaigns:write

Create a Telegram campaign

Requires campaigns:write permission.

Body

`name`required	`string`
`messageType`	`string`	TEXT by default.
`messageContent`	`string`	Message text (when not using a template).
`templateId`	`string`	A Telegram template id instead of messageContent.
`recipientIds`	`string[]`	Contact ids; contacts without a Telegram chat are skipped.
`scheduledAt`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/telegram/campaigns" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "New arrivals",
  "messageType": "TEXT",
  "messageContent": "messageContent",
  "templateId": "templateId",
  "recipientIds": [
    "recipientIds"
  ],
  "scheduledAt": "2026-01-01T00:00:00.000Z"
}'

GET/api/v1/telegram/campaigns/{id}campaigns:read

Get a Telegram campaign

Requires campaigns:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/telegram/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

DELETE/api/v1/telegram/campaigns/{id}campaigns:write

Delete a Telegram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/telegram/campaigns/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/campaigns/{id}/sendcampaigns:write

Start a Telegram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/telegram/campaigns/{id}/send" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/campaigns/{id}/cancelcampaigns:write

Cancel a Telegram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/telegram/campaigns/{id}/cancel" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/campaigns/{id}/pausecampaigns:write

Pause a Telegram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/telegram/campaigns/{id}/pause" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/campaigns/{id}/resumecampaigns:write

Resume a Telegram campaign

Requires campaigns:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/telegram/campaigns/{id}/resume" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/telegram/templatestemplates:read

List Telegram templates

Requires templates:read permission.

Query parameters

`isActive`	`true \| false`
`type`	`TEXT \| MEDIA \| BUTTONS \| POLL \| RICH`
`search`	`string`	Name or content.
`page`	`integer`	Page number (default 1).
`pageSize`	`integer`

curl -X GET "https://api.inboxy.chat/api/v1/telegram/templates" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/templatestemplates:write

Save a Telegram template

Requires templates:write permission.

Body

`name`required	`string`
`type`	`TEXT \| MEDIA \| BUTTONS \| POLL \| RICH`
`content`required	`string`
`config`	`object`	Type-specific settings (media, inline buttons, poll options).
`description`	`string \| null`
`clientId`	`string \| null`	Your idempotency id: sending the same clientId again returns the existing template.

curl -X POST "https://api.inboxy.chat/api/v1/telegram/templates" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Welcome",
  "type": "TEXT",
  "content": "Welcome to our store 👋",
  "config": {},
  "description": "description",
  "clientId": "clientId"
}'

GET/api/v1/telegram/templates/{id}templates:read

Get a Telegram template

Requires templates:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/telegram/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/telegram/templates/{id}templates:write

Update a Telegram template

Requires templates:write permission.

Path parameters

idrequired string

Body

`name`required	`string`
`type`	`TEXT \| MEDIA \| BUTTONS \| POLL \| RICH`
`content`required	`string`
`config`	`object`	Type-specific settings (media, inline buttons, poll options).
`description`	`string \| null`
`clientId`	`string \| null`	Your idempotency id: sending the same clientId again returns the existing template.

curl -X PUT "https://api.inboxy.chat/api/v1/telegram/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Welcome",
  "type": "TEXT",
  "content": "Welcome to our store 👋",
  "config": {},
  "description": "description",
  "clientId": "clientId"
}'

DELETE/api/v1/telegram/templates/{id}templates:write

Delete a Telegram template

Requires templates:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/telegram/templates/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/templates/{id}/duplicatetemplates:write

Duplicate a Telegram template

Requires templates:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/telegram/templates/{id}/duplicate" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/telegram/templates/{id}/usemessages:send

Record a Telegram template use

Requires messages:send permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/telegram/templates/{id}/use" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/telegram/top-performersanalytics:read

Top Telegram templates

Requires analytics:read permission.

Query parameters

window string Lookback window as "<n>d", 1–90 days (default 7d).

curl -X GET "https://api.inboxy.chat/api/v1/telegram/top-performers" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/telegram/volume-timelineanalytics:read

Telegram message volume over time

Requires analytics:read permission.

Query parameters

window string Lookback window as "<n>d", 1–90 days (default 7d).

curl -X GET "https://api.inboxy.chat/api/v1/telegram/volume-timeline" \
  -H "Authorization: Bearer inboxy_your_token"

AI Agents

GET/api/v1/ai-agents/channelsai:read

List channels available for agent assignment

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/channels" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/presets/personalitiesai:read

List agent personality presets

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/presets/personalities" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/presets/agent-typesai:read

List agent type presets

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/presets/agent-types" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agentsai:read

List AI agents

Requires ai:read permission.

Query parameters

`includeInactive`	`boolean`
`limit`	`integer`	Default 50.
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/ai-agentsai:write

Create an AI agent

Requires ai:write permission.

Body

`name`required	`string`	Agent name (max 50 chars).
`mission`required	`string`	Agent mission statement (max 500 chars).
`avatar`	`string`	Avatar image URL, or null.
`gender`	`MALE \| FEMALE \| NEUTRAL`	Or null.
`personalityType`	`string`	Personality preset key, or null.
`personality`	`string`	Free-text personality description, or null.
`agentType`	`GENERAL \| SALES \| SUPPORT \| REAL_ESTATE \| HEALTHCARE \| EDUCATION \| ECOMMERCE \| HOSPITALITY \| CUSTOM`	Or null.
`instructions`	`string`	Extra instructions (max 2000 chars), or null.
`primaryLanguage`	`string`	Primary reply language, or null.
`responseStyle`	`CONCISE \| BALANCED \| DETAILED \| FRIENDLY \| FORMAL`	Or null.
`maxTokens`	`number`	100-4000, or null.
`temperature`	`number`	0-2, or null.
`isDefault`	`boolean`	Or null.
`assignedChannels`	`string[]`	Channel IDs this agent handles, or null.
`transferStrategy`	`LEAST_BUSY \| ROUND_ROBIN \| RANDOM \| SPECIFIC_AGENT`	Or null.
`transferAgentId`	`string`	Target user ID for handoff, or null.
`sendProductImages`	`boolean`	Or null.

curl -X POST "https://api.inboxy.chat/api/v1/ai-agents" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Layla",
  "mission": "Answer product questions and qualify leads.",
  "avatar": "avatar",
  "gender": "MALE",
  "personalityType": "personalityType",
  "personality": "personality",
  "agentType": "GENERAL",
  "instructions": "instructions",
  "primaryLanguage": "ar",
  "responseStyle": "CONCISE",
  "maxTokens": 1,
  "temperature": 1,
  "isDefault": true,
  "assignedChannels": [
    "assignedChannels"
  ],
  "transferStrategy": "LEAST_BUSY",
  "transferAgentId": "transferAgentId",
  "sendProductImages": true
}'

GET/api/v1/ai-agents/statsai:read

Get AI agent stats

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/insights/scheduleai:read

Get the conversation insights schedule

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/insights/schedule" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/ai-agents/insights/scheduleai:write

Set the conversation insights schedule

Requires ai:write permission.

Body

`enabled`required	`boolean`	Whether scheduled insight reports are on.
`cadence`required	`DAILY \| CUSTOM_DAYS \| WEEKLY \| MONTHLY`
`intervalDays`	`number`	1-31, used when cadence is CUSTOM_DAYS. Defaults to 2.
`dayOfWeek`	`number`	0-6, used when cadence is WEEKLY. Defaults to 1.
`dayOfMonth`	`number`	1-28, used when cadence is MONTHLY. Defaults to 1.
`scheduleHour`	`number`	0-23, hour of day to run. Defaults to 4.
`timezone`required	`string`	IANA timezone identifier.

curl -X PUT "https://api.inboxy.chat/api/v1/ai-agents/insights/schedule" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true,
  "cadence": "WEEKLY",
  "intervalDays": 1,
  "dayOfWeek": 1,
  "dayOfMonth": 1,
  "scheduleHour": 1,
  "timezone": "Asia/Riyadh"
}'

GET/api/v1/ai-agents/insights/reportsai:read

List conversation insight reports

Requires ai:read permission.

Query parameters

`limit`	`integer`	Default 20.
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/insights/reports" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/insights/reports/{reportId}ai:read

Get a conversation insight report

Requires ai:read permission.

Path parameters

reportIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/insights/reports/{reportId}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/ai-agents/insights/runai:write

Queue a manual conversation insight report

Requires ai:write permission.

Body

`lookbackDays`	`number`	1-365. Defaults to 7.
`mode`	`QUICK_SAMPLE \| FULL_COVERAGE`	Defaults to QUICK_SAMPLE.

curl -X POST "https://api.inboxy.chat/api/v1/ai-agents/insights/run" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "lookbackDays": 7,
  "mode": "QUICK_SAMPLE"
}'

GET/api/v1/ai-agents/historical-learningai:read

List historical learning profiles

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/historical-learning" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/ai-agents/{agentId}/historical-learningai:write

Enable or disable historical learning for an agent

Requires ai:write permission.

Path parameters

agentIdrequired string

Body

enabledrequired boolean Enable or disable historical learning for this agent.

curl -X PUT "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/historical-learning" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "enabled": true
}'

POST/api/v1/ai-agents/{agentId}/historical-learning/runai:write

Run historical learning analysis for an agent

Requires ai:write permission.

Path parameters

agentIdrequired string

Body

lookbackDays number 1-365. Defaults to 365.

curl -X POST "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/historical-learning/run" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "lookbackDays": 90
}'

GET/api/v1/ai-agents/{agentId}ai:read

Get an AI agent

Requires ai:read permission.

Path parameters

agentIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/{agentId}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/ai-agents/{agentId}ai:write

Update an AI agent

Requires ai:write permission.

Path parameters

agentIdrequired string

Body

`name`	`string`	Agent name (max 50 chars).
`mission`	`string`	Agent mission statement (max 500 chars).
`avatar`	`string`	Avatar image URL, or null.
`gender`	`MALE \| FEMALE \| NEUTRAL`	Or null.
`personalityType`	`string`	Personality preset key, or null.
`personality`	`string`	Free-text personality description, or null.
`agentType`	`GENERAL \| SALES \| SUPPORT \| REAL_ESTATE \| HEALTHCARE \| EDUCATION \| ECOMMERCE \| HOSPITALITY \| CUSTOM`	Or null.
`instructions`	`string`	Extra instructions (max 2000 chars), or null.
`primaryLanguage`	`string`	Primary reply language, or null.
`responseStyle`	`CONCISE \| BALANCED \| DETAILED \| FRIENDLY \| FORMAL`	Or null.
`maxTokens`	`number`	100-4000, or null.
`temperature`	`number`	0-2, or null.
`isDefault`	`boolean`	Or null.
`assignedChannels`	`string[]`	Channel IDs this agent handles, or null.
`transferStrategy`	`LEAST_BUSY \| ROUND_ROBIN \| RANDOM \| SPECIFIC_AGENT`	Or null.
`transferAgentId`	`string`	Target user ID for handoff, or null.
`sendProductImages`	`boolean`	Or null.
`isActive`	`boolean`	Whether the agent is active, or null.

curl -X PUT "https://api.inboxy.chat/api/v1/ai-agents/{agentId}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "mission": "mission",
  "avatar": "avatar",
  "gender": "MALE",
  "personalityType": "personalityType",
  "personality": "personality",
  "agentType": "GENERAL",
  "instructions": "instructions",
  "primaryLanguage": "ar",
  "responseStyle": "CONCISE",
  "maxTokens": 1,
  "temperature": 1,
  "isDefault": true,
  "assignedChannels": [
    "assignedChannels"
  ],
  "transferStrategy": "LEAST_BUSY",
  "transferAgentId": "transferAgentId",
  "sendProductImages": true,
  "isActive": true
}'

DELETE/api/v1/ai-agents/{agentId}ai:write

Delete an AI agent

Requires ai:write permission.

Path parameters

agentIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/ai-agents/{agentId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/{agentId}/knowledgeai:read

List agent knowledge entries

Requires ai:read permission.

Path parameters

agentIdrequired string

Query parameters

`category`	`string`
`includeInactive`	`boolean`
`limit`	`integer`	Default 50.
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/knowledge" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/{agentId}/knowledge/categoriesai:read

List agent knowledge categories

Requires ai:read permission.

Path parameters

agentIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/knowledge/categories" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/{agentId}/knowledge/{knowledgeId}ai:read

Get an agent knowledge entry

Requires ai:read permission.

Path parameters

`agentId`required	`string`
`knowledgeId`required	`string`

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/knowledge/{knowledgeId}" \
  -H "Authorization: Bearer inboxy_your_token"

DELETE/api/v1/ai-agents/{agentId}/knowledge/{knowledgeId}ai:write

Delete an agent knowledge entry

Requires ai:write permission.

Path parameters

`agentId`required	`string`
`knowledgeId`required	`string`

curl -X DELETE "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/knowledge/{knowledgeId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/upload/infoai:read

Get supported knowledge upload file types

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/upload/info" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/logsai:read

List agent event logs

Requires ai:read permission.

Query parameters

`agentId`	`string`
`eventType`	`MESSAGE_RECEIVED \| MESSAGE_SENT \| KNOWLEDGE_SEARCH \| KNOWLEDGE_HIT \| KNOWLEDGE_MISS \| FUNCTION_CALLED \| FUNCTION_SUCCESS \| FUNCTION_FAILED \| TASK_CREATED \| LEAD_ASSIGNED \| APPOINTMENT_BOOKED \| ORDER_CREATED \| TICKET_CREATED \| HANDOFF_REQUESTED \| HANDOFF_COMPLETED \| ERROR_OCCURRED \| RATE_LIMITED \| QUOTA_EXCEEDED`	Must be one of the listed values.
`startDate`	`string`	ISO date.
`endDate`	`string`	ISO date.
`limit`	`integer`	Default 50.
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/logs" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/logs/statsai:read

Get agent log stats

Requires ai:read permission.

Query parameters

agentId string One agent instead of all.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/logs/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/functions/builtinai:read

List built-in agent functions

Requires ai:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/functions/builtin" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ai-agents/{agentId}/functionsai:read

List agent functions

Requires ai:read permission.

Path parameters

agentIdrequired string

Query parameters

includeDisabled boolean

curl -X GET "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/functions" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/ai-agents/{agentId}/functionsai:write

Create an agent function

Requires ai:write permission.

Path parameters

agentIdrequired string

Body

`name`required	`string`	Lowercase with underscores (max 50 chars).
`displayName`required	`string`	Human-readable name (max 100 chars).
`description`required	`string`	What the function does (max 500 chars); shown to the model as the function description.
`parameters`required	`object`	JSON Schema object describing the function parameters.
`executorType`	`INTERNAL \| WEBHOOK \| AUTOMATION`	Defaults to INTERNAL.
`executorConfig`	`object`	Executor-specific config (e.g. webhook URL).

curl -X POST "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/functions" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "check_order_status",
  "displayName": "Check order status",
  "description": "description",
  "parameters": {},
  "executorType": "INTERNAL",
  "executorConfig": {}
}'

PUT/api/v1/ai-agents/{agentId}/functions/{functionId}ai:write

Update an agent function

Requires ai:write permission.

Path parameters

`agentId`required	`string`
`functionId`required	`string`

Body

`name`	`string`	Lowercase with underscores (max 50 chars).
`displayName`	`string`	Human-readable name (max 100 chars).
`description`	`string`	What the function does (max 500 chars); shown to the model as the function description.
`parameters`	`object`	JSON Schema object describing the function parameters.
`executorType`	`INTERNAL \| WEBHOOK \| AUTOMATION`	Defaults to INTERNAL.
`executorConfig`	`object`	Executor-specific config (e.g. webhook URL).
`isEnabled`	`boolean`	Whether the function is enabled.

curl -X PUT "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/functions/{functionId}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "check_order_status",
  "displayName": "Check order status",
  "description": "description",
  "parameters": {},
  "executorType": "INTERNAL",
  "executorConfig": {},
  "isEnabled": true
}'

DELETE/api/v1/ai-agents/{agentId}/functions/{functionId}ai:write

Delete an agent function

Requires ai:write permission.

Path parameters

`agentId`required	`string`
`functionId`required	`string`

curl -X DELETE "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/functions/{functionId}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/ai-agents/{agentId}/functions/{functionId}/toggleai:write

Enable or disable an agent function

Requires ai:write permission.

Path parameters

`agentId`required	`string`
`functionId`required	`string`

Body

isEnabledrequired boolean Enable or disable the function.

curl -X PATCH "https://api.inboxy.chat/api/v1/ai-agents/{agentId}/functions/{functionId}/toggle" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "isEnabled": true
}'

POST/api/v1/ai-agents/functions/syncai:write

Sync built-in functions to all agents

Requires ai:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/ai-agents/functions/sync" \
  -H "Authorization: Bearer inboxy_your_token"

CSAT

GET/api/v1/csat/configanalytics:read

Get the CSAT survey config

Requires analytics:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/csat/config" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/csat/analyticsanalytics:read

Get CSAT analytics for a period

Requires analytics:read permission.

Query parameters

period 7d | 30d | 90d Reporting window (default 30d).

curl -X GET "https://api.inboxy.chat/api/v1/csat/analytics" \
  -H "Authorization: Bearer inboxy_your_token"

Team

GET/api/v1/teamteam:read

List team members

Requires team:read permission.

Query parameters

`search`	`string`	Name or email.
`role`	`COMPANY_ADMIN \| MANAGER \| AGENT \| VIEWER`
`isActive`	`true \| false`
`limit`	`integer`	Page size (default 50).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/team" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/team/{userId}team:read

Get a team member

Requires team:read permission.

Path parameters

userIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/team/{userId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/team/statsteam:read

Get team headcount and role breakdown

Requires team:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/team/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/companyteam:read

Get company profile and settings

Requires team:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/company" \
  -H "Authorization: Bearer inboxy_your_token"

Conversations

GET/api/v1/inbox/conversationsconversations:read

List inbox conversations

Requires conversations:read permission.

Query parameters

`status`	`string`	Conversation status, e.g. OPEN or CLOSED.
`channelType`	`string`	Channel type, e.g. WHATSAPP or INSTAGRAM.
`assignedToId`	`string`	Only conversations assigned to this user.
`unassigned`	`boolean`	Only unassigned conversations (overrides assignedToId).
`unread`	`boolean`	Only conversations with unread messages.
`aiEnabled`	`boolean`	Filter by whether the AI agent is on.
`search`	`string`	Contact name or phone.
`tagIds`	`string`	Comma-separated contact tag ids.
`dateFrom`	`string`	ISO date; last message on or after.
`dateTo`	`string`	ISO date; last message on or before.
`limit`	`integer`	Max rows, up to 1000 (default 50).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/inbox/conversations" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/inbox/conversations/{conversationId}conversations:read

Get a conversation

Requires conversations:read permission.

Path parameters

conversationIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/inbox/conversations/{conversationId}/messagesmessages:read

List messages in a conversation

Requires messages:read permission.

Path parameters

conversationIdrequired string

Query parameters

`limit`	`integer`	Max messages, up to 200 (default 100).
`before`	`string`	ISO date cursor: messages older than this (scroll back).
`after`	`string`	ISO date cursor: messages newer than this. Wins over before.

curl -X GET "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/messages" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/inbox/conversations/{conversationId}/windowconversations:read

Check the 24-hour messaging window

Requires conversations:read permission.

Path parameters

conversationIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/window" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/inbox/conversations/{conversationId}/assignconversations:write

Assign a conversation to an agent

Requires conversations:write permission.

Path parameters

conversationIdrequired string

Body

assignedToId string User ID to assign the conversation to, or null to unassign. Must belong to the same company.

curl -X PATCH "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/assign" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "assignedToId": "usr_2n4k1x9p0q"
}'

PATCH/api/v1/inbox/conversations/{conversationId}/statusconversations:write

Change conversation status

Requires conversations:write permission.

Path parameters

conversationIdrequired string

Body

statusrequired open | pending | resolved | closed New conversation status.

curl -X PATCH "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/status" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "resolved"
}'

PATCH/api/v1/inbox/conversations/{conversationId}/labelsconversations:write

Set conversation labels

Requires conversations:write permission.

Path parameters

conversationIdrequired string

Body

labels string[] Full list of labels to set on the conversation (replaces existing labels).

curl -X PATCH "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/labels" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "labels": [
    "vip",
    "needs-followup"
  ]
}'

GET/api/v1/inbox/conversations/{conversationId}/notes/listconversations:read

List internal notes

Requires conversations:read permission.

Path parameters

conversationIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/notes/list" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/inbox/conversations/{conversationId}/notes/listconversations:write

Add an internal note

Requires conversations:write permission.

Path parameters

conversationIdrequired string

Body

contentrequired string Internal note text, visible only to your team.

curl -X POST "https://api.inboxy.chat/api/v1/inbox/conversations/{conversationId}/notes/list" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "Customer asked about bulk pricing — follow up Thursday."
}'

GET/api/v1/public/conversationsconversations:read

List conversations

Get a paginated list of conversations with filters. Requires conversations:read permission.

Query parameters

`page`	`integer`
`pageSize`	`integer`
`status`	`string`	Filter by status (open, closed, pending)
`channelType`	`string`	Filter by channel type (whatsapp, instagram, messenger, widget)
`assignedToId`	`string`	Filter by assigned agent ID
`unread`	`boolean`	Filter to only unread conversations
`search`	`string`	Search by contact name or phone
`dateFrom`	`string`	Filter messages from this date
`dateTo`	`string`	Filter messages to this date

curl -X GET "https://api.inboxy.chat/api/v1/public/conversations" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/conversations/{id}conversations:read

Get conversation by ID

Get a single conversation with contact, channel, and assigned agent details. Requires conversations:read permission.

Path parameters

idrequired string Resource ID

curl -X GET "https://api.inboxy.chat/api/v1/public/conversations/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Automations

GET/api/v1/automations-v2automations:read

List workflows

Requires automations:read permission.

Query parameters

`status`	`DRAFT \| ACTIVE \| PAUSED \| ARCHIVED`
`channelType`	`WHATSAPP \| INSTAGRAM \| MESSENGER \| TELEGRAM \| WEB \| SMS \| TIKTOK`
`search`	`string`	Name or description.
`limit`	`integer`	1–100 (default 20).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/automations-v2automations:write

Create a workflow

Requires automations:write permission.

Body

`name`required	`string`
`description`	`string`
`channelType`	`WHATSAPP \| INSTAGRAM \| MESSENGER \| TELEGRAM \| WEB \| SMS \| TIKTOK`

curl -X POST "https://api.inboxy.chat/api/v1/automations-v2" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Cart recovery on WhatsApp",
  "description": "description",
  "channelType": "WHATSAPP"
}'

POST/api/v1/automations-v2/importautomations:write

Import a workflow document

Requires automations:write permission.

Body

`formatVersion`required	`string`	The formatVersion from GET …/:workflowId/export.
`name`	`string`
`description`	`string`
`channelType`	`WHATSAPP \| INSTAGRAM \| MESSENGER \| TELEGRAM \| WEB \| SMS \| TIKTOK`
`triggerType`required	`string`	The event that starts the workflow — any webhook platform event name, e.g. "whatsapp.message.received", "ecommerce.cart.abandoned", "web_event.received".
`triggerConfig`	`object`	Trigger filters (channel, keywords, event fields).
`nodes`required	`object[]`	Each node: `{ id, type, position?, label?, config?, version? }`. `type` is a registered node type (e.g. "whatsapp.send.text", "time.delay", "ticket.create"); `config` is validated per type on publish. Max 500. Easiest start: export a workflow built in the dashboard (GET …/:workflowId/export) and edit it.
`edges`required	`object[]`	Each edge: `{ id, source, target, sourceHandle? }` referencing node ids. Max 1000.

curl -X POST "https://api.inboxy.chat/api/v1/automations-v2/import" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "formatVersion": "formatVersion",
  "name": "name",
  "description": "description",
  "channelType": "WHATSAPP",
  "triggerType": "ecommerce.cart.abandoned",
  "triggerConfig": {},
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ]
}'

GET/api/v1/automations-v2/{workflowId}automations:read

Get a workflow

Requires automations:read permission.

Path parameters

workflowIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}" \
  -H "Authorization: Bearer inboxy_your_token"

DELETE/api/v1/automations-v2/{workflowId}automations:write

Delete a workflow

Requires automations:write permission.

Path parameters

workflowIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/automations-v2/{workflowId}/graphautomations:read

Get a workflow with its nodes and edges

Requires automations:read permission.

Path parameters

workflowIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/graph" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/automations-v2/{workflowId}/exportautomations:read

Export a workflow as a portable document

Requires automations:read permission.

Path parameters

workflowIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/export" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/automations-v2/{workflowId}/statusautomations:write

Turn a workflow on, pause or archive it

Requires automations:write permission.

Path parameters

workflowIdrequired string

Body

statusrequired DRAFT | ACTIVE | PAUSED | ARCHIVED ACTIVE runs the published version; PAUSED stops new runs.

curl -X PATCH "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/status" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "ACTIVE"
}'

POST/api/v1/automations-v2/{workflowId}/publishautomations:write

Validate and publish a workflow graph

Requires automations:write permission.

Path parameters

workflowIdrequired string

Body

`triggerType`required	`string`	The event that starts the workflow — any webhook platform event name, e.g. "whatsapp.message.received", "ecommerce.cart.abandoned", "web_event.received".
`triggerConfig`	`object`	Trigger filters (channel, keywords, event fields).
`nodes`required	`object[]`	Each node: `{ id, type, position?, label?, config?, version? }`. `type` is a registered node type (e.g. "whatsapp.send.text", "time.delay", "ticket.create"); `config` is validated per type on publish. Max 500. Easiest start: export a workflow built in the dashboard (GET …/:workflowId/export) and edit it.
`edges`required	`object[]`	Each edge: `{ id, source, target, sourceHandle? }` referencing node ids. Max 1000.

curl -X POST "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/publish" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "triggerType": "ecommerce.cart.abandoned",
  "triggerConfig": {},
  "nodes": [
    {}
  ],
  "edges": [
    {}
  ]
}'

GET/api/v1/automations-v2/{workflowId}/runsautomations:read

List runs (execution history)

Requires automations:read permission.

Path parameters

workflowIdrequired string

Query parameters

`status`	`PENDING \| RUNNING \| WAITING \| SUCCEEDED \| FAILED \| CANCELLED`
`limit`	`integer`	1–100 (default 20).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/runs" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/automations-v2/{workflowId}/runs/{runId}automations:read

Get one run with its steps

Requires automations:read permission.

Path parameters

`workflowId`required	`string`
`runId`required	`string`

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/runs/{runId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/automations-v2/{workflowId}/statsanalytics:read

Run statistics for a workflow

Requires analytics:read permission.

Path parameters

workflowIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/automations-v2/{workflowId}/sample-eventsautomations:read

Recent real events this workflow’s trigger would receive

Requires automations:read permission.

Path parameters

workflowIdrequired string

Query parameters

`type`	`string`	Event type to sample (default: the workflow's trigger), e.g. whatsapp.message.received.
`limit`	`integer`	1–10 (default 5).

curl -X GET "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/sample-events" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/automations-v2/{workflowId}/test-runautomations:write

Dry-run a workflow on a sample event (nothing is sent)

Requires automations:write permission.

Path parameters

workflowIdrequired string

Body

`conversationId`	`string`	Defaults to the most recent conversation.
`sampleMessage`	`string`	Text injected into the sample trigger event. Dry run: nothing is sent and no AI is billed.

curl -X POST "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/test-run" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationId": "conversationId",
  "sampleMessage": "do you ship to Jeddah?"
}'

POST/api/v1/automations-v2/{workflowId}/test-armautomations:write

Capture the next real trigger event as a sample (60 seconds)

Requires automations:write permission.

Path parameters

workflowIdrequired string

curl -X POST "https://api.inboxy.chat/api/v1/automations-v2/{workflowId}/test-arm" \
  -H "Authorization: Bearer inboxy_your_token"

Interactive messages

GET/api/v1/interactive-messageslibrary:read

List saved interactive messages

Requires library:read permission.

Query parameters

`type`	`BUTTONS \| LIST \| LOCATION \| CONTACT \| CTA_URL \| LOCATION_REQUEST`
`category`	`string`
`isActive`	`boolean`	Defaults to active only.
`search`	`string`	Name, description or tags.

curl -X GET "https://api.inboxy.chat/api/v1/interactive-messages" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/interactive-messageslibrary:write

Save an interactive message

Requires library:write permission.

Body

`name`required	`string`
`description`	`string`
`type`required	`BUTTONS \| LIST \| LOCATION \| CONTACT \| CTA_URL \| LOCATION_REQUEST`
`config`required	`object`	BUTTONS: `{body, header?, headerImage?, footer?, buttons:[{id,title}]}` (max 3). LIST: `{body, buttonText, sections:[{title, rows:[{id,title,description?}]}]}`. LOCATION: `{latitude, longitude, name?, address?}`. CONTACT: WhatsApp contact card. CTA_URL: `{body, buttonText, url}`. LOCATION_REQUEST: `{body}`.
`category`	`string`
`tags`	`string[]`

curl -X POST "https://api.inboxy.chat/api/v1/interactive-messages" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Main menu",
  "description": "description",
  "type": "BUTTONS",
  "config": {
    "body": "How can we help?",
    "buttons": [
      {
        "id": "orders",
        "title": "My orders"
      },
      {
        "id": "agent",
        "title": "Talk to us"
      }
    ]
  },
  "category": "category",
  "tags": [
    "tags"
  ]
}'

GET/api/v1/interactive-messages/statslibrary:read

Saved interactive message stats

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/interactive-messages/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/interactive-messages/categorieslibrary:read

List library categories

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/interactive-messages/categories" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/interactive-messages/{id}library:read

Get a saved interactive message

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/interactive-messages/{id}library:write

Update a saved interactive message

Requires library:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`description`	`string`
`config`	`object`
`category`	`string`
`tags`	`string[]`
`isActive`	`boolean`

curl -X PUT "https://api.inboxy.chat/api/v1/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "config": {},
  "category": "category",
  "tags": [
    "tags"
  ],
  "isActive": true
}'

DELETE/api/v1/interactive-messages/{id}library:write

Delete a saved interactive message

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/interactive-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/interactive-messages/{id}/duplicatelibrary:write

Duplicate a saved interactive message

Requires library:write permission.

Path parameters

idrequired string

Body

namerequired string

curl -X POST "https://api.inboxy.chat/api/v1/interactive-messages/{id}/duplicate" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Main menu (copy)"
}'

Quick Replies

GET/api/v1/quick-replieslibrary:read

List quick replies

Requires library:read permission.

Query parameters

`category`	`string`
`isActive`	`boolean`	Filter by active state.
`search`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/quick-replieslibrary:write

Create a quick reply

Requires library:write permission.

Body

`shortcut`required	`string`	Slash-command shortcut, unique per company.
`label`required	`string`	Display label.
`text`required	`string`	Reply text to insert.
`category`	`string`	Category to group under.

curl -X POST "https://api.inboxy.chat/api/v1/quick-replies" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "shortcut": "/refund",
  "label": "Refund policy",
  "text": "text",
  "category": "category"
}'

GET/api/v1/quick-replies/categorieslibrary:read

List quick reply categories

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/quick-replies/categories" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/quick-replies/{id}library:read

Get a quick reply

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/quick-replies/{id}library:write

Update a quick reply

Requires library:write permission.

Path parameters

idrequired string

Body

`shortcut`	`string`	Slash-command shortcut.
`label`	`string`	Display label.
`text`	`string`	Reply text.
`category`	`string`	Category to group under.
`isActive`	`boolean`	Whether the quick reply is active.

curl -X PUT "https://api.inboxy.chat/api/v1/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "shortcut": "shortcut",
  "label": "label",
  "text": "text",
  "category": "category",
  "isActive": true
}'

DELETE/api/v1/quick-replies/{id}library:write

Delete a quick reply

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/quick-replies/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/quick-replies/{id}/uselibrary:write

Record quick reply usage

Requires library:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/quick-replies/{id}/use" \
  -H "Authorization: Bearer inboxy_your_token"

Saved Contacts

GET/api/v1/saved-contactslibrary:read

List saved contacts

Requires library:read permission.

Query parameters

`category`	`string`
`isActive`	`boolean`	Filter by active state.
`search`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/saved-contacts" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/saved-contactslibrary:write

Create a saved contact

Requires library:write permission.

Body

`name`required	`string`	Contact display name.
`formattedName`required	`string`	Formatted display name used in the vCard.
`phones`	`object[]`
`emails`	`object[]`
`organization`	`string`	Company/organization name.
`title`	`string`	Job title.
`addresses`	`object[]`
`urls`	`object[]`
`category`	`string`	Category to group under.

curl -X POST "https://api.inboxy.chat/api/v1/saved-contacts" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Ahmed Al-Otaibi",
  "formattedName": "Ahmed Al-Otaibi - Sales",
  "phones": [
    {
      "type": "WORK",
      "phone": "966500000000"
    }
  ],
  "emails": [
    {
      "type": "WORK",
      "email": "customer@example.com"
    }
  ],
  "organization": "organization",
  "title": "title",
  "addresses": [
    {
      "type": "WORK",
      "street": "street",
      "city": "city",
      "state": "state",
      "zip": "zip",
      "country": "country"
    }
  ],
  "urls": [
    {
      "type": "WORK",
      "url": "url"
    }
  ],
  "category": "category"
}'

GET/api/v1/saved-contacts/categorieslibrary:read

List saved contact categories

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/saved-contacts/categories" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/saved-contacts/{id}library:read

Get a saved contact

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/saved-contacts/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/saved-contacts/{id}library:write

Update a saved contact

Requires library:write permission.

Path parameters

idrequired string

Body

`name`	`string`	Contact display name.
`formattedName`	`string`	Formatted display name used in the vCard.
`phones`	`object[]`
`emails`	`object[]`
`organization`	`string`	Company/organization name.
`title`	`string`	Job title.
`addresses`	`object[]`
`urls`	`object[]`
`category`	`string`	Category to group under.
`isActive`	`boolean`	Whether the saved contact is active.

curl -X PUT "https://api.inboxy.chat/api/v1/saved-contacts/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "formattedName": "formattedName",
  "phones": [
    {
      "type": "WORK",
      "phone": "966500000000"
    }
  ],
  "emails": [
    {
      "type": "WORK",
      "email": "customer@example.com"
    }
  ],
  "organization": "organization",
  "title": "title",
  "addresses": [
    {
      "type": "WORK",
      "street": "street",
      "city": "city",
      "state": "state",
      "zip": "zip",
      "country": "country"
    }
  ],
  "urls": [
    {
      "type": "WORK",
      "url": "url"
    }
  ],
  "category": "category",
  "isActive": true
}'

DELETE/api/v1/saved-contacts/{id}library:write

Delete a saved contact

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/saved-contacts/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/saved-contacts/{id}/whatsapplibrary:read

Get a saved contact in WhatsApp vCard format

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/saved-contacts/{id}/whatsapp" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/saved-contacts/{id}/uselibrary:write

Record saved contact usage

Requires library:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/saved-contacts/{id}/use" \
  -H "Authorization: Bearer inboxy_your_token"

Saved Locations

GET/api/v1/saved-locationslibrary:read

List saved locations

Requires library:read permission.

Query parameters

`category`	`string`
`isActive`	`boolean`	Filter by active state.
`search`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/saved-locations" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/saved-locationslibrary:write

Create a saved location

Requires library:write permission.

Body

`name`required	`string`	Location name.
`address`	`string`	Street address.
`latitude`required	`number`
`longitude`required	`number`
`category`	`string`	Category to group under.
`isActive`	`boolean`	Defaults to true.

curl -X POST "https://api.inboxy.chat/api/v1/saved-locations" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Main Warehouse",
  "address": "address",
  "latitude": 24.7136,
  "longitude": 46.6753,
  "category": "category",
  "isActive": true
}'

GET/api/v1/saved-locations/categorieslibrary:read

List saved location categories

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/saved-locations/categories" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/saved-locations/{id}library:read

Get a saved location

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/saved-locations/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/saved-locations/{id}library:write

Update a saved location

Requires library:write permission.

Path parameters

idrequired string

Body

`name`	`string`	Location name.
`address`	`string`	Street address.
`latitude`	`number`
`longitude`	`number`
`category`	`string`	Category to group under.
`isActive`	`boolean`

curl -X PUT "https://api.inboxy.chat/api/v1/saved-locations/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "address": "address",
  "latitude": 1,
  "longitude": 1,
  "category": "category",
  "isActive": true
}'

DELETE/api/v1/saved-locations/{id}library:write

Delete a saved location

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/saved-locations/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/saved-locations/{id}/whatsapplibrary:read

Get a saved location in WhatsApp location format

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/saved-locations/{id}/whatsapp" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/saved-locations/{id}/uselibrary:write

Record saved location usage

Requires library:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/saved-locations/{id}/use" \
  -H "Authorization: Bearer inboxy_your_token"

Stores

POST/api/v1/woocommerce/syncchannels:write

Sync from WooCommerce (?full=true for a full reconcile)

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/woocommerce/sync" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/woocommerce/sync/customerschannels:write

Sync WooCommerce customers

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/woocommerce/sync/customers" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/woocommerce/sync/orderschannels:write

Sync WooCommerce orders

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/woocommerce/sync/orders" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/woocommerce/sync/productschannels:write

Sync WooCommerce products

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/woocommerce/sync/products" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/woocommerce/abandoned-cartsecommerce:read

WooCommerce abandoned carts

Requires ecommerce:read permission.

Query parameters

`status`	`ABANDONED \| RECOVERED \| EXPIRED`
`page`	`integer`	Page number (default 1).
`per_page`	`integer`	Up to 100 (default 20).

curl -X GET "https://api.inboxy.chat/api/v1/woocommerce/abandoned-carts" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/woocommerce/abandoned-carts/statsecommerce:read

WooCommerce cart recovery stats

Requires ecommerce:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/woocommerce/abandoned-carts/stats" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/woocommerce/abandoned-carts/{id}/recoverecommerce:write

Mark a WooCommerce cart recovered

Requires ecommerce:write permission.

Path parameters

idrequired string

Body

orderId number The order that recovered the cart, if known.

curl -X PATCH "https://api.inboxy.chat/api/v1/woocommerce/abandoned-carts/{id}/recover" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "orderId": 1
}'

GET/api/v1/shopify/configchannels:read

Shopify connection status (no secrets)

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/shopify/config" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/shopify/syncchannels:write

Sync everything from Shopify

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/shopify/sync" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/shopify/sync/customerschannels:write

Sync Shopify customers

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/shopify/sync/customers" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/shopify/sync/orderschannels:write

Sync Shopify orders

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/shopify/sync/orders" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/shopify/sync/productschannels:write

Sync Shopify products

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/shopify/sync/products" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/salla/configchannels:read

Salla connection status (no secrets)

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/salla/config" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/salla/abandoned-cartsecommerce:read

Salla abandoned carts

Requires ecommerce:read permission.

Query parameters

`page`	`integer`	Page number (default 1).
`limit`	`integer`	Up to 100 (default 20).
`status`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/salla/abandoned-carts" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/salla/abandoned-carts/statsecommerce:read

Salla cart recovery stats

Requires ecommerce:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/salla/abandoned-carts/stats" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/salla/abandoned-carts/{id}/recoverecommerce:write

Mark a Salla cart recovered

Requires ecommerce:write permission.

Path parameters

idrequired string

Body

orderId number The order that recovered the cart, if known.

curl -X PATCH "https://api.inboxy.chat/api/v1/salla/abandoned-carts/{id}/recover" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "orderId": 1
}'

POST/api/v1/salla/syncchannels:write

Sync from Salla

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/salla/sync" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/zid/configchannels:read

Zid connection status (no secrets)

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/zid/config" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/zid/syncchannels:write

Sync orders from Zid

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/zid/sync" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/zid/abandoned-cartsecommerce:read

Zid abandoned carts

Requires ecommerce:read permission.

Query parameters

`page`	`integer`	Page number (default 1).
`limit`	`integer`	Up to 100 (default 20).
`status`	`ABANDONED \| RECOVERED \| COMPLETED`

curl -X GET "https://api.inboxy.chat/api/v1/zid/abandoned-carts" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/easy-orders/configchannels:read

EasyOrders connection status (no secrets)

Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/easy-orders/config" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/easy-orders/syncchannels:write

Sync from EasyOrders

Requires channels:write permission.

curl -X POST "https://api.inboxy.chat/api/v1/easy-orders/sync" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ecommerce/overviewecommerce:read

Store KPIs: orders, revenue, store connectivity

Requires ecommerce:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/ecommerce/overview" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ecommerce/customersecommerce:read

List store customers across platforms

Requires ecommerce:read permission.

Query parameters

`page`	`integer`	Page number (default 1).
`pageSize`	`integer`	Up to 100 (default 25).
`search`	`string`	Name, email or phone.
`platform`	`string`	Comma-separated: SHOPIFY, SALLA, WOOCOMMERCE, ZID, EASYORDERS.

curl -X GET "https://api.inboxy.chat/api/v1/ecommerce/customers" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/ecommerce/customers/{id}ecommerce:read

Get a store customer with orders

Requires ecommerce:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/ecommerce/customers/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Webhooks

GET/api/v1/webhooks/eventswebhooks:read

List webhook event types

Requires webhooks:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/webhooks/events" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/webhookswebhooks:read

List webhooks

Requires webhooks:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/webhooks" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/webhookswebhooks:write

Register a webhook

Requires webhooks:write permission.

Body

`name`required	`string`	Webhook name.
`url`required	`string`	HTTPS endpoint to receive events. Must be a public, non-private-network URL.
`events`required	`string[]`	Events to receive: exact names from GET /api/v1/webhooks/events, "" for everything, or a prefix wildcard such as "whatsapp.", "ecommerce.order." or "ticket.".
`maxRetries`	`number`	Max delivery retry attempts.
`fieldExclusions`	`string[]`	Dot-separated payload paths to omit from delivered payloads (max 20).
`consecutiveFailureThreshold`	`number`	Consecutive failures (5-1000) before the webhook auto-pauses.

curl -X POST "https://api.inboxy.chat/api/v1/webhooks" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Order sync",
  "url": "https://example.com/webhooks/inboxy",
  "events": [
    "message.received",
    "ecommerce.order.*",
    "ticket.created"
  ],
  "maxRetries": 1,
  "fieldExclusions": [
    "fieldExclusions"
  ],
  "consecutiveFailureThreshold": 1
}'

GET/api/v1/webhooks/{webhookId}webhooks:read

Get a webhook

Requires webhooks:read permission.

Path parameters

webhookIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/webhooks/{webhookId}webhooks:write

Update a webhook

Requires webhooks:write permission.

Path parameters

webhookIdrequired string

Body

`name`	`string`	Webhook name.
`url`	`string`	HTTPS endpoint to receive events.
`events`	`string[]`	Events to receive: exact names from GET /api/v1/webhooks/events, "" for everything, or a prefix wildcard such as "whatsapp.", "ecommerce.order." or "ticket.".
`status`	`ACTIVE \| PAUSED \| FAILED`	Webhook status.
`maxRetries`	`number`	Max delivery retry attempts.
`fieldExclusions`	`string[]`	Dot-separated payload paths to omit from delivered payloads (max 20).
`consecutiveFailureThreshold`	`number`	Consecutive failures (5-1000) before the webhook auto-pauses.

curl -X PUT "https://api.inboxy.chat/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "url": "url",
  "events": [
    "message.received",
    "ecommerce.order.*",
    "ticket.created"
  ],
  "status": "ACTIVE",
  "maxRetries": 1,
  "fieldExclusions": [
    "fieldExclusions"
  ],
  "consecutiveFailureThreshold": 1
}'

DELETE/api/v1/webhooks/{webhookId}webhooks:write

Delete a webhook

Requires webhooks:write permission.

Path parameters

webhookIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/webhooks/{webhookId}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/webhooks/{webhookId}/testwebhooks:write

Send a test delivery

Requires webhooks:write permission.

Path parameters

webhookIdrequired string

curl -X POST "https://api.inboxy.chat/api/v1/webhooks/{webhookId}/test" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/webhooks/{webhookId}/logswebhooks:read

List webhook deliveries

Requires webhooks:read permission.

Path parameters

webhookIdrequired string

Query parameters

`limit`	`integer`	Max deliveries (default 50).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/webhooks/{webhookId}/logs" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/webhooks/{webhookId}/secretwebhooks:write

Reveal the signing secret (to verify X-Inboxy-Signature)

Requires webhooks:write permission.

Path parameters

webhookIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/webhooks/{webhookId}/secret" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/webhooks/{webhookId}/regenerate-secretwebhooks:write

Rotate the signing secret

Requires webhooks:write permission.

Path parameters

webhookIdrequired string

curl -X POST "https://api.inboxy.chat/api/v1/webhooks/{webhookId}/regenerate-secret" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/webhooks/{webhookId}/replaywebhooks:write

Redeliver the failed deliveries of the last 7 days

Requires webhooks:write permission.

Path parameters

webhookIdrequired string

curl -X POST "https://api.inboxy.chat/api/v1/webhooks/{webhookId}/replay" \
  -H "Authorization: Bearer inboxy_your_token"

Orders

GET/api/v1/ordersorders:read

List orders

Requires orders:read permission.

Query parameters

`contactId`	`string`
`status`	`string`	Comma-separated: PENDING, CONFIRMED, PROCESSING, COMPLETED, CANCELLED, REFUNDED.
`paymentStatus`	`string`	Comma-separated: UNPAID, PARTIALLY_PAID, PAID, REFUNDED.
`fulfillmentStatus`	`string`	Comma-separated: UNFULFILLED, PARTIALLY_FULFILLED, SHIPPED, DELIVERED, FULFILLED, RETURNED.
`externalSource`	`string`	Comma-separated: WHATSAPP_COMMERCE, WOOCOMMERCE, SHOPIFY, SALLA, ZID, EASY_ORDERS, MANUAL, AI_AGENT, WEB_EVENT.
`minTotal`	`number`
`maxTotal`	`number`
`dateAfter`	`string`	ISO date-time.
`dateBefore`	`string`	ISO date-time.
`search`	`string`	Order number or customer.
`page`	`integer`	Page number (default 1).
`limit`	`integer`
`sortBy`	`orderDate \| total \| createdAt`
`sortOrder`	`asc \| desc`	Sort direction.

curl -X GET "https://api.inboxy.chat/api/v1/orders" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/ordersorders:write

Create an order

Requires orders:write permission.

Body

`contactId`required	`string`	Contact this order belongs to.
`externalId`	`string`	ID of this order in the external source system.
`externalSource`required	`WHATSAPP_COMMERCE \| WOOCOMMERCE \| SHOPIFY \| SALLA \| ZID \| EASY_ORDERS \| MANUAL \| AI_AGENT \| WEB_EVENT`	Where the order came from.
`orderNumber`required	`string`	Human-readable order number.
`status`	`PENDING \| CONFIRMED \| PROCESSING \| COMPLETED \| CANCELLED \| REFUNDED`	Order status. Defaults to PENDING.
`subtotal`required	`number`	Subtotal before tax/shipping/discount.
`tax`	`number`	Tax amount.
`shipping`	`number`	Shipping cost.
`discount`	`number`	Discount amount.
`total`required	`number`	Order total.
`currency`	`string`	ISO currency code.
`paymentMethod`	`string`	Payment method used.
`paymentStatus`	`UNPAID \| PARTIALLY_PAID \| PAID \| REFUNDED`	Payment status. Defaults to UNPAID.
`fulfillmentStatus`	`UNFULFILLED \| PARTIALLY_FULFILLED \| SHIPPED \| DELIVERED \| FULFILLED \| RETURNED`	Fulfillment status. Defaults to UNFULFILLED.
`billingAddress`	`object`	Billing address fields.
`shippingAddress`	`object`	Shipping address fields.
`customerNote`	`string`	Note from the customer.
`internalNote`	`string`	Internal-only note.
`orderDate`	`string`	Order date, ISO 8601. Defaults to now.
`metadata`	`object`	Arbitrary key/value metadata.
`items`	`string[]`	Line items: { name, quantity, unitPrice, totalPrice, sku?, productId?, imageUrl?, variant? }.

curl -X POST "https://api.inboxy.chat/api/v1/orders" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "contactId": "contactId",
  "externalId": "externalId",
  "externalSource": "MANUAL",
  "orderNumber": "ORD-1042",
  "status": "PENDING",
  "subtotal": 199,
  "tax": 1,
  "shipping": 1,
  "discount": 1,
  "total": 199,
  "currency": "SAR",
  "paymentMethod": "cod",
  "paymentStatus": "UNPAID",
  "fulfillmentStatus": "UNFULFILLED",
  "billingAddress": {},
  "shippingAddress": {},
  "customerNote": "customerNote",
  "internalNote": "internalNote",
  "orderDate": "orderDate",
  "metadata": {},
  "items": []
}'

GET/api/v1/orders/statsorders:read

Order statistics

Requires orders:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/orders/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/orders/{id}orders:read

Get an order

Requires orders:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/orders/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/orders/{id}orders:write

Update an order

Requires orders:write permission.

Path parameters

idrequired string

Body

`status`	`PENDING \| CONFIRMED \| PROCESSING \| COMPLETED \| CANCELLED \| REFUNDED`	Order status.
`paymentStatus`	`UNPAID \| PARTIALLY_PAID \| PAID \| REFUNDED`	Payment status.
`paymentMethod`	`string`	Payment method used.
`fulfillmentStatus`	`UNFULFILLED \| PARTIALLY_FULFILLED \| SHIPPED \| DELIVERED \| FULFILLED \| RETURNED`	Fulfillment status.
`shippingAddress`	`object`	Shipping address fields.
`billingAddress`	`object`	Billing address fields.
`customerNote`	`string`	Note from the customer.
`internalNote`	`string`	Internal-only note.
`metadata`	`object`	Arbitrary key/value metadata.
`confirmationStatus`	`UNCONFIRMED \| PENDING_CONFIRMATION \| CONFIRMED \| FAILED \| CANCELLED_BY_CUSTOMER`	Order confirmation status.
`confirmationChannel`	`string`	Channel the confirmation was collected on.
`trackingNumber`	`string`	Shipment tracking number.
`trackingCarrier`	`string`	Shipment carrier name.
`trackingUrl`	`string`	Shipment tracking URL.
`cancellationReason`	`string`	Reason for cancellation.
`refundReason`	`string`	Reason for refund.
`refundAmount`	`number`	Amount refunded.

curl -X PUT "https://api.inboxy.chat/api/v1/orders/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "PENDING",
  "paymentStatus": "UNPAID",
  "paymentMethod": "paymentMethod",
  "fulfillmentStatus": "UNFULFILLED",
  "shippingAddress": {},
  "billingAddress": {},
  "customerNote": "customerNote",
  "internalNote": "internalNote",
  "metadata": {},
  "confirmationStatus": "UNCONFIRMED",
  "confirmationChannel": "confirmationChannel",
  "trackingNumber": "trackingNumber",
  "trackingCarrier": "trackingCarrier",
  "trackingUrl": "trackingUrl",
  "cancellationReason": "cancellationReason",
  "refundReason": "refundReason",
  "refundAmount": 1
}'

DELETE/api/v1/orders/{id}orders:write

Delete an order

Requires orders:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/orders/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/orders/{id}/statusorders:write

Change order status

Requires orders:write permission.

Path parameters

idrequired string

Body

`status`required	`PENDING \| CONFIRMED \| PROCESSING \| COMPLETED \| CANCELLED \| REFUNDED`	New order status.
`cancellationReason`	`string`	Reason for cancellation, stored when status is CANCELLED.

curl -X PATCH "https://api.inboxy.chat/api/v1/orders/{id}/status" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "CONFIRMED",
  "cancellationReason": "cancellationReason"
}'

PATCH/api/v1/orders/{id}/paymentorders:write

Change payment status

Requires orders:write permission.

Path parameters

idrequired string

Body

`paymentStatus`	`UNPAID \| PARTIALLY_PAID \| PAID \| REFUNDED`	New payment status. Setting PAID auto-captures the token owner as paidByUserId.
`paymentMethod`	`string`	Payment method used.

curl -X PATCH "https://api.inboxy.chat/api/v1/orders/{id}/payment" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "paymentStatus": "PAID",
  "paymentMethod": "card"
}'

PATCH/api/v1/orders/{id}/fulfillmentorders:write

Change fulfillment status

Requires orders:write permission.

Path parameters

idrequired string

Body

`fulfillmentStatus`required	`UNFULFILLED \| PARTIALLY_FULFILLED \| SHIPPED \| DELIVERED \| FULFILLED \| RETURNED`	New fulfillment status.
`trackingNumber`	`string`	Shipment tracking number.
`trackingCarrier`	`string`	Shipment carrier name.
`trackingUrl`	`string`	Shipment tracking URL.

curl -X PATCH "https://api.inboxy.chat/api/v1/orders/{id}/fulfillment" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "fulfillmentStatus": "SHIPPED",
  "trackingNumber": "trackingNumber",
  "trackingCarrier": "Aramex",
  "trackingUrl": "trackingUrl"
}'

PATCH/api/v1/orders/{id}/confirmationorders:write

Set the order confirmation status

Requires orders:write permission.

Path parameters

idrequired string

Body

`confirmationStatus`required	`UNCONFIRMED \| PENDING_CONFIRMATION \| CONFIRMED \| FAILED \| CANCELLED_BY_CUSTOMER`
`confirmationChannel`	`string`
`confirmationMessageId`	`string`

curl -X PATCH "https://api.inboxy.chat/api/v1/orders/{id}/confirmation" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "confirmationStatus": "CONFIRMED",
  "confirmationChannel": "whatsapp",
  "confirmationMessageId": "confirmationMessageId"
}'

POST/api/v1/orders/{id}/push-to-platformorders:write

Push an Inboxy-created order to the connected store (Shopify, Salla, WooCommerce)

Requires orders:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/orders/{id}/push-to-platform" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/orders/{id}/messagesorders:read

Messages linked to an order

Requires orders:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/orders/{id}/messages" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/orders/{id}/messagesorders:write

Link a message to an order

Requires orders:write permission.

Path parameters

idrequired string

Body

`messageId`required	`string`
`type`required	`CONFIRMATION \| STATUS_UPDATE \| PAYMENT_REMINDER \| SHIPPING_UPDATE \| CUSTOM`
`metadata`	`object`

curl -X POST "https://api.inboxy.chat/api/v1/orders/{id}/messages" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "messageId": "messageId",
  "type": "SHIPPING_UPDATE",
  "metadata": {}
}'

GET/api/v1/orders/{id}/confirmation-threadorders:read

The WhatsApp confirmation exchange for an order

Requires orders:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/orders/{id}/confirmation-thread" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/ordersorders:read

List orders

Get a paginated list of orders with filters. Requires orders:read permission.

Query parameters

`page`	`integer`
`pageSize`	`integer`
`status`	`string`	Filter by order status
`dateAfter`	`string`	Orders created after this date
`dateBefore`	`string`	Orders created before this date
`search`	`string`	Search by order number or customer name

curl -X GET "https://api.inboxy.chat/api/v1/public/orders" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/orders/{id}orders:read

Get order by ID

Get a single order with line items. Requires orders:read permission.

Path parameters

idrequired string Resource ID

curl -X GET "https://api.inboxy.chat/api/v1/public/orders/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Products and services

GET/api/v1/catalog-cardsproducts:read

List catalog cards (products and services ready to send)

Requires products:read permission.

Query parameters

`itemType`	`product \| service`
`search`	`string`
`page`	`integer`	Page number (24 cards per page).
`language`	`ar \| en`

curl -X GET "https://api.inboxy.chat/api/v1/catalog-cards" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/catalog-cards/statusproducts:read

Store sync state and card readiness

Requires products:read permission.

Query parameters

itemType product | service

curl -X GET "https://api.inboxy.chat/api/v1/catalog-cards/status" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/catalog-cards/syncproducts:write

Sync the catalog from a connected store

Requires products:write permission.

Body

platformrequired shopify | salla | zid | woocommerce | easy-orders

curl -X POST "https://api.inboxy.chat/api/v1/catalog-cards/sync" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "platform": "shopify"
}'

GET/api/v1/catalog-cards/{itemType}/{itemId}products:read

Preview one catalog card

Requires products:read permission.

Path parameters

`itemType`required	`string`
`itemId`required	`string`

Query parameters

language ar | en

curl -X GET "https://api.inboxy.chat/api/v1/catalog-cards/{itemType}/{itemId}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/catalog-cards/send/whatsappmessages:send

Send a catalog card on WhatsApp

Requires messages:send permission.

Body

`itemType`required	`product \| service`
`itemId`required	`string`
`language`required	`ar \| en`
`conversationId`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/catalog-cards/send/whatsapp" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "itemType": "product",
  "itemId": "itemId",
  "language": "ar",
  "conversationId": "conversationId"
}'

POST/api/v1/catalog-cards/send/messengermessages:send

Send a catalog card on Messenger

Requires messages:send permission.

Body

`itemType`required	`product \| service`
`itemId`required	`string`
`language`required	`ar \| en`
`conversationId`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/catalog-cards/send/messenger" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "itemType": "product",
  "itemId": "itemId",
  "language": "ar",
  "conversationId": "conversationId"
}'

POST/api/v1/catalog-cards/send/instagrammessages:send

Send a catalog card on Instagram

Requires messages:send permission.

Body

`itemType`required	`product \| service`
`itemId`required	`string`
`language`required	`ar \| en`
`conversationId`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/catalog-cards/send/instagram" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "itemType": "product",
  "itemId": "itemId",
  "language": "ar",
  "conversationId": "conversationId"
}'

POST/api/v1/catalog-cards/send/webmessages:send

Send a catalog card in the website chat

Requires messages:send permission.

Body

`itemType`required	`product \| service`
`itemId`required	`string`
`language`required	`ar \| en`
`conversationId`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/catalog-cards/send/web" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "itemType": "product",
  "itemId": "itemId",
  "language": "ar",
  "conversationId": "conversationId"
}'

POST/api/v1/catalog-cards/send/telegrammessages:send

Send a catalog card on Telegram

Requires messages:send permission.

Body

`itemType`required	`product \| service`
`itemId`required	`string`
`language`required	`ar \| en`
`conversationId`required	`string`

curl -X POST "https://api.inboxy.chat/api/v1/catalog-cards/send/telegram" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "itemType": "product",
  "itemId": "itemId",
  "language": "ar",
  "conversationId": "conversationId"
}'

GET/api/v1/products/statsproducts:read

Product statistics

Requires products:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/products/stats" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/products/mergeproducts:write

Merge a duplicate product into another

Requires products:write permission.

Body

`keepId`required	`string`	Product to keep.
`deleteId`required	`string`	Duplicate to delete; its references move to keepId.

curl -X POST "https://api.inboxy.chat/api/v1/products/merge" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "keepId": "keepId",
  "deleteId": "deleteId"
}'

POST/api/v1/products/import-from-url/saveproducts:write

Save extracted products

Requires products:write permission.

Body

`products`required	`object[]`
`defaultCurrency`	`string`

curl -X POST "https://api.inboxy.chat/api/v1/products/import-from-url/save" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "products": [
    {
      "name": "Wireless charger",
      "description": "description",
      "price": 129.99,
      "currency": "SAR",
      "imageUrl": "imageUrl"
    }
  ],
  "defaultCurrency": "SAR"
}'

PUT/api/v1/products/categories/{id}products:write

Update a product category

Requires products:write permission.

Path parameters

idrequired string

curl -X PUT "https://api.inboxy.chat/api/v1/products/categories/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

DELETE/api/v1/products/categories/{id}products:write

Delete a product category

Requires products:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/products/categories/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/productsproducts:read

List products

Requires products:read permission.

Query parameters

`search`	`string`	Name or SKU.
`categoryId`	`string`
`isActive`	`boolean`	Filter by active state.
`externalSource`	`string`
`page`	`integer`	Page number (default 1).
`limit`	`integer`
`sortBy`	`string`
`sortOrder`	`asc \| desc`	Sort direction.

curl -X GET "https://api.inboxy.chat/api/v1/products" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/products/{id}products:read

Get a product

Requires products:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/products/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/services/statsproducts:read

Service statistics

Requires products:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/services/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/services/categoriesproducts:read

List service categories

Requires products:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/services/categories" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/services/categoriesproducts:write

Create a service category

Requires products:write permission.

Body

`name`required	`string`
`description`	`string`
`sortOrder`	`number`

curl -X POST "https://api.inboxy.chat/api/v1/services/categories" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "sortOrder": 1
}'

PUT/api/v1/services/categories/{id}products:write

Update a service category

Requires products:write permission.

Path parameters

idrequired string

Body

`name`required	`string`
`description`	`string`
`sortOrder`	`number`

curl -X PUT "https://api.inboxy.chat/api/v1/services/categories/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "sortOrder": 1
}'

DELETE/api/v1/services/categories/{id}products:write

Delete a service category

Requires products:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/services/categories/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/servicesproducts:read

List services

Requires products:read permission.

Query parameters

`search`	`string`
`categoryId`	`string`
`isActive`	`boolean`	Filter by active state.
`page`	`integer`	Page number (default 1).
`limit`	`integer`
`sortBy`	`string`
`sortOrder`	`asc \| desc`	Sort direction.

curl -X GET "https://api.inboxy.chat/api/v1/services" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/servicesproducts:write

Create a service

Requires products:write permission.

Body

`name`required	`string`
`price`required	`number`
`description`	`string`
`currency`	`string`
`images`	`string[]`
`isActive`	`boolean`
`duration`	`number \| null`	Minutes.
`categoryId`	`string`
`newCategoryName`	`string`	Create a category with this name instead of categoryId.
`metadata`	`object`

curl -X POST "https://api.inboxy.chat/api/v1/services" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Home cleaning (2h)",
  "price": 199,
  "description": "description",
  "currency": "SAR",
  "images": [
    "images"
  ],
  "isActive": true,
  "duration": 1,
  "categoryId": "categoryId",
  "newCategoryName": "newCategoryName",
  "metadata": {}
}'

GET/api/v1/services/{id}products:read

Get a service

Requires products:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/services/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/services/{id}products:write

Update a service

Requires products:write permission.

Path parameters

idrequired string

Body

`name`	`string`
`price`	`number`
`description`	`string`
`currency`	`string`
`images`	`string[]`
`isActive`	`boolean`
`duration`	`number \| null`	Minutes.
`categoryId`	`string`
`newCategoryName`	`string`	Create a category with this name instead of categoryId.
`metadata`	`object`

curl -X PUT "https://api.inboxy.chat/api/v1/services/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Home cleaning (2h)",
  "price": 199,
  "description": "description",
  "currency": "SAR",
  "images": [
    "images"
  ],
  "isActive": true,
  "duration": 1,
  "categoryId": "categoryId",
  "newCategoryName": "newCategoryName",
  "metadata": {}
}'

DELETE/api/v1/services/{id}products:write

Delete a service

Requires products:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/services/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Products

GET/api/v1/products/categoriesproducts:read

List product categories

Requires products:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/products/categories" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/products/categoriesproducts:write

Create a product category

Requires products:write permission.

Body

`name`required	`string`	Category name.
`description`	`string`	Category description.
`sortOrder`	`number`	Sort order among categories.

curl -X POST "https://api.inboxy.chat/api/v1/products/categories" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Electronics",
  "description": "description",
  "sortOrder": 1
}'

POST/api/v1/productsproducts:write

Create a product

Requires products:write permission.

Body

`name`required	`string`	Product name.
`price`required	`number`	Price in the product currency.
`description`	`string`	Product description.
`sku`	`string`	Stock keeping unit. Must be unique per company.
`currency`	`string`	ISO currency code.
`images`	`string[]`	Image URLs.
`isActive`	`boolean`	Whether the product is active/visible. Defaults to true.
`stockQuantity`	`number`	Stock on hand, or null for unlimited/untracked.
`categoryId`	`string`	Existing category ID.
`newCategoryName`	`string`	Create a new category with this name instead of using categoryId.

curl -X POST "https://api.inboxy.chat/api/v1/products" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Wireless Charger",
  "price": 129.99,
  "description": "description",
  "sku": "sku",
  "currency": "SAR",
  "images": [
    "images"
  ],
  "isActive": true,
  "stockQuantity": 1,
  "categoryId": "categoryId",
  "newCategoryName": "newCategoryName"
}'

PUT/api/v1/products/{id}products:write

Update a product

Requires products:write permission.

Path parameters

idrequired string

Body

`name`	`string`	Product name.
`price`	`number`	Price in the product currency.
`description`	`string`	Product description.
`sku`	`string`	Stock keeping unit. Must be unique per company.
`currency`	`string`	ISO currency code.
`images`	`string[]`	Image URLs.
`isActive`	`boolean`	Whether the product is active/visible. Defaults to true.
`stockQuantity`	`number`	Stock on hand, or null for unlimited/untracked.
`categoryId`	`string`	Existing category ID.
`newCategoryName`	`string`	Create a new category with this name instead of using categoryId.

curl -X PUT "https://api.inboxy.chat/api/v1/products/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Wireless Charger",
  "price": 129.99,
  "description": "description",
  "sku": "sku",
  "currency": "SAR",
  "images": [
    "images"
  ],
  "isActive": true,
  "stockQuantity": 1,
  "categoryId": "categoryId",
  "newCategoryName": "newCategoryName"
}'

DELETE/api/v1/products/{id}products:write

Delete a product

Requires products:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/products/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/productsproducts:read

List products

Get a paginated list of products from the catalog. Requires products:read permission.

Query parameters

`page`	`integer`
`pageSize`	`integer`
`search`	`string`	Search by product name or SKU
`categoryId`	`string`	Filter by category ID
`isActive`	`boolean`	Filter by active status

curl -X GET "https://api.inboxy.chat/api/v1/public/products" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/products/{id}products:read

Get product by ID

Get a single product with full details. Requires products:read permission.

Path parameters

idrequired string Resource ID

curl -X GET "https://api.inboxy.chat/api/v1/public/products/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Web events

GET/api/v1/web-eventsautomations:read

List web event integrations

Requires automations:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/web-events" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/web-eventsautomations:write

Create an integration your website posts events to

Requires automations:write permission.

Body

`name`required	`string`
`description`	`string`
`authType`required	`HMAC_SHA256 \| API_KEY`	How your site authenticates when it posts events to POST /api/webhook/web-events/:integrationId — an `X-Webhook-Signature` HMAC-SHA256 of the raw body, or the secret in `X-Api-Key`. The secret is shown in the dashboard.
`autoCreateContact`	`boolean`	Create a contact when an event matches none.
`contactMapping`	`object`	`{ phoneField, emailField, nameField?, autoCreate, enrichFields?, displayColumns? }` — which JSON fields identify the contact.
`isEnabled`	`boolean`	Update only.

curl -X POST "https://api.inboxy.chat/api/v1/web-events" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Landing page form",
  "description": "description",
  "authType": "HMAC_SHA256",
  "autoCreateContact": true,
  "contactMapping": {
    "phoneField": "customer.phone",
    "emailField": "customer.email",
    "nameField": "customer.name",
    "autoCreate": true
  },
  "isEnabled": true
}'

GET/api/v1/web-events/{id}automations:read

Get a web event integration

Requires automations:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/web-events/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/web-events/{id}automations:write

Update an integration

Requires automations:write permission.

Path parameters

idrequired string

Body

`name`required	`string`
`description`	`string`
`authType`required	`HMAC_SHA256 \| API_KEY`	How your site authenticates when it posts events to POST /api/webhook/web-events/:integrationId — an `X-Webhook-Signature` HMAC-SHA256 of the raw body, or the secret in `X-Api-Key`. The secret is shown in the dashboard.
`autoCreateContact`	`boolean`	Create a contact when an event matches none.
`contactMapping`	`object`	`{ phoneField, emailField, nameField?, autoCreate, enrichFields?, displayColumns? }` — which JSON fields identify the contact.
`isEnabled`	`boolean`	Update only.

curl -X PUT "https://api.inboxy.chat/api/v1/web-events/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Landing page form",
  "description": "description",
  "authType": "HMAC_SHA256",
  "autoCreateContact": true,
  "contactMapping": {
    "phoneField": "customer.phone",
    "emailField": "customer.email",
    "nameField": "customer.name",
    "autoCreate": true
  },
  "isEnabled": true
}'

DELETE/api/v1/web-events/{id}automations:write

Delete an integration

Requires automations:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/web-events/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/web-events/{id}/toggleautomations:write

Enable or disable an integration

Requires automations:write permission.

Path parameters

idrequired string

curl -X PATCH "https://api.inboxy.chat/api/v1/web-events/{id}/toggle" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/web-events/{id}/event-typesautomations:write

Declare an event type

Requires automations:write permission.

Path parameters

idrequired string

Body

`name`required	`string`
`description`	`string`
`fieldSchema`	`object`	Expected payload fields, for variable pickers.

curl -X POST "https://api.inboxy.chat/api/v1/web-events/{id}/event-types" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "signup_completed",
  "description": "description",
  "fieldSchema": {}
}'

DELETE/api/v1/web-events/{id}/event-types/{typeId}automations:write

Remove an event type

Requires automations:write permission.

Path parameters

`id`required	`string`
`typeId`required	`string`

curl -X DELETE "https://api.inboxy.chat/api/v1/web-events/{id}/event-types/{typeId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/web-events/{id}/logsautomations:read

List received events

Requires automations:read permission.

Path parameters

idrequired string

Query parameters

`page`	`integer`	Page number (default 1).
`limit`	`integer`	Up to 100 (default 50).
`status`	`RECEIVED \| PROCESSING \| COMPLETED \| FAILED \| SKIPPED`
`startDate`	`string`	ISO date.
`endDate`	`string`	ISO date.

curl -X GET "https://api.inboxy.chat/api/v1/web-events/{id}/logs" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/web-events/{id}/logs/{logId}automations:read

Get one received event

Requires automations:read permission.

Path parameters

`id`required	`string`
`logId`required	`string`

curl -X GET "https://api.inboxy.chat/api/v1/web-events/{id}/logs/{logId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/web-events/{id}/variablesautomations:read

Variables this integration exposes to automations and templates

Requires automations:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/web-events/{id}/variables" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/web-events/{id}/testautomations:write

Send a test event through the integration

Requires automations:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/web-events/{id}/test" \
  -H "Authorization: Bearer inboxy_your_token"

Leads

GET/api/v1/leads/statsleads:read

Get lead pipeline stats

Requires leads:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/leads/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/leads/pipelineleads:read

Get the lead pipeline

Requires leads:read permission.

Query parameters

`search`	`string`
`label`	`string`
`assignedAgentId`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/leads/pipeline" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/leads/listleads:read

List leads (paginated table view)

Requires leads:read permission.

Query parameters

`page`	`integer`	Page number (default 1).
`limit`	`integer`
`search`	`string`	Name, email, company or phone.
`statusId`	`string`	Lead status id (GET /leads/statuses).
`priority`	`integer`	0 low … 3 urgent.
`assignedAgentId`	`string`
`source`	`string`

curl -X GET "https://api.inboxy.chat/api/v1/leads/list" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/leads/suggestleads:write

AI-suggest lead fields from a conversation

Requires leads:write permission.

Body

`conversationId`	`string`	Conversation to analyze. One of conversationId or contactId is required.
`contactId`	`string`	Contact whose latest conversation to analyze, if conversationId is omitted.

curl -X POST "https://api.inboxy.chat/api/v1/leads/suggest" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "conversationId": "conversationId",
  "contactId": "contactId"
}'

POST/api/v1/leads/{id}/moveleads:write

Move a lead to a stage

Requires leads:write permission.

Path parameters

idrequired string

Body

curl -X POST "https://api.inboxy.chat/api/v1/leads/{id}/move" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "stage": "QUALIFIED"
}'

POST/api/v1/leads/{id}/winleads:write

Mark a lead won

Requires leads:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/leads/{id}/win" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/leads/{id}/loseleads:write

Mark a lead lost

Requires leads:write permission.

Path parameters

idrequired string

Body

reason string Reason the lead was lost.

curl -X POST "https://api.inboxy.chat/api/v1/leads/{id}/lose" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "reason"
}'

POST/api/v1/leads/{id}/assignleads:write

Assign a lead

Requires leads:write permission.

Path parameters

idrequired string

Body

userId string User ID to assign the lead to, or null to unassign.

curl -X POST "https://api.inboxy.chat/api/v1/leads/{id}/assign" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "userId": "userId"
}'

GET/api/v1/leads/statusesleads:read

List lead statuses

Requires leads:read permission.

Query parameters

includeInactive boolean Include disabled statuses.

curl -X GET "https://api.inboxy.chat/api/v1/leads/statuses" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/leads/statusesleads:write

Create a lead status

Requires leads:write permission.

Body

`label`required	`string`	Status label (max 60 chars).
`labelAr`	`string`	Arabic label (max 60 chars), or null.
`color`	`string`	Hex color, e.g. #3bc1a8.
`bgColor`	`string`	Hex background color, or null.
`icon`	`string`	Icon identifier, or null.
`isQualified`	`boolean`	Whether this status counts as qualified.
`isFinal`	`boolean`	Whether this status is a terminal pipeline stage.

curl -X POST "https://api.inboxy.chat/api/v1/leads/statuses" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "Negotiating",
  "labelAr": "labelAr",
  "color": "#3bc1a8",
  "bgColor": "#dbeafe",
  "icon": "icon",
  "isQualified": true,
  "isFinal": true
}'

PATCH/api/v1/leads/statuses/reorderleads:write

Reorder lead statuses

Requires leads:write permission.

Body

orderedIdsrequired string[] Full ordered list of lead status IDs.

curl -X PATCH "https://api.inboxy.chat/api/v1/leads/statuses/reorder" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "orderedIds": [
    "orderedIds"
  ]
}'

PATCH/api/v1/leads/statuses/{statusId}leads:write

Update a lead status

Requires leads:write permission.

Path parameters

statusIdrequired string

Body

`label`	`string`	Status label (max 60 chars).
`labelAr`	`string`	Arabic label, or null.
`color`	`string`	Hex color.
`bgColor`	`string`	Hex background color, or null.
`icon`	`string`	Icon identifier, or null.
`isQualified`	`boolean`
`isFinal`	`boolean`
`isActive`	`boolean`

curl -X PATCH "https://api.inboxy.chat/api/v1/leads/statuses/{statusId}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "label": "label",
  "labelAr": "labelAr",
  "color": "color",
  "bgColor": "bgColor",
  "icon": "icon",
  "isQualified": true,
  "isFinal": true,
  "isActive": true
}'

DELETE/api/v1/leads/statuses/{statusId}leads:write

Delete a lead status

Requires leads:write permission.

Path parameters

statusIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/leads/statuses/{statusId}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/leads/{id}/statusleads:write

Set lead status

Requires leads:write permission.

Path parameters

idrequired string

Body

statusIdrequired string ID of one of the company's configured lead statuses (GET /leads/statuses).

curl -X PATCH "https://api.inboxy.chat/api/v1/leads/{id}/status" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "statusId": "statusId"
}'

PATCH/api/v1/leads/{id}/ratingleads:write

Set lead star rating

Requires leads:write permission.

Path parameters

idrequired string

Body

ratingrequired number 1-5, or null to clear.

curl -X PATCH "https://api.inboxy.chat/api/v1/leads/{id}/rating" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "rating": 5
}'

PATCH/api/v1/leads/{id}/priorityleads:write

Set lead priority

Requires leads:write permission.

Path parameters

idrequired string

Body

priorityrequired number 0 (low) to 3 (urgent), or null to clear.

curl -X PATCH "https://api.inboxy.chat/api/v1/leads/{id}/priority" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "priority": 2
}'

GET/api/v1/leads/{id}/feedbackleads:read

List the feedback thread on a lead

Requires leads:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/leads/{id}/feedback" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/leads/{id}/feedbackleads:write

Add a lead feedback entry

Requires leads:write permission.

Path parameters

idrequired string

Body

`body`required	`string`	Feedback text (max 5000 chars).
`rating`	`number`	1-5, optional.
`type`	`POSITIVE \| NEUTRAL \| NEGATIVE`	Defaults to NEUTRAL.

curl -X POST "https://api.inboxy.chat/api/v1/leads/{id}/feedback" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "body": "Very responsive, asked for a discount.",
  "rating": 1,
  "type": "POSITIVE"
}'

POST/api/v1/leads/{id}/follow-upleads:write

Schedule a lead follow-up task

Requires leads:write permission.

Path parameters

idrequired string

Body

`title`required	`string`	Follow-up task title.
`dueDate`required	`string`	Due date, ISO 8601.
`description`	`string`	Optional description.

curl -X POST "https://api.inboxy.chat/api/v1/leads/{id}/follow-up" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Call back about pricing",
  "dueDate": "dueDate",
  "description": "description"
}'

GET/api/v1/leads/{id}/follow-upsleads:read

List lead follow-up tasks

Requires leads:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/leads/{id}/follow-ups" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/leads/{id}leads:read

Get a lead

Requires leads:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/leads/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/leadsleads:read

List leads

Get a paginated list of leads (contacts in LEAD lifecycle stage). Requires leads:read permission.

Query parameters

`page`	`integer`
`pageSize`	`integer`
`stage`	`string`	Filter by pipeline stage (e.g., NEW, QUALIFIED, PROPOSAL)
`search`	`string`	Search by name, phone, or email

curl -X GET "https://api.inboxy.chat/api/v1/public/leads" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/leads/{id}leads:read

Get lead by ID

Get a single lead with assigned agent, follow-up tasks, and counts. Requires leads:read permission.

Path parameters

idrequired string Resource ID

curl -X GET "https://api.inboxy.chat/api/v1/public/leads/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Media

GET/api/v1/medialibrary:read

List media library files

Requires library:read permission.

Query parameters

`type`	`IMAGE \| VIDEO \| DOCUMENT \| AUDIO`
`search`	`string`	File name.
`page`	`integer`	Page number (default 1).
`limit`	`integer`
`sort`	`createdAt \| name \| size \| usageCount`
`order`	`asc \| desc`	Sort direction.

curl -X GET "https://api.inboxy.chat/api/v1/media" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/media/statslibrary:read

Get media library stats

Requires library:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/media/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/media/{id}library:read

Get a media file

Requires library:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/media/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/media/{id}library:write

Rename a media file or set its AI-accessibility

Requires library:write permission.

Path parameters

idrequired string

Body

`name`	`string`	Display name.
`aiAccessible`	`boolean`	Whether the AI agent may reference this file.
`aiDescription`	`string`	Description shown to the AI agent, or null to clear.

curl -X PUT "https://api.inboxy.chat/api/v1/media/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "aiAccessible": true,
  "aiDescription": "aiDescription"
}'

DELETE/api/v1/media/{id}library:write

Delete a media file

Requires library:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/media/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/media/bulk-deletelibrary:write

Bulk delete media files

Requires library:write permission.

Body

idsrequired string[] Media IDs to delete.

curl -X POST "https://api.inboxy.chat/api/v1/media/bulk-delete" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "ids": [
    "ids"
  ]
}'

POST/api/v1/media/{id}/uselibrary:write

Record media file usage

Requires library:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/media/{id}/use" \
  -H "Authorization: Bearer inboxy_your_token"

Tasks

GET/api/v1/taskstasks:read

List tasks

Requires tasks:read permission.

Query parameters

`status`	`TODO \| IN_PROGRESS \| COMPLETED \| CANCELLED`
`type`	`FOLLOW_UP \| CALLBACK \| SEND_INFO \| ORDER_INQUIRY \| SUPPORT \| OTHER \| SALES \| ONBOARDING \| FEEDBACK \| REMINDER`
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`
`limit`	`integer`	Page size (default 50).
`offset`	`integer`	Rows to skip (default 0).
`assignedToId`	`string`
`contactId`	`string`
`conversationId`	`string`
`source`	`MANUAL \| AI \| AUTOMATION`
`dueDateFrom`	`string`	ISO date-time.
`dueDateTo`	`string`	ISO date-time.
`search`	`string`	Title.

curl -X GET "https://api.inboxy.chat/api/v1/tasks" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/taskstasks:write

Create a task

Requires tasks:write permission.

Body

`title`required	`string`	Task title.
`description`	`string`	Task description.
`type`	`FOLLOW_UP \| CALLBACK \| SEND_INFO \| ORDER_INQUIRY \| SUPPORT \| OTHER \| SALES \| ONBOARDING \| FEEDBACK \| REMINDER`	Task type.
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`	Task priority. Defaults to NORMAL.
`contactId`	`string`	Contact this task relates to, or null to clear.
`conversationId`	`string`	Conversation this task originated from, or null to clear.
`assignedToId`	`string`	User ID to assign the task to, or null to unassign.
`dueDate`	`string`	Due date, ISO 8601, or null to clear.
`reminderAt`	`string`	Reminder time, ISO 8601, or null to clear.
`recurrence`	`NONE \| DAILY \| WEEKLY \| MONTHLY`	Recurrence rule, or null for a one-off task.
`source`	`MANUAL \| AI \| AUTOMATION`	Where the task came from. Defaults to MANUAL.

curl -X POST "https://api.inboxy.chat/api/v1/tasks" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Follow up on invoice #4521",
  "description": "description",
  "type": "FOLLOW_UP",
  "priority": "NORMAL",
  "contactId": "contactId",
  "conversationId": "conversationId",
  "assignedToId": "assignedToId",
  "dueDate": "dueDate",
  "reminderAt": "reminderAt",
  "recurrence": "NONE",
  "source": "MANUAL"
}'

GET/api/v1/tasks/statstasks:read

Get task stats

Requires tasks:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/tasks/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tasks/mytasks:read

List tasks assigned to the token owner

Requires tasks:read permission.

Query parameters

`status`	`TODO \| IN_PROGRESS \| COMPLETED \| CANCELLED`
`type`	`FOLLOW_UP \| CALLBACK \| SEND_INFO \| ORDER_INQUIRY \| SUPPORT \| OTHER \| SALES \| ONBOARDING \| FEEDBACK \| REMINDER`
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`
`limit`	`integer`	Page size (default 50).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/tasks/my" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tasks/contact/{contactId}tasks:read

List tasks for a contact

Requires tasks:read permission.

Path parameters

contactIdrequired string

Query parameters

`status`	`TODO \| IN_PROGRESS \| COMPLETED \| CANCELLED`
`type`	`FOLLOW_UP \| CALLBACK \| SEND_INFO \| ORDER_INQUIRY \| SUPPORT \| OTHER \| SALES \| ONBOARDING \| FEEDBACK \| REMINDER`
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`
`limit`	`integer`	Page size (default 50).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/tasks/contact/{contactId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tasks/{id}tasks:read

Get a task

Requires tasks:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/tasks/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/tasks/{id}tasks:write

Update a task

Requires tasks:write permission.

Path parameters

idrequired string

Body

`title`	`string`	Task title. Cannot be set to empty.
`description`	`string`	Task description.
`type`	`FOLLOW_UP \| CALLBACK \| SEND_INFO \| ORDER_INQUIRY \| SUPPORT \| OTHER \| SALES \| ONBOARDING \| FEEDBACK \| REMINDER`	Task type.
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`	Task priority. Defaults to NORMAL.
`contactId`	`string`	Contact this task relates to, or null to clear.
`conversationId`	`string`	Conversation this task originated from, or null to clear.
`assignedToId`	`string`	User ID to assign the task to, or null to unassign.
`dueDate`	`string`	Due date, ISO 8601, or null to clear.
`reminderAt`	`string`	Reminder time, ISO 8601, or null to clear.
`recurrence`	`NONE \| DAILY \| WEEKLY \| MONTHLY`	Recurrence rule, or null for a one-off task.
`status`	`TODO \| IN_PROGRESS \| COMPLETED \| CANCELLED`	Task status.

curl -X PUT "https://api.inboxy.chat/api/v1/tasks/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "title",
  "description": "description",
  "type": "FOLLOW_UP",
  "priority": "NORMAL",
  "contactId": "contactId",
  "conversationId": "conversationId",
  "assignedToId": "assignedToId",
  "dueDate": "dueDate",
  "reminderAt": "reminderAt",
  "recurrence": "NONE",
  "status": "IN_PROGRESS"
}'

DELETE/api/v1/tasks/{id}tasks:write

Delete a task

Requires tasks:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/tasks/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/tasks/{id}/completetasks:write

Mark a task complete

Requires tasks:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/tasks/{id}/complete" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/tasks/{id}/assigntasks:write

Assign a task

Requires tasks:write permission.

Path parameters

idrequired string

Body

assignedToId string User ID to assign the task to, or null to unassign.

curl -X POST "https://api.inboxy.chat/api/v1/tasks/{id}/assign" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "assignedToId": "assignedToId"
}'

GET/api/v1/tasks/{id}/subtaskstasks:read

List checklist items on a task

Requires tasks:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/tasks/{id}/subtasks" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/tasks/{id}/subtaskstasks:write

Add a checklist item to a task

Requires tasks:write permission.

Path parameters

idrequired string

Body

titlerequired string Checklist item text.

curl -X POST "https://api.inboxy.chat/api/v1/tasks/{id}/subtasks" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "Confirm shipping address"
}'

PATCH/api/v1/tasks/subtasks/{subtaskId}tasks:write

Toggle a checklist item

Requires tasks:write permission.

Path parameters

subtaskIdrequired string

Body

done boolean Whether the checklist item is done. Defaults to false.

curl -X PATCH "https://api.inboxy.chat/api/v1/tasks/subtasks/{subtaskId}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "done": true
}'

DELETE/api/v1/tasks/subtasks/{subtaskId}tasks:write

Delete a checklist item

Requires tasks:write permission.

Path parameters

subtaskIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/tasks/subtasks/{subtaskId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tasks/{id}/commentstasks:read

List task comments

Requires tasks:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/tasks/{id}/comments" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/tasks/{id}/commentstasks:write

Add a task comment

Requires tasks:write permission.

Path parameters

idrequired string

Body

contentrequired string Comment text.

curl -X POST "https://api.inboxy.chat/api/v1/tasks/{id}/comments" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "Called the client, waiting on approval."
}'

Tickets

GET/api/v1/ticketstickets:read

List tickets

Requires tickets:read permission.

Query parameters

`status`	`OPEN \| IN_PROGRESS \| CLOSED`
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`
`limit`	`integer`	Page size (default 20).
`offset`	`integer`	Rows to skip (default 0).
`type`	`string`	Ticket type (GET /tickets/types).
`assignedToId`	`string`
`contactId`	`string`
`search`	`string`	Subject.

curl -X GET "https://api.inboxy.chat/api/v1/tickets" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/ticketstickets:write

Create a ticket

Requires tickets:write permission.

Body

`subject`required	`string`	Ticket subject.
`description`	`string`	Ticket description.
`type`	`string`	Ticket type slug (see GET /tickets/types), e.g. "order".
`typeId`	`string`	Ticket type ID (see GET /tickets/types).
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`	Ticket priority. Defaults to NORMAL.
`contactId`	`string`	Contact this ticket is about.
`assignedToId`	`string`	User ID to assign the ticket to.
`conversationId`	`string`	Conversation this ticket originated from.
`dueDate`	`string`	Due date, ISO 8601.
`source`	`string`	Where the ticket came from.
`tags`	`string[]`	Free-text tags.
`phone`	`string`	Contact phone number, used to find/create a contact when contactId is not supplied. One of contactId or phone is required.

curl -X POST "https://api.inboxy.chat/api/v1/tickets" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "Order #1042 arrived damaged",
  "description": "description",
  "type": "order",
  "typeId": "typeId",
  "priority": "NORMAL",
  "contactId": "contactId",
  "assignedToId": "assignedToId",
  "conversationId": "conversationId",
  "dueDate": "dueDate",
  "source": "source",
  "tags": [
    "tags"
  ],
  "phone": "966500000000"
}'

GET/api/v1/tickets/statstickets:read

Get ticket stats

Requires tickets:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/tickets/stats" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tickets/mytickets:read

List tickets assigned to the token owner

Requires tickets:read permission.

Query parameters

`status`	`OPEN \| IN_PROGRESS \| CLOSED`
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`
`limit`	`integer`	Page size (default 20).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/tickets/my" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tickets/contact/{contactId}tickets:read

List tickets for a contact

Requires tickets:read permission.

Path parameters

contactIdrequired string

Query parameters

`status`	`OPEN \| IN_PROGRESS \| CLOSED`
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`
`limit`	`integer`	Page size (default 20).
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/tickets/contact/{contactId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tickets/typestickets:read

List ticket types

Requires tickets:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/tickets/types" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/tickets/typestickets:write

Create a ticket type

Requires tickets:write permission.

Body

`name`required	`string`	Ticket type name.
`color`	`string`	Display color.
`icon`	`string`	Icon identifier.
`isActive`	`boolean`	Defaults to true.

curl -X POST "https://api.inboxy.chat/api/v1/tickets/types" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Warranty claim",
  "color": "color",
  "icon": "icon",
  "isActive": true
}'

PUT/api/v1/tickets/types/{typeId}tickets:write

Update a ticket type

Requires tickets:write permission.

Path parameters

typeIdrequired string

Body

`name`	`string`	Ticket type name.
`color`	`string`	Display color.
`icon`	`string`	Icon identifier.
`isActive`	`boolean`
`order`	`number`	Sort order.

curl -X PUT "https://api.inboxy.chat/api/v1/tickets/types/{typeId}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "color": "color",
  "icon": "icon",
  "isActive": true,
  "order": 1
}'

DELETE/api/v1/tickets/types/{typeId}tickets:write

Delete a ticket type

Requires tickets:write permission.

Path parameters

typeIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/tickets/types/{typeId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tickets/{id}tickets:read

Get a ticket

Requires tickets:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/tickets/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/tickets/{id}tickets:write

Update a ticket

Requires tickets:write permission.

Path parameters

idrequired string

Body

`subject`	`string`	Ticket subject.
`description`	`string`	Ticket description.
`type`	`string`	Ticket type slug (see GET /tickets/types), e.g. "order".
`typeId`	`string`	Ticket type ID (see GET /tickets/types).
`priority`	`LOW \| NORMAL \| HIGH \| URGENT`	Ticket priority. Defaults to NORMAL.
`contactId`	`string`	Contact this ticket is about.
`assignedToId`	`string`	User ID to assign the ticket to.
`conversationId`	`string`	Conversation this ticket originated from.
`dueDate`	`string`	Due date, ISO 8601.
`source`	`string`	Where the ticket came from.
`tags`	`string[]`	Free-text tags.
`status`	`OPEN \| IN_PROGRESS \| CLOSED`	Ticket status.

curl -X PUT "https://api.inboxy.chat/api/v1/tickets/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "subject": "Order #1042 arrived damaged",
  "description": "description",
  "type": "order",
  "typeId": "typeId",
  "priority": "NORMAL",
  "contactId": "contactId",
  "assignedToId": "assignedToId",
  "conversationId": "conversationId",
  "dueDate": "dueDate",
  "source": "source",
  "tags": [
    "tags"
  ],
  "status": "OPEN"
}'

DELETE/api/v1/tickets/{id}tickets:write

Delete a ticket

Requires tickets:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/tickets/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PATCH/api/v1/tickets/{id}/statustickets:write

Change ticket status

Requires tickets:write permission.

Path parameters

idrequired string

Body

statusrequired OPEN | IN_PROGRESS | CLOSED New ticket status.

curl -X PATCH "https://api.inboxy.chat/api/v1/tickets/{id}/status" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "status": "IN_PROGRESS"
}'

POST/api/v1/tickets/{id}/assigntickets:write

Assign a ticket

Requires tickets:write permission.

Path parameters

idrequired string

Body

assignedToId string User ID to assign the ticket to, or null to unassign.

curl -X POST "https://api.inboxy.chat/api/v1/tickets/{id}/assign" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "assignedToId": "assignedToId"
}'

POST/api/v1/tickets/{id}/closetickets:write

Close a ticket

Requires tickets:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/tickets/{id}/close" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tickets/{id}/commentstickets:read

List ticket comments

Requires tickets:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/tickets/{id}/comments" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/tickets/{id}/commentstickets:write

Comment on a ticket

Requires tickets:write permission.

Path parameters

idrequired string

Body

`content`required	`string`	Comment text.
`isInternal`	`boolean`	Internal-only comment, hidden from the customer. Defaults to false.

curl -X POST "https://api.inboxy.chat/api/v1/tickets/{id}/comments" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "content": "content",
  "isInternal": true
}'

GET/api/v1/tickets/{id}/attachmentstickets:read

List ticket attachments

Requires tickets:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/tickets/{id}/attachments" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/tickets/{id}/attachmentstickets:write

Add a ticket attachment (URL reference, not an upload)

Requires tickets:write permission.

Path parameters

idrequired string

Body

`url`required	`string`	File URL, already uploaded elsewhere (e.g. the media library).
`name`required	`string`	Original file name.
`mimeType`	`string`	MIME type.
`size`	`number`	File size in bytes.

curl -X POST "https://api.inboxy.chat/api/v1/tickets/{id}/attachments" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "url": "https://cdn.inboxy.chat/files/invoice.pdf",
  "name": "invoice.pdf",
  "mimeType": "application/pdf",
  "size": 1
}'

DELETE/api/v1/tickets/attachments/{attachmentId}tickets:write

Delete a ticket attachment

Requires tickets:write permission.

Path parameters

attachmentIdrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/tickets/attachments/{attachmentId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/tickets/{id}/activitytickets:read

Get the ticket audit trail

Requires tickets:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/tickets/{id}/activity" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/ticketstickets:read

List tickets

Get a paginated list of support tickets with filters. Requires tickets:read permission.

Query parameters

`page`	`integer`
`pageSize`	`integer`
`status`	`string`	Filter by ticket status (open, in_progress, resolved, closed)
`type`	`string`	Filter by ticket type
`priority`	`string`	Filter by priority (low, medium, high, urgent)
`assignedToId`	`string`	Filter by assigned agent ID

curl -X GET "https://api.inboxy.chat/api/v1/public/tickets" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/public/tickets/{id}tickets:read

Get ticket by ID

Get a single support ticket with comments. Requires tickets:read permission.

Path parameters

idrequired string Resource ID

curl -X GET "https://api.inboxy.chat/api/v1/public/tickets/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

Meetings

POST/api/v1/meetingsmeetings:write

Create a meeting

Requires meetings:write permission.

Body

`reason`required	`string`	Meeting reason/title.
`type`required	`ONLINE \| OFFLINE`	Meeting type.
`startTime`required	`string`	Start time, ISO 8601 UTC.
`startTimeLocal`required	`string`	Start time as picked locally (no TZ offset), ISO 8601.
`timezone`required	`string`	IANA timezone identifier.
`durationMinutes`required	`number`	Duration in minutes.
`contactId`	`string`	Associated contact.
`link`	`string`	Meeting link, for ONLINE meetings.
`location`	`string`	Physical location, for OFFLINE meetings.
`notes`	`string`	Free-text notes.
`attendees`	`object[]`	Team members and/or external attendees.

curl -X POST "https://api.inboxy.chat/api/v1/meetings" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "Product demo",
  "type": "ONLINE",
  "startTime": "2026-09-20T10:00:00.000Z",
  "startTimeLocal": "2026-09-20T13:00:00",
  "timezone": "Asia/Riyadh",
  "durationMinutes": 30,
  "contactId": "contactId",
  "link": "link",
  "location": "location",
  "notes": "notes",
  "attendees": [
    {
      "type": "TEAM",
      "userId": "userId",
      "name": "name",
      "email": "customer@example.com",
      "phone": "966500000000"
    }
  ]
}'

GET/api/v1/meetings/weekmeetings:read

List meetings in a calendar week

Requires meetings:read permission.

Query parameters

daterequired string Any date in the week to return (ISO date).

curl -X GET "https://api.inboxy.chat/api/v1/meetings/week" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/meetings/contact/{contactId}meetings:read

List meetings for a contact

Requires meetings:read permission.

Path parameters

contactIdrequired string

curl -X GET "https://api.inboxy.chat/api/v1/meetings/contact/{contactId}" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/meetings/{id}meetings:read

Get a meeting

Requires meetings:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/meetings/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/meetings/{id}meetings:write

Update a meeting

Requires meetings:write permission.

Path parameters

idrequired string

Body

`reason`	`string`	Meeting reason/title.
`type`	`ONLINE \| OFFLINE`
`startTime`	`string`	ISO 8601 UTC.
`startTimeLocal`	`string`	ISO 8601 local.
`timezone`	`string`	IANA timezone identifier.
`durationMinutes`	`number`
`contactId`	`string`	Or null to clear.
`link`	`string`	Or null to clear.
`location`	`string`	Or null to clear.
`notes`	`string`	Or null to clear.
`attendees`	`object[]`

curl -X PUT "https://api.inboxy.chat/api/v1/meetings/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "reason": "reason",
  "type": "ONLINE",
  "startTime": "startTime",
  "startTimeLocal": "startTimeLocal",
  "timezone": "timezone",
  "durationMinutes": 1,
  "contactId": "contactId",
  "link": "link",
  "location": "location",
  "notes": "notes",
  "attendees": [
    {
      "type": "TEAM",
      "userId": "userId",
      "name": "name",
      "email": "customer@example.com",
      "phone": "966500000000"
    }
  ]
}'

DELETE/api/v1/meetings/{id}meetings:write

Delete a meeting

Requires meetings:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/meetings/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/meetings/{id}/completemeetings:write

Mark a meeting completed

Requires meetings:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/meetings/{id}/complete" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/meetings/{id}/cancelmeetings:write

Mark a meeting cancelled

Requires meetings:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/meetings/{id}/cancel" \
  -H "Authorization: Bearer inboxy_your_token"

Analytics

GET/api/v1/public/analytics/dashboardanalytics:read

Get dashboard analytics

Get aggregated dashboard statistics (conversations, messages, contacts, etc.). Requires analytics:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/public/analytics/dashboard" \
  -H "Authorization: Bearer inboxy_your_token"

Knowledge Center

GET/api/v1/knowledge-center/categoriesknowledge:read

List knowledge categories

Requires knowledge:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/knowledge-center/categories" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/knowledge-center/categoriesknowledge:write

Create a knowledge category

Requires knowledge:write permission.

Body

`name`required	`string`	Category name.
`description`	`string`	Category description.
`icon`	`string`	Icon identifier.
`color`	`string`	Display color.
`parentId`	`string`	Parent category ID, for nesting.
`sortOrder`	`number`	Sort order among siblings.

curl -X POST "https://api.inboxy.chat/api/v1/knowledge-center/categories" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Shipping and returns",
  "description": "description",
  "icon": "icon",
  "color": "#3bc1a8",
  "parentId": "parentId",
  "sortOrder": 1
}'

PUT/api/v1/knowledge-center/categories/{id}knowledge:write

Update a knowledge category

Requires knowledge:write permission.

Path parameters

idrequired string

Body

`name`	`string`	Category name.
`description`	`string`	Category description.
`icon`	`string`	Icon identifier.
`color`	`string`	Display color.
`parentId`	`string`	Parent category ID, or null to un-nest.
`sortOrder`	`number`	Sort order among siblings.

curl -X PUT "https://api.inboxy.chat/api/v1/knowledge-center/categories/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "name",
  "description": "description",
  "icon": "icon",
  "color": "color",
  "parentId": "parentId",
  "sortOrder": 1
}'

DELETE/api/v1/knowledge-center/categories/{id}knowledge:write

Delete a knowledge category

Requires knowledge:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/knowledge-center/categories/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/knowledge-center/categories/reorderknowledge:write

Reorder knowledge categories

Requires knowledge:write permission.

Body

orderrequired object[] Full ordered list of category IDs with their new sort positions.

curl -X PUT "https://api.inboxy.chat/api/v1/knowledge-center/categories/reorder" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "order": [
    {
      "id": "id",
      "sortOrder": 1
    }
  ]
}'

GET/api/v1/knowledge-center/articlesknowledge:read

List knowledge articles

Requires knowledge:read permission.

Query parameters

`categoryId`	`string`
`status`	`DRAFT \| PUBLISHED \| ARCHIVED`
`tag`	`string`
`search`	`string`	Title or content.
`page`	`integer`	Page number (default 1).
`limit`	`integer`	Page size (default 20).

curl -X GET "https://api.inboxy.chat/api/v1/knowledge-center/articles" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/knowledge-center/articlesknowledge:write

Create a knowledge article

Requires knowledge:write permission.

Body

`title`required	`string`	Article title.
`content`required	`string`	Article body.
`categoryId`	`string`	Category this article belongs to.
`excerpt`	`string`	Short summary shown in listings.
`tags`	`string[]`	Free-text tags.
`status`	`DRAFT \| PUBLISHED`	Defaults to DRAFT.

curl -X POST "https://api.inboxy.chat/api/v1/knowledge-center/articles" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "How to reset your password",
  "content": "content",
  "categoryId": "categoryId",
  "excerpt": "excerpt",
  "tags": [
    "tags"
  ],
  "status": "DRAFT"
}'

GET/api/v1/knowledge-center/articles/{id}knowledge:read

Get a knowledge article

Requires knowledge:read permission.

Path parameters

idrequired string

curl -X GET "https://api.inboxy.chat/api/v1/knowledge-center/articles/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

PUT/api/v1/knowledge-center/articles/{id}knowledge:write

Update a knowledge article

Requires knowledge:write permission.

Path parameters

idrequired string

Body

`title`	`string`	Article title.
`content`	`string`	Article body.
`categoryId`	`string`	Category, or null to clear.
`excerpt`	`string`	Short summary shown in listings.
`tags`	`string[]`	Free-text tags.
`status`	`DRAFT \| PUBLISHED \| ARCHIVED`	Article status.

curl -X PUT "https://api.inboxy.chat/api/v1/knowledge-center/articles/{id}" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "title": "title",
  "content": "content",
  "categoryId": "categoryId",
  "excerpt": "excerpt",
  "tags": [
    "tags"
  ],
  "status": "DRAFT"
}'

DELETE/api/v1/knowledge-center/articles/{id}knowledge:write

Delete a knowledge article

Requires knowledge:write permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/knowledge-center/articles/{id}" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/knowledge-center/articles/{id}/publishknowledge:write

Publish a knowledge article

Requires knowledge:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/knowledge-center/articles/{id}/publish" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/knowledge-center/articles/{id}/archiveknowledge:write

Archive a knowledge article

Requires knowledge:write permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/knowledge-center/articles/{id}/archive" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/knowledge-center/searchknowledge:read

Search knowledge articles

Requires knowledge:read permission.

Query parameters

`q`	`string`	Search text; empty returns nothing.
`limit`	`integer`	Max results (default 20).

curl -X GET "https://api.inboxy.chat/api/v1/knowledge-center/search" \
  -H "Authorization: Bearer inboxy_your_token"

GET/api/v1/knowledge-center/quick-searchknowledge:read

Quick-search knowledge articles

Requires knowledge:read permission.

Query parameters

`q`	`string`	Search text; empty returns nothing.
`limit`	`integer`	Max results (default 5).

curl -X GET "https://api.inboxy.chat/api/v1/knowledge-center/quick-search" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/knowledge-center/articles/{id}/feedbackknowledge:write

Submit article feedback

Requires knowledge:write permission.

Path parameters

idrequired string

Body

`isHelpful`required	`boolean`	Whether the article was helpful.
`comment`	`string`	Optional free-text comment.

curl -X POST "https://api.inboxy.chat/api/v1/knowledge-center/articles/{id}/feedback" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "isHelpful": true,
  "comment": "comment"
}'

Channels

GET/api/v1/me/channelschannels:read

Connection status of every channel (WhatsApp, Instagram, Messenger, Telegram, website chat)

Aggregate connection state for all channels (WhatsApp, Instagram, Messenger, Telegram, Widget). One request, parallel-fetched. Requires channels:read permission.

curl -X GET "https://api.inboxy.chat/api/v1/me/channels" \
  -H "Authorization: Bearer inboxy_your_token"

Scheduled messages

GET/api/v1/scheduled-messagesmessages:read

List scheduled messages

Requires messages:read permission.

Query parameters

`status`	`PENDING \| SENT \| FAILED \| CANCELLED \| PAUSED \| DEAD_LETTER`
`channel`	`WHATSAPP \| INSTAGRAM \| MESSENGER \| TELEGRAM \| WIDGET`
`limit`	`integer`	1–200 (default 50); out of range is a 400.
`offset`	`integer`	Rows to skip (default 0).

curl -X GET "https://api.inboxy.chat/api/v1/scheduled-messages" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/scheduled-messagesmessages:send

Schedule a message

Requires messages:send permission.

Body

`channel`required	`WHATSAPP \| INSTAGRAM \| MESSENGER \| TELEGRAM \| SMS`
`recipientRef`required	`string`	Phone number (WhatsApp/SMS) or the channel’s recipient id.
`scheduledFor`required	`string`
`conversationId`	`string`
`recurrence`	`NONE \| DAILY \| WEEKLY \| MONTHLY`
`payload`required	`object`	`{kind:"text", text}` or `{kind:"template", templateName, languageCode, bodyVariables?, components?}`. Outside the 24-hour window WhatsApp needs a template; the response says `window_requires_template`.

curl -X POST "https://api.inboxy.chat/api/v1/scheduled-messages" \
  -H "Authorization: Bearer inboxy_your_token" \
  -H "Content-Type: application/json" \
  -d '{
  "channel": "WHATSAPP",
  "recipientRef": "966500000000",
  "scheduledFor": "2026-09-20T09:00:00Z",
  "conversationId": "conversationId",
  "recurrence": "NONE",
  "payload": {
    "kind": "template",
    "templateName": "order_shipped",
    "languageCode": "ar",
    "bodyVariables": {
      "1": "Sara"
    }
  }
}'

POST/api/v1/scheduled-messages/{id}/cancelmessages:send

Cancel a scheduled message

Requires messages:send permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/scheduled-messages/{id}/cancel" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/scheduled-messages/{id}/pausemessages:send

Pause a recurring message

Requires messages:send permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/scheduled-messages/{id}/pause" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/scheduled-messages/{id}/resumemessages:send

Resume a paused message

Requires messages:send permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/scheduled-messages/{id}/resume" \
  -H "Authorization: Bearer inboxy_your_token"

POST/api/v1/scheduled-messages/{id}/send-nowmessages:send

Send a scheduled message now

Requires messages:send permission.

Path parameters

idrequired string

curl -X POST "https://api.inboxy.chat/api/v1/scheduled-messages/{id}/send-now" \
  -H "Authorization: Bearer inboxy_your_token"

DELETE/api/v1/scheduled-messages/{id}messages:send

Delete a scheduled message

Requires messages:send permission.

Path parameters

idrequired string

curl -X DELETE "https://api.inboxy.chat/api/v1/scheduled-messages/{id}" \
  -H "Authorization: Bearer inboxy_your_token"