Skip to main content
POST
/
api
/
v1
/
share
/
{token}
/
dispatch
Dispatch a shared agent (web mode)
curl --request POST \
  --url https://prod.featherhq.com/api/v1/share/{token}/dispatch \
  --header 'Content-Type: application/json' \
  --data '{
  "leadId": "<string>",
  "firstName": "<string>",
  "metadata": {},
  "mode": "shareable_link",
  "zipcode": "<string>",
  "customer": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "variables": {}
}'
{
  "connectionDetails": {
    "serverUrl": "<string>",
    "roomName": "<string>",
    "participantName": "<string>",
    "participantToken": "<string>"
  }
}

Path Parameters

token
string
required

Body

application/json
leadId
string
required
firstName
string
required
mode
enum<string>
required
Available options:
shareable_link
metadata
object
zipcode
string | null
customer
object
variables
object

Response

Dispatch created successfully

connectionDetails
object