Skip to main content
DELETE
Exclude contact
Removes one contact from a campaign. The enrollment moves to excluded with stop_hit: true and stop_reason: "manual", and this campaign never calls that person again. Exclusion is terminal for this campaign. There is no un-exclude: re-enrolling the same lead through POST /campaigns/{id}/leads will not resurrect it, because the enrollment still exists in its excluded state. To call that person again, enroll them in a different campaign. Required scope: campaigns:manage.

Path parameters

There is no request body.

What exclusion does and does not do

  • Does stop this campaign calling the contact, from any state — pending, scheduled, and mid-flight states alike.
  • Does not cancel a call already in progress. If the contact is dialing, that call completes and gets categorized normally; the exclusion prevents any further attempt.
  • Does not delete the lead. The lead and its history remain in GET /leads.
  • Does not add the number to the do-not-call list. Excluding is a scheduling decision about one campaign; suppressing a person everywhere is POST /do-not-call, which blocks them across every campaign and every direct call.
  • Does not decrement total_leads. GET /campaigns/{id}/stats reports the contact under excluded so the campaign’s history stays complete.
Use POST /do-not-call instead when someone asks not to be contacted. A verbal opt-out during a call is added to that list automatically, workspace-wide, without you having to exclude anyone by hand.

Example request

Example response

Excluding a contact that is already excluded returns the same 200 response — the operation is idempotent.

Errors

Authorizations

Authorization
string
header
required

Your Yappr API key (e.g. ypr_live_...). Generate one in the dashboard under Settings → API Keys.

Path Parameters

id
string<uuid>
required
lead_id
string<uuid>
required

Lead ID (not the CampaignContact.id).

Response

Contact excluded

campaign_id
string<uuid>
lead_id
string<uuid>
status
string
Example:

"excluded"

company_id
string<uuid>