POST /customers/{id}/reach-out
Updated Oct 1, 20261 minute read
Reach out
Writes to a customer first and opens a new conversation. The message lands in their widget on their next visit, with an email copy if they are away, or goes by email when that is the only way to reach them. as: "agent" sends it as the AI agent, which then answers their reply; the default sends it as the caller, whose thread it becomes. subject only shows on an email; brief is kept as a note on the thread and only with as: "agent".
Part of Customers.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
id | path | string | Yes | A customer id. |
Request body
application/json, required.
| Field | Type | Required | Description |
|---|---|---|---|
body | string | Yes | |
subject | string | No | |
as | "me" | "agent" | No | |
brief | string | No |
Responses
| Status | Description |
|---|---|
201 | The conversation it opened. |
400 | The request is malformed, and the message names the field. |
401 | The bearer token is missing, revoked, or expired. |
404 | Not one of yours, or not there at all. |
429 | Too many requests. Wait the seconds in Retry-After. Limits depend on the plan. See rate limits. |
201 body
| Field | Type | Required | Description |
|---|---|---|---|
conversationId | string | No |
Example request
curl -X POST https://api.median.sh/v1/customers/id/reach-out \
-H "Authorization: Bearer $BEARER_AUTH"