Outcomes

Retrieve an outcome form

Requires the agent:read scope.

meeting as the id is the built-in Book a meeting.

get/outcomes/{id}

Request

  • Base URL: https://api.meetdarwin.ai/v1
  • URL: https://api.meetdarwin.ai/v1/outcomes/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Response

OK

idstring required

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

object'outcome' required
kind'form' | 'meeting' required

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

namestring required
status'live' | 'draft' required

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

button_labelstring required

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

offer_whenstring required

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

then'message' | 'meeting' required
meeting_optionalboolean required
required_before_bookingboolean required
phone'off' | 'optional' | 'required' required
done_messagestring required
not_fit_messagestring required
notifystring[] required
top_of_chatboolean required
versioninteger required
updated_atstring date-time nullable required

Example response

{
  "id": "out_hnuk3nnp4kwt7hlb"
}

Changes

No recorded changes to this operation across all 1 revision of this API.