Lead source agents

Delete a source agent

Permanently delete a source agent. The agent stops sourcing immediately and its run logs (GET /api/v1/agents/{id}/logs) are deleted with it. The list the agent imports into and the leads already imported are not deleted. Needs the campaigns:write scope.

The agent is also the outreach campaign of the same id, so that campaign is deleted too: its leads' sequences end and their unsent drafts are dropped.

Deletion cannot be undone: to stop an agent temporarily, use PATCH /api/v1/agents/{id} with { "paused": true } instead.

deletehttps://app.replysparrow.com/api/v1/agents/{id}

Authorizations

Authorizationstringheaderrequired

Your API key from Settings → API, sent as Bearer <token>.

Path Parameters

idstringrequired

Agent id

Response

application/json

Agent deleted

idstringrequired

Id of the deleted agent

deletedbooleanrequired

Always true

Ctrl+I

Delete a source agent

curl --request DELETE \  --url https://app.replysparrow.com/api/v1/agents/string \  --header 'Authorization: Bearer <token>'

{  "id": "5b0f3c2e-8a8e-4bd1-9a51-6f1f3c0f2a10",  "deleted": true}