Support API

Read and answer your organization’s support cases from your own help desk.

The Support API is part of the developer API at https://api-dev.tringify.com. It reads and answers the support cases of one developer organization.

Authentication#

Use a Developer API token created in Developer Portal › Settings › API tokens. Tokens start with tdv_, belong to the organization and carry the scopes support:read and optionally support:write (never more than the member who created the token holds). Send it as a bearer token:

bash
curl "https://api-dev.tringify.com/api/v1/support/cases?status=needs_reply&limit=25" \
  -H "Authorization: Bearer $TRINGIFY_DEV_TOKEN"

The same routes also accept a Developer Portal session with X-Organization-ID, and the CLI’s and developer MCP’s organization connector tokens (scopes organization:support:read / organization:support:write).

Responses#

Every response is JSON: { "success": true, "data": … }, or { "success": false, "error": { "code", "message", "field"?, "details"? } }.

Cases#

Method and path

Scope

Body or query

GET /api/v1/support/cases

support:read

status (needs_reply, waiting_for_merchant, with_tringify, solved, closed, active, all), about_kind, about_id, assignee (account id, unassigned, me), store_id, search (subject, store name or C- number), page, limit (25, 50, 100), updated_since (RFC 3339)

GET /api/v1/support/cases/{caseId}

support:read

Returns case, messages (your team’s notes included), events and up to 10 other_cases_for_store.

POST /api/v1/support/cases/{caseId}/messages

support:write

{ "body_text", "attachment_ids"?, "status_after"?: "solved" }

POST /api/v1/support/cases/{caseId}/notes

support:write

{ "body_text", "attachment_ids"? }: internal, never shown to merchants.

POST /api/v1/support/cases/{caseId}/status

support:write

{ "status": "solved" | "open" }: open reopens a case solved in the last 7 days.

POST /api/v1/support/cases/{caseId}/assign

support:write

{ "account_id": "me" | "<member id>" | null }: a member who can see Support, yourself (me), or no one.

POST /api/v1/support/cases/{caseId}/handoff

support:write

{ "body_text", "attachment_ids"? }: members only, not tokens. Opens a linked Tringify ticket.

POST /api/v1/support/cases/{caseId}/ai-draft

support:write

Asks for a suggested reply; read it from the case when ready. Never sent automatically.

List responses carry items, page, total_pages and counts: { needs_reply, waiting_for_merchant, with_tringify }. Use updated_since with the last updated_at you saw to sync incrementally, and webhooks to hear about changes as they happen.

bash
curl -X POST "https://api-dev.tringify.com/api/v1/support/cases/$CASE_ID/messages" \
  -H "Authorization: Bearer $TRINGIFY_DEV_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"body_text":"We have replayed the missing orders.","status_after":"solved"}'

Attachments#

POST /api/v1/support/attachments returns { upload_url, expires_at }. POST the file’s bytes to upload_url with its Content-Type and an X-Filename header (URL-encoded); the reply’s attachment.id goes in attachment_ids. Up to 10 files of 10 MB per message. GET /api/v1/support/attachments/{attachmentId} returns a short-lived download_url.

Saved replies, settings, webhooks and stats#

Method and path

Scope

GET, POST /api/v1/support/saved-replies; PATCH, DELETE /api/v1/support/saved-replies/{id}

read / write (200 per organization; title 1–120, body_text ≤ 20,000)

GET, PATCH /api/v1/support/settings

read / write: response_target_hours, timezone, hours, auto_reply_enabled, auto_reply_text, allow_app_bridge, allow_mcp, share_errors_default

GET, POST /api/v1/support/webhooks; PATCH, DELETE /api/v1/support/webhooks/{id}; POST …/{id}/rotate-secret; POST …/{id}/test; GET …/{id}/deliveries; POST …/{id}/deliveries/{deliveryId}/resend

read / write. See webhooks.

GET /api/v1/support/stats

read: open, needing a first reply, median first-reply bucket, answered and ratings over 90 days, satisfaction, escalated, per app or theme

GET /api/v1/support/limits

read: the current values of every limit below

Settings and webhooks can be changed by members and tokens; connectors (CLI, MCP) can read them. handoff is refused for tokens (SUPPORT_FORBIDDEN).

Limits#

Limit

Value

Reads per token

burst 20, then 2 per second

Writes per token

burst 10, then 1 per second

All tokens of an organization

burst 40, then 5 per second

Saved replies

200 per organization

Webhook endpoints

5 per organization

AI drafts

10 per case, 200 per organization per UTC day

Over a limit the API answers 429 SUPPORT_RATE_LIMITED with Retry-After, X-RateLimit-Limit, X-RateLimit-Remaining and X-RateLimit-Reset. Read the live values from GET /api/v1/support/limits rather than hard-coding them.

Errors#

Code

HTTP

When

SUPPORT_NOT_FOUND

404

No case with that id belongs to your organization.

SUPPORT_INVALID_INPUT

400 / 422

A field is missing or out of range; error.field names it.

SUPPORT_FORBIDDEN

403

The token or member lacks the permission, or the action is members only (handoff).

SUPPORT_CONFLICT

409

The state doesn’t allow it; error.details.reason says why.

SUPPORT_READ_ONLY

409

The case is closed (read_only_reason: "closed").

SUPPORT_RATE_LIMITED

429

Over a limit; wait Retry-After seconds.

CLI#

The Tringify CLI calls the same routes as the signed-in member:

bash
tringify support cases list --status needs_reply
tringify support cases get C-20418
tringify support cases reply C-20418 --message "Fixed in 2.4.2." --solve
tringify support cases note C-20418 --message "Webhook retries replayed."
tringify support cases assign C-20418 --to me
tringify support cases solve C-20418
tringify support cases reopen C-20418
tringify support settings get