Skip to main content
GET
Retrieve an outcome form

Authorizations

Authorization
string
header
required

A secret key (dk_live_…). Scopes: conversations:read, contacts:read, contacts:write, meetings:read, analytics:read, events:read, webhooks:write, knowledge:read, knowledge:write, agent:read, agent:write, experiments:read, experiments:write, privacy:write, chat:write.

Path Parameters

id
string
required

Response

OK

id
string
required

out_…, or meeting for Book a meeting before it has been saved with questions.

Example:

"out_hnuk3nnp4kwt7hlb"

object
string
required
Allowed value: "outcome"
kind
enum<string>
required

meeting: the built-in Book a meeting, whose questions come before the calendar. form: a form you built.

Available options:
form,
meeting
name
string
required
status
enum<string>
required

live: the agent offers it. Book a meeting is live while it has questions.

Available options:
live,
draft
button_label
string
required

The button the agent shows above the message box when it offers the form.

offer_when
string
required

When the agent opens it: "Offer it when the visitor…".

then
enum<string>
required
Available options:
message,
meeting
meeting_optional
boolean
required
required_before_booking
boolean
required
questions
object[]
required
phone
enum<string>
required
Available options:
off,
optional,
required
done_message
string
required
not_fit_message
string
required
notify
string[]
required
top_of_chat
boolean
required
results
object
required

The last 30 days: forms the agent opened, requests sent, and sent requests that were not a fit. Preview chats are left out.

version
integer
required
Required range: -9007199254740991 <= x <= 9007199254740991
updated_at
string<date-time> | null
required
Pattern: ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$