Reference/Agents
POST
/v1/agentsCreate a new agent
Send a JSON body with at least a name. The response includes the new agent's id. Save that id for later calls.
Full URL
POST https://api.tryleadreach.com/v1/agents
Headers
X-Api-Key(required): your API key from the app Keys tab.Content-Type: application/json(required)
Path params (in the URL)
None
Query params (after ?)
None
Request body (JSON)
| Field | Type | Required | Meaning |
|---|---|---|---|
| name | string | Yes | Display name for the agent. |
Example request (JSON)
What you send: headers, and path / query / body when used.
{
"headers": {
"X-Api-Key": "lr_your_key_here",
"Content-Type": "application/json"
},
"body": {
"name": "Outbound"
}
}Example response (JSON)
Typical successful response shape.
{
"id": "a1111111-1111-1111-1111-111111111111",
"name": "Outbound",
"status": "active",
"campaignId": "c1111111-1111-1111-1111-111111111111"
}Response
201 with the created agent object (includes id).
Credits
0