Schedule a message to send later
Creates a message with a scheduled delivery time.
/api/conversations/{id}/messages/scheduleCreates a message with a scheduled delivery time. The message remains pending until the scheduled time arrives, then becomes visible through the normal conversation message stream. The scheduled time must be in the future. Repeating the request creates another scheduled message.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
conversations:write- Module
- Automation & API module (
api_access) - Organization and site scope
- Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
- Retry behavior
- Non-idempotent: Repeating this request may create duplicate work or side effects. After an ambiguous timeout, check the resource state before retrying.
Path Parameters
Path parameter. Unique identifier of this resource.
Header Parameters
DA-4035: selects the active site (project) for project-scoped operations. Accepts a site UUID, or the literal all to aggregate across every accessible site on read-only aggregate routes (single-or-all-read). Mutations and single-site routes reject all. Path-owned project routes (/api/projects/{projectId}/…) resolve the site from the URL and ignore this header. Conflicting selectors across header/query/body/path return PROJECT_CONTEXT_CONFLICT (400); an archived site returns PROJECT_ARCHIVED (410).
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Request body accepted by this operation.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
{ "success": true, "id": "55555555-5555-4555-8555-555555555555"}Request examples
curl
curl --request POST \
'https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages/schedule' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"content": "I will follow up tomorrow morning.",
"senderType": "operator",
"type": "text",
"scheduledAt": "2026-08-04T08:30:00.000Z"
}'JavaScript
const response = await fetch("https://api.convor.io/api/conversations/11111111-1111-4111-8111-111111111111/messages/schedule", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"content": "I will follow up tomorrow morning.",
"senderType": "operator",
"type": "text",
"scheduledAt": "2026-08-04T08:30:00.000Z"
}),
});
const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
? null
: contentType.includes("json")
? await response.json()
: contentType.startsWith("text/")
? await response.text()
: await response.blob();
if (!response.ok) {
const message = typeof data === "object" && data !== null
&& "error" in data && typeof data.error === "object"
&& data.error !== null && "message" in data.error
? String(data.error.message)
: "Convor API request failed (" + response.status + ")";
throw new Error(message);
}
console.log(data);Was this page helpful?