Skip to content

Leads

Pause a lead

POST/v1/leads/{lead_id}/pause

Pause the calling sequence for a single lead.

Atomic across all of the lead's active lead_source_leads rows. Idempotent: re-pausing returns already_paused=True with updated_count=0. A call already ringing is not killed.

Returns 404 if the lead is not in the caller's org (or, for a campaign-bound key, not in its campaign). Returns 409 if the lead has no active sequence (already terminal).

On this page

Headers

AuthorizationstringRequired
ApiKey $ENTROVOX_KEY. Keys are issued per organization.

Path parameters

lead_idstringRequired

Body

reasonstring or null, max 140Optional

Returns

200 OKPaused (or already paused).

already_pausedbooleanAlways present
paused_atstring (date-time) or nullMay be absent
paused_reasonstring or nullMay be absent
updated_countintegerAlways present

Errors

  • 400VALIDATION_ERROR

    A field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.

    Retrying will fail the same way. Fix the request, or contact us.

  • 403INSUFFICIENT_SCOPE

    A read key tried to write. Use a key with write scope.

    Retrying will fail the same way. Fix the request, or contact us.

  • 403API_KEY_ENDPOINT_NOT_ALLOWED

    The endpoint is outside the partner surface, or the key's campaign binding is invalid. Ask for a new key.

    Retrying will fail the same way. Fix the request, or contact us.

  • 404LEAD_NOT_FOUND

    No lead with that id in your organization.

    Retrying will fail the same way. Fix the request, or contact us.

  • 409LEAD_NOT_PAUSEABLE

    The lead's sequence already ended, so it cannot be paused.

    Retrying will fail the same way. Fix the request, or contact us.

  • 409LEAD_ENROLLED_ELSEWHERE

    Entrovox also runs this lead outside your campaign, so you cannot pause or resume it. Ask us.

    Retrying will fail the same way. Fix the request, or contact us.

  • 422VALIDATION_ERROR

    A field is missing or invalid, such as a bad E.164 phone or a missing external_id. param names the field.

    Retrying will fail the same way. Fix the request, or contact us.

Any request can also return AUTHENTICATION_REQUIRED, TOKEN_INVALID, API_KEY_EXPIRED, RATE_LIMIT_EXCEEDED or INTERNAL_ERROR.