Get API key

    Reference/Agents

    PATCH/v1/agents/:id

    Update an agent

    Send only the fields you want to change in the JSON body.

    Full URL

    PATCH https://api.tryleadreach.com/v1/agents/:id

    Headers

    • X-Api-Key (required): your API key from the app Keys tab.
    • Content-Type: application/json (required)

    Path params (in the URL)

    NameTypeRequiredMeaning
    iduuidYesThe agent's id (from Create agent or List agents).

    Query params (after ?)

    None

    Request body (JSON)

    FieldTypeRequiredMeaning
    namestringNoNew display name.
    statusstringNoUsually "active".

    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"
  },
  "path": {
    "id": "a1111111-1111-1111-1111-111111111111"
  },
  "body": {
    "name": "Outbound",
    "status": "active"
  }
}

    Example response (JSON)

    Typical successful response shape.

    {
  "id": "a1111111-1111-1111-1111-111111111111",
  "name": "Outbound",
  "status": "active",
  "campaignId": "c1111111-1111-1111-1111-111111111111"
}

    Response

    Updated agent object.

    Credits

    0