Send a support message

POST /v1/me/support

• Operation ID: sendSupportMessage
• Tags: Support
• Base URL: http://localhost:8787

Opens a support conversation for the caller in the helpdesk inbox. Limited to 5 messages per hour per user.

Workflow: Integration guide.

Authentication: Platform user Bearer JWT. Acts only on the caller's own data.

Rate limit: 5 requests per 3600s per user.

Authentication

• Auth: Platform user Bearer JWT (Authorization: Bearer <access_token>).

Rate limit

5 requests per 3600 seconds per user. Exceeding it returns 429.

Request body

Required: yes.

Content type: application/json

Schema: object

Field	Type	Required	Description
subject	string	yes	Min length: 1. Max length: 200
message	string	yes	Min length: 1. Max length: 5000

Responses

201

Conversation created.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object

Field	Type	Required	Description
conversationId	integer	yes	-

Errors

400

Request validation failed.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ValidationErrorBody)

Field	Type	Required	Description
success	boolean	yes	One of: false
error	object	yes	-
error.name	string	yes	One of: "ZodError"
error.issues	object[]	yes	-
error.issues[].code	string	yes	-
error.issues[].path	(string | number)[]	yes	-
error.issues[].message	string	yes	-

Request validation

{
  "success": false,
  "error": {
    "name": "ZodError",
    "issues": [
      {
        "code": "custom",
        "path": [
          "field"
        ],
        "message": "Invalid value"
      }
    ]
  }
}

401

Missing, malformed, expired or wrong-audience Bearer token (missing_token, invalid_token, invalid_audience).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody)

Field	Type	Required	Description
error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
details	any	no	Optional structured context. For 403 it is { perm }.

Error response

{
  "error": "missing_token"
}

429

Rate limit exceeded (rate_limited).

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "rate_limited"
}

500

Unexpected server error (internal). No details are returned.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "internal"
}

502

support_unavailable: the helpdesk rejected or failed the request.

• Header x-request-id: Request identifier; quote it when reporting an error. Content type: application/json

Schema: object (ErrorBody), fields as described above.

Error response

{
  "error": "support_unavailable"
}

503

support_unavailable: the helpdesk is not configured. Maintenance can refuse this write before authentication (degraded blocks session start and checkout; lockdown blocks other public/user writes).

• Header x-request-id: Request identifier; quote it when reporting an error.
• Header Retry-After: Maintenance retry delay in seconds; present for panic_mode. Example: 30. Content type: application/json

Schema: object (ErrorBody) | object (MaintenanceErrorBody)

Field	Type	Required	Description
(variant 1).error	string	yes	Stable machine-readable error code, e.g. forbidden, not_found.
(variant 1).details	any	no	Optional structured context. For 403 it is { perm }.
(variant 2).error	string	yes	One of: "panic_mode"
(variant 2).level	string	yes	One of: "degraded", "lockdown"
(variant 2).reason	string | null	yes	-

Error response

{
  "error": "support_unavailable"
}

Dependency unavailable

{
  "error": "support_unavailable"
}

Maintenance lockdown

{
  "error": "panic_mode",
  "level": "lockdown",
  "reason": "Scheduled maintenance"
}

Examples

curl

curl -X POST 'http://localhost:8787/v1/me/support' \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H 'Content-Type: application/json' \
  --data '{"subject":"example","message":"example"}'

TypeScript

const accessToken = process.env.ACCESS_TOKEN; // user JWT from your sign-in flow

const response = await fetch("http://localhost:8787/v1/me/support", {
  method: "POST",
  headers: {
    "Authorization": `Bearer ${accessToken}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "subject": "example",
    "message": "example"
  }),
});
if (!response.ok) throw new Error(`HTTP ${response.status}: ${await response.text()}`);
const data = response.status === 204 || response.status === 205
  ? undefined
  : response.headers.get("content-type")?.includes("json")
    ? await response.json()
    : await response.text();