prospect/delete_by_id
Tool: delete
permanently delete a prospect and associated data.
Removes the prospect record from the system. This action is irreversible.
Suppress first, then delete. If this contact must never be mailed again (bounce, unsubscribe, complaint), blacklist the address via blacklist/post_emails before deleting — the entry outlives the prospect record, but deleting first loses the address, so a failed blacklist call leaves the contact unsuppressed.
Idempotent: deletes are idempotent — a 404 means this prospect is already gone (including because an earlier call already deleted it). Treat it as the desired end state, not a failure.
Arguments
| name | type | req | notes |
|---|---|---|---|
| id | integer | ✓ | Prospect ID — the object's prospectId (int64) |
Response
204 — deleted (no body).
Errors: 400, 401, 404, 406, 422, 429, 500 — shared schema: schemas/errors. 404 = prospect not found or not owned by this account.
Invoke
Call delete with name: "prospect/delete_by_id".