Skip to main content
POST
cURL

Authorizations

X-API-Key
string
header
required

Path Parameters

widget_public_id
string
required

The widget's public id, taken from its embed code (Get widget embed code).

Body

application/json

Consent accepted returned by the Sendora API.

fields
Fields · object

Fields returned by the Sendora API.

metadata
Metadata · object

Metadata returned by the Sendora API.

Response

Successful Response

call_id
string
required

The id of the call that was started, used by the widget to join it.

join_url
string
required

Join url returned by the Sendora API.

lead_capture_status
enum<string>
default:not_captured

Lead capture status returned by the Sendora API.

Available options:
captured,
not_captured,
failed