Records the final outcome of a confirmed booking in the current organization. Organization API keys with `scheduling:write` and authenticated operator sessions are supported. Only bookings that still have `status: "confirmed"` can be updated. Allowed outcomes are `completed` and `no_show`. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `scheduling:write` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Only organization API keys and operator sessions can record outcomes. Allowed body values are exactly `completed` and `no_show`. Retry behavior: Outcome recording is a terminal transition from `confirmed` to `completed` or `no_show`. Repeating the request returns `422`; after an ambiguous timeout, read the booking before retrying.
/api/scheduling/bookings/{id}/outcomeOrganization API key supplied as Authorization: Bearer convor_sk_....
In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
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",
"visitorEmail": "[email protected]",
"visitorName": "Ada Lovelace",
"date": "2030-06-15",
"timeSlot": "10:00",
"timezone": "Europe/Warsaw",
"conversationId": "11111111-1111-4111-8111-111111111111",
"status": "completed",
"createdAt": "2030-05-01T08:00:00.000Z",
"updatedAt": "2030-05-01T08:00:00.000Z"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}curl --request POST \
'https://api.convor.io/api/scheduling/bookings/22222222-2222-4222-8222-222222222222/outcome' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer convor_sk_...' \
--header 'Content-Type: application/json' \
--data '{
"status": "completed"
}'const response = await fetch("https://api.convor.io/api/scheduling/bookings/22222222-2222-4222-8222-222222222222/outcome", {
method: "POST",
headers: {
"Accept": "application/json",
"Authorization": "Bearer convor_sk_...",
"Content-Type": "application/json"
},
body: JSON.stringify({
"status": "completed"
}),
});
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?
Reschedule a booking to a new slot
Moves a confirmed booking to a new date and 30-minute time slot without creating a new booking record. The booking ID and conversation link stay the same. Only confirmed bookings can be rescheduled, and conflicting confirmed slots return `409`. Widget visitors may reschedule only bookings linked to their own conversation. The previous date and slot are stored in the booking's `rescheduledFrom` and `rescheduledFromSlot` fields. Authenticate with an organization API key sent in `X-API-Key` or as a Bearer token and carrying the exact `scheduling:write` scope. API-key access also requires the Automation & API module (`automation_api`). Authorized dashboard sessions remain supported where the route already permits them. The request is isolated to the authenticated organization. Resource and site/project identifiers must belong to that organization; out-of-scope identifiers are not disclosed. Only a `confirmed` booking can be moved. The booking ID and conversation link remain unchanged, while `rescheduledFrom`, `rescheduledFromSlot`, and `rescheduledAt` record the previous slot. The target must satisfy the same future/business-hour/increment rules as creation and must not collide with another confirmed booking. A repeated request can overwrite reschedule provenance, so read the booking before retrying after an ambiguous timeout. Visitor bearer callers may reschedule only bookings linked to their own conversation. Retry behavior: This operation is not idempotent. After an ambiguous timeout, read the resource state before retrying to avoid duplicate work, messages, files, bookings, exports, or events.
Webhooks
Outgoing webhook management