Raw Operations

Check contact eligibility for a campaign

Check whether contacts are eligible to be added to a campaign's sequence. Returns per-contact eligibility status with reasons for ineligibility (cooldown, already in another sequence, replied, blocked, or globally excluded). Use this before upserting contacts to avoid adding ineligible ones.

post/public/v1/campaigns/{id}/raw/contacts/check-eligibility

Request

  • Base URL: https://api.coldreach.ai
  • URL: https://api.coldreach.ai/public/v1/campaigns/{id}/raw/contacts/check-eligibility
  • Auth: API key in header x-api-key

Path parameters

idinteger nullable

Request body

bypassCooldownOtherSequencesboolean
bypassGlobalExcludedboolean
takeoverUnapprovedboolean
emailsstring[] required

Response

Per-contact eligibility results with summary

Changes

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