---
title: "Unsubscribe Candidate"
method: POST
path: "/api/v2/core/profiles/{profileId}/unsubscribe"
tags: ["Profile"]
---

# Unsubscribe Candidate

`POST /api/v2/core/profiles/{profileId}/unsubscribe`

## Request

- Base URL: `https://apiv2.eightfold.ai`
- URL: `https://apiv2.eightfold.ai/api/v2/core/profiles/{profileId}/unsubscribe`
- Auth: none declared. Required headers: `Authorization`
- TypeScript: <https://skmtc.dev/eightfold/apis/api-server-v2-service-service/docs/api/v2/core/profiles/:profileId/unsubscribe/post.ts> (a function with typed inputs; its response is checked against the schema)

Unsubscribe all emails and phone numbers on a candidate profile from the given communication channels

## Path parameters

- `profileId` string, required

## Headers

- `Authorization` string, required

## Request body

- ProfileUnsubscribeSchema
  - `channels` string[], nullable: Channels to unsubscribe from: email, campaign, sms, whatsapp. Defaults to all channels when omitted or empty

## Response `200`

OK

- ProfileUnsubscribeResultSchema
  - `phonesUnsubscribed` integer, nullable: Number of distinct phone numbers suppressed on at least one requested channel. Use channelResults to see whether every channel succeeded for them
  - `channelResults` ProfileUnsubscribeChannelResult[], nullable: Per-channel outcome, one entry per requested channel
    - `contactsUnsubscribed` integer, nullable: Number of contacts suppressed on this channel
    - `channel` string, nullable: Channel the counts below apply to: email, campaign, sms or whatsapp
    - `contactsFailed` integer, nullable: Number of contacts that could not be suppressed on this channel; retry the request for this channel to complete them
  - `emailsUnsubscribed` integer, nullable: Number of distinct email addresses suppressed on at least one requested channel. Use channelResults to see whether every channel succeeded for them
  - `channels` string[], nullable: Channels the suppression was applied to

## Changes

- **2026-11-03** `9a8b3a927e93`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/changes/api/v2/core/profiles/:profileId/unsubscribe/post.md)

---

[API](https://skmtc.dev/eightfold/apis/api-server-v2-service-service.md) - [All operations](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/llms.txt) - [OpenAPI document](https://skmtc.dev/eightfold/apis/api-server-v2-service-service/revisions/9a8b3a927e93?raw)