leads

Stop lead

Stop a lead’s campaign sequence. Cancels every remaining step, including a message already waiting out a delay, at any point in the sequence. The lead record is retained; confirm with stoppedAt on GET /v1/leads/{id}.

delete/v1/leads/{id}

Request

  • Base URL: https://api.botdog.co
  • URL: https://api.botdog.co/v1/leads/{id}
  • Auth: API key in header x-api-key

Path parameters

idstring required

Response

leadIdstring required

The lead that was stopped

stoppedboolean required

True when the sequence was torn down and the stop recorded. The request fails with 503 instead of returning false if the sequence could not be stopped, so a 2xx response always means the lead is stopped.

Example response

{
  "stopped": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.