/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Send to Support

Send to Support

Send a doc-site reader's assistant conversation to the project's support team, as the reader confirmed it.

POST/v1/projects/{projectId}/chat/handoffTry it

The second Send to support step: sends a reader's conversation to your support team with the summary and email they confirmed. It goes to the project's support email, the support.handoff webhook, or both. Call Draft a Support Handoff first to fill the form. See Send to support.

Public (no API key required) and scoped to the project and the visitorId: a reader can only send their own conversation.

Note

On your doc site this endpoint is also served same-origin at POST /_chat/handoff. The project comes from the site's hostname, so the path takes no projectId.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID.

Request Body

NameDescription
visitorId:stringbodyRequired
The anonymous visitor identifier (1–100 chars) that owns the conversation.
sessionId:stringbodyRequired
The conversation's UUID.
email:stringbodyRequired
Where support should reply to the reader. A valid email address, up to 254 characters.
summary:stringbodyRequired
The summary as the reader confirmed it, 1–2000 characters after trimming. Sent exactly as given.
includeMemory:booleanbody
Attach what the assistant remembers about the reader. Only takes effect when the project keeps memory and the reader has it on; otherwise nothing is attached.
Defaultfalse

What is sent

Every handoff is recorded first, then delivered to each destination that is set up:

•
Email — when support.email belongs to a verified member of your organization. The subject is [<project name>] Docs assistant handoff <ticket>: <conversation title>, and Reply-To is the reader's email, so replying reaches them. It contains the ticket, the reader's email, their summary, what the assistant remembers about them (only with includeMemory), and the transcript.
•
Webhook — when support.webhook is true, a support.handoff event to every endpoint subscribed to it. Its payload carries the same content.

The transcript is the conversation, oldest first, at most 100 messages. Code blocks the reader attached are left out.

A handoff is sent when at least one destination took it: the email was accepted for sending, or at least one active webhook endpoint subscribes to support.handoff (whether that endpoint then answers 2xx shows in its delivery log). With the webhook on but no endpoint subscribed, the webhook doesn't count: if there's no usable email either, Send to support isn't offered (features.handoff is false) and this route answers 409 HANDOFF_UNAVAILABLE.

Response — 201 Created

NameDescription
id:string
The handoff's ID — the handoffId in the webhook payload.
ticket:string
A short reference for the reader and your team: the first 8 characters of id, without hyphens, in upper case. It's in the email subject and the webhook payload.
to:string
Where it went: the support email, or the <project name> support team when only the webhook is set up.
email:string
The reader's reply-to address, as sent.

Sending doesn't use your AI query quota.

Rate Limits

PerLimit
Visitor3 handoffs a day
Client IP10 handoffs a day — only for requests through your doc site
Project50 handoffs a day
Organization200 handoffs a day, across all its projects

A request is only counted once the conversation is found to be the visitor's. Over a limit, the response is 429 with a Retry-After header. If the limits can't be checked, the request is refused with 429 rather than let through — see Agent mode action limits.

Error Responses

StatusCodeWhen
400validation_errorA field is missing or invalid: email not an address, summary empty or over 2000 characters
403FORBIDDENThe site is private (password, invite-only or SSO) and the request didn't come through the doc site ("Ask from the docs site")
404NOT_FOUNDThe project doesn't exist, or the conversation isn't this visitor's in this project
409HANDOFF_UNAVAILABLEThe project has no usable support destination: no support email that belongs to a verified member of your organization, and the support.handoff webhook is off or no endpoint subscribes to it
429RATE_LIMITEDA limit above was reached, or the limits could not be checked. retryAfterSeconds says when to try again
502DELIVERY_FAILEDNo destination took it: the email could not be sent and no webhook endpoint subscribes to support.handoff. The reader is asked to try again later
500internal_errorThe handoff could not be recorded
•
support.handoff webhook — the payload
•
Agent mode settings — support.email and support.webhook
Was this page helpful? Yes No
Request
bashJavaScriptPythonGoRubyPHPJavaC#bash
curl -X POST https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/chat/handoff \
-H "Content-Type: application/json" \
-d '{
"visitorId": "vis_9f8e7d",
"sessionId": "b2e9a1c4-5d3f-4e7a-9b08-6c2f1d4e8a93",
"email": "dana@example.com",
"summary": "I added the CNAME for my apex domain but verification still fails after a day.",
"includeMemory": false
}'
Responseapplication/json
201Created
{
"data": {
"id": "4a7c2e19-8b3d-4f6a-9c05-e1d2b3a4c5f6",
"ticket": "4A7C2E19",
"to": "support@acme.dev",
"email": "dana@example.com"
}
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext