Schemas

Mirrors the HTTP status code.

Human-readable error. Do not branch logic on this string — branch on code.

Lowercased server-side for comparison.

Sent in plaintext over TLS only.

JWT signed with OPENAPI_JWT_SECRET_KEY. 1-hour TTL.

Absolute access-token expiry.

Opaque cmrr_<prefix>_<secret> token. 30-day TTL. Rotated on every refresh — replace your stored copy after every /auth/refresh call.

Full user profile.

Single-use 2FA challenge JWT (~5 min TTL). Not usable as an access token.

The JWT returned by the 2FA branch of /auth/login.

6-digit TOTP from the authenticator app, OR an alphanumeric recovery code. Server tries TOTP first then falls back to recovery — the client does not need to specify which.

Refresh row to revoke. Even when all_devices=true, the field is required as proof-of-possession.

When true, revokes every active refresh row for the user — useful for a Sign out everywhere button.

Full user profile.

Which mechanism authenticated this call — useful for integrators to confirm their API key is recognized.

limit: null means unlimited (Enterprise). Render an infinity glyph instead of zero.

Pre-formatted for the chart axis — "14 May" for daily buckets, "13:00" for hourly.

Page-level sum. Always equals the sum of buckets[].total.

Conversations created in the period that have assigned_agent_id set.

Subset of total_assigned whose resolved_at also falls inside the period.

Wire enum identifying the channel brand. Pass to ?channel_type= on GET /conversations.

Wire enum identifying the channel brand. Pass to ?channel_type= on GET /conversations.

Inbox operational state.

Wire enum identifying the channel brand. Pass to ?channel_type= on GET /conversations.

Server-supplied human label — mirrors the dashboard's getChannelDisplayName().

Hex with # prefix. Falls back to #6B7280 (neutral grey) for future channel types.

Number of ACTIVE inboxes the organization has of this brand.

ACTIVE members for the team — resolved via a single batched COUNT GROUP BY team_id per page.

When true, assigning a conversation round-robins one of the team's active members. When false, the team owns the chat collectively until an agent claims it manually.

Brand color for the status pill / dot.

Meta-approved template name.

BCP-47 — id, en_US, etc.

Raw Meta components[] JSON. Renderers read type, format, text, buttons[], example.header_handle[0].

Echoes the tab you requested.

CONTACT-sender, non-private, no read_at. Surfaced from the Redis counter (falls back to the SQL mirror).

Preview of the most recent non-private message. Null when the conversation has no messages yet.

Embedded contact reference on conversations and messages. Always present — name falls back to phone, then "Unknown Contact".

Embedded channel reference on conversations.

Minimal user identity — the shape used inside conversation rows, ticket assignees, and chat sender refs.

Whether the AI agent is set to auto-reply on this conversation. Toggle via PATCH /conversations/{id}/ai-agent.

SQL mirror of chatmo:ws:unread:{id} > 0. Powers the is_unread=true filter.

Echoes the tab you requested.

CONTACT-sender, non-private, no read_at. Surfaced from the Redis counter (falls back to the SQL mirror).

Preview of the most recent non-private message. Null when the conversation has no messages yet.

Embedded contact reference on conversations and messages. Always present — name falls back to phone, then "Unknown Contact".

Embedded channel reference on conversations.

Minimal user identity — the shape used inside conversation rows, ticket assignees, and chat sender refs.

Whether the AI agent is set to auto-reply on this conversation. Toggle via PATCH /conversations/{id}/ai-agent.

SQL mirror of chatmo:ws:unread:{id} > 0. Powers the is_unread=true filter.

Which arm of the OR matched: contact name/phone, message content, or both.

Slim preview of the most recent message whose content matched q. Present when match_type is "message" or "both", null when "name".

Contact-side sender. Populated for sender_type=CONTACT.

Agent-side sender. Populated for sender_type=AGENT / AI_AGENT.

For sender_type=SYSTEM.

Channel-specific extras — filename, dimensions, duration, etc.

Joined attachment row on the message. Server generates thumbnails for IMAGE / VIDEO synchronously under 25 MB, asynchronously otherwise.

Channel-side message id — WhatsApp wamid.*, Telegram numeric, FB/IG MID.

True for AI-generated or scheduler-driven messages.

Always false on this endpoint — private messages are filtered server-side.

Pass-through bag — template name, button payload, etc.

Convenience: reply_to != null.

Inline preview of the parent message. Includes media URL + thumbnail + filename so WhatsApp-style reply quotes render without a second lookup.

Active rows in conversation_label_assignments pointing at this label.

Junction row id (conversation_label_assignments.id).

Catalog id — use this to identify the chip across conversations.

Targets. Capped at 50 — fan-out runs the matching single-action usecase per row.

Populated when success=false.

Populated for additive ops — collaborators added, labels attached.

Pre-existing assignments that were left alone.

Must be a WHATSAPP_OFFICIAL or WHATSAPP_UNOFFICIAL channel in your organization.

E.164 dial code with leading +.

Local digits only — country code lives in the field above.

Contact display name. Used when find-or-create creates a new contact; ignored when the contact already exists.

true for 201 Created, false for 200 OK (existing conversation returned).

Paste this into message.send's media.file_id to reference the upload.

Per-file failures so one bad file does not sink a 5-file upload.

Present when the request was made with include_statuses=true. Omitted (not null, not empty array) otherwise.

JSON number — decimal converted to float64. Matches dashboard cart math.

Grams — only meaningful for PHYSICAL.

Minimal user identity — the shape used inside conversation rows, ticket assignees, and chat sender refs.

Auto-allocated MAX(ticket_number)+1 within the org.

Legacy single assignee.

Within the status column, auto-allocated MAX(position)+1.

Minimal user identity — the shape used inside conversation rows, ticket assignees, and chat sender refs.

Must belong to board_id.

Legacy single assignee.

Multi-assignee array. Inserted into ticket_assignees.

Pass empty string to clear.

Must belong to the same board. Flips is_done if the target status is the board's is_default.

When present, REPLACES ticket_assignees (delete-all + create-all in one transaction).

Empty {} for COMMENT. For CHANGELOG: {field, old, new}.

Minimal user identity — the shape used inside conversation rows, ticket assignees, and chat sender refs.

Frontend-pre-parsed @[Name](uuid) tokens. Server does NOT re-parse content.

Replacement semantics — omit to leave existing mentions untouched; [] to clear; [a,b] to replace.

Sanitized original filename. Bucket key gets a timestamp prefix internally to dodge collisions.

AUTOMATIC is Xendit-integrated; MANUAL is bank transfer with proof.

Decimal as string (preserves precision).

For Xendit, the hosted invoice URL.

Auto-allocated MAX+1 within the organization.

Not auto-historied. Internal only.

Existing contact id. When set, server snapshots name / email / phone — raw fields override per-order.

Required when customer_id is not provided.

Required when customer_id is not provided.

Drives the payment row + Xendit invoice creation when the method is AUTOMATIC+XENDIT.

Side-effects: SHIPPING → shipped_at, COMPLETED → delivered_at, CANCELLED → cancelled_at + cancelled_by.

Slim invoice projection — drops internal_notes, metadata, and weight from the full Order shape.

When the org has not configured ecommerce_invoice_templates, returned as null with template_configured: false.

Must reference a payment row whose parent order belongs to your organization.

Grams.

Item value in IDR.

Currently not forwarded upstream — accepted for forward compatibility.

Default ["jne","jnt","sicepat","anteraja","ninja","lion","pos","tiki"] when omitted — same shortlist as the dashboard.

Sum of items[].weight * items[].quantity.

Flat list sorted by price ASC.

Same set collated by courier — services sorted by price ASC, groups sorted by courier_name.

Full user profile.

true enables auto-reply, false pauses it.

UUID of the persisted private AI_SUMMARY message. Empty string when is_cached=true (the prior message is reused).

true when the fingerprint matched and no new LLM call was made.

Human-readable status line.