Sign in

v1

latestOpenAPI 3.1.02026-07-13143194365.4 KB
support

Send a support message to the Grove team

Send a support message directly to the Grove team from authenticated clients.

Purpose: This endpoint enables CLI tools, SDKs, and extensions to submit support requests without requiring users to configure local email clients or navigate to a web form.

Authentication: Requires a valid JWT token in the Authorization: Bearer <token> header. The account ID is automatically extracted from the token for context.

Delivery:

  • Email delivery is fire-and-forget (non-blocking)
  • Returns immediately with a ticket ID for tracking
  • If email is disabled, returns status "disabled" so clients can fallback to alternative methods

Client Metadata: The optional metadata field should include diagnostic information like:

  • CLI/SDK version
  • Operating system and version
  • API endpoint being used
  • Any relevant error codes or states

This helps the support team provide faster, more accurate assistance.

post/v1/support/contact

Headers

authorizationstring nullable
user-agentstring nullable
hoststring nullable

Request body

messagestring required

Message to the Grove team

subjectstring nullable

Optional subject line override

reply_tostring nullable

Optional contact info for replies (email, URL, handle, etc.)

metadataobject nullable

Optional client metadata for debugging (e.g., CLI version, OS, API URL)

Response

Request accepted (check status field for actual delivery state)

ticket_idstring required

Support ticket identifier (include this when following up)

statusstring required

Delivery status (queued when forwarded; disabled when support messaging is not configured)

Example response

{
  "ticket_id": "b3c2f9c3-7c8a-4c7f-9d0c-2d5d1d2b3c4d",
  "status": "queued"
}