Create a booking
Creates a booking in confirmed status.
/api/scheduling/bookCreates a booking in confirmed status. A booking may later become cancelled, completed, or no_show. The request requires visitorEmail, visitorName, date, and a future 30-minute timeSlot from 09:00 through 16:30. A confirmed booking at the same organization and absolute instant returns 409. Organization API keys may omit conversationId; visitor bearer callers must provide a conversation they own. No idempotency key is accepted, so after an ambiguous timeout, list the conversation's bookings or check availability before retrying.
Endpoint requirements
- Credentials
- Use either
Bearer API keyorX-API-Key header. - Required scope
scheduling: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.
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
{ "booking": { "id": "22222222-2222-4222-8222-222222222222", "orgId": "33333333-3333-4333-8333-333333333333", "projectId": "11111111-1111-4111-8111-111111111111", "visitorEmail": "[email protected]", "visitorName": "Ada Lovelace", "date": "2030-06-15", "timeSlot": "10:00", "timezone": "Europe/Warsaw", "conversationId": "11111111-1111-4111-8111-111111111111", "status": "confirmed", "createdAt": "2030-05-01T08:00:00.000Z", "updatedAt": "2030-05-01T08:00:00.000Z" }}Request examples
curl
curl --request POST \
'https://api.convor.io/api/scheduling/book' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"visitorEmail": "[email protected]",
"visitorName": "Ada Lovelace",
"date": "2030-06-15",
"timeSlot": "10:00",
"timezone": "Europe/Warsaw",
"conversationId": "11111111-1111-4111-8111-111111111111"
}'JavaScript
const response = await fetch("https://api.convor.io/api/scheduling/book", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"visitorEmail": "[email protected]",
"visitorName": "Ada Lovelace",
"date": "2030-06-15",
"timeSlot": "10:00",
"timezone": "Europe/Warsaw",
"conversationId": "11111111-1111-4111-8111-111111111111"
}),
});
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?