Skip to main content
POST
Enable Lead Webhook

Authorizations

X-API-Key
string
header
required

Your organization's API key (account in the bottom-left of the dashboard → Brosbots API).

Headers

authorization
string | null
X-API-Key
string | null

Path Parameters

agent_id
required

The agent's ID: the public agent_ + 20 characters identifier shown in the dashboard (recommended), or the legacy number. Both address the same agent.

Pattern: ^agent_[A-Za-z0-9]{20}$
Example:

"agent_7fK2mQ9xLp3RtV8wYb1N"

Body

application/json

Lead settings from the integration wizard; unset fields keep their value.

phone_field
string | null
default_country_code
string | null
dedupe_minutes
integer | null
Required range: 0 <= x <= 1440
call_window
LeadCallWindow · object | null

Response

Successful Response

The response is of type object.