Skip to content

Appointment Request

POST
/org/appointment-request
curl --request POST \
--url https://engine.bindly.insure/org/appointment-request \
--header 'Content-Type: application/json' \
--data '{ "agency_name": "example", "email": "example", "phone": "example", "website": "example", "npn": "example", "fein": "example", "address_line1": "example", "address_line2": "example", "address_city": "example", "address_state": "example", "address_zip": "example" }'

Request a Hedge appointment for this agency (when the workspace has no Hedge account yet), the REST twin of the MCP request_hedge_appointment tool. Defaults come from the workspace’s agency profile in Bindly; explicit fields override.

Media typeapplication/json
AppointmentRequest

Every field optional: defaults come from the workspace’s agency profile in Bindly (agency_name and email are required overall).

object
agency_name
Any of:
string
email
Any of:
string
phone
Any of:
string
website
Any of:
string
npn
Any of:
string
fein
Any of:
string
address_line1
Any of:
string
address_line2
Any of:
string
address_city
Any of:
string
address_state
Any of:
string
address_zip
Any of:
string
Examplegenerated
{
"agency_name": "example",
"email": "example",
"phone": "example",
"website": "example",
"npn": "example",
"fein": "example",
"address_line1": "example",
"address_line2": "example",
"address_city": "example",
"address_state": "example",
"address_zip": "example"
}

Successful Response

Media typeapplication/json
AppointmentRequestResponse
object
status
required
Status
string
Examplegenerated
{
"status": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}