---
title: "Unsubscribes contact from a given list."
method: POST
path: "/v2/address-books/{addressBookId}/contacts/unsubscribe"
tags: ["ApiContact"]
---

# Unsubscribes contact from a given list.

`POST /v2/address-books/{addressBookId}/contacts/unsubscribe`

## Request

- Base URL: `https://api.dotdigital.com`
- URL: `https://api.dotdigital.com/v2/address-books/{addressBookId}/contacts/unsubscribe`
- Auth: none declared
- TypeScript: <https://skmtc.dev/dotdigital/apis/apiconnector-com/docs/v2/address-books/:addressBookId/contacts/unsubscribe/post.ts> (a function with typed inputs; its response is checked against the schema)

## Path parameters

- `addressBookId` integer, required

## Request body

- ApiContact
  - `id` integer
  - `email` string, required
  - `optInType` 'Unknown' | 'Single' | 'Double' | 'VerifiedDouble' | 'NotAvailableInThisVersion'
  - `emailType` 'PlainText' | 'Html' | 'NotAvailableInThisVersion'
  - `dataFields` ApiContactData[], nullable
    - `key` string, nullable
    - `value` unknown
  - `status` 'Subscribed' | 'Unsubscribed' | 'SoftBounced' | 'HardBounced' | 'IspComplained' | 'MailBlocked' | 'PendingOptIn' | 'DirectComplaint' | 'Deleted' | 'SharedSuppression' | 'Suppressed' | 'NotAllowed' | 'DomainSuppression' | 'NoMxRecord' | 'NotAvailableInThisVersion'

## Response `200`

- ApiContactSuppression
  - `suppressedContact` ApiContact
    - `id` integer
    - `email` string, required
    - `optInType` 'Unknown' | 'Single' | 'Double' | 'VerifiedDouble' | 'NotAvailableInThisVersion'
    - `emailType` 'PlainText' | 'Html' | 'NotAvailableInThisVersion'
    - `dataFields` ApiContactData[], nullable
      - `key` string, nullable
      - `value` unknown
    - `status` 'Subscribed' | 'Unsubscribed' | 'SoftBounced' | 'HardBounced' | 'IspComplained' | 'MailBlocked' | 'PendingOptIn' | 'DirectComplaint' | 'Deleted' | 'SharedSuppression' | 'Suppressed' | 'NotAllowed' | 'DomainSuppression' | 'NoMxRecord' | 'NotAvailableInThisVersion'
  - `dateRemoved` string, date-time
  - `reason` 'Subscribed' | 'Unsubscribed' | 'SoftBounced' | 'HardBounced' | 'IspComplained' | 'MailBlocked' | 'PendingOptIn' | 'DirectComplaint' | 'Deleted' | 'SharedSuppression' | 'Suppressed' | 'NotAllowed' | 'DomainSuppression' | 'NoMxRecord' | 'NotAvailableInThisVersion'

---

[API](https://skmtc.dev/dotdigital/apis/apiconnector-com.md) - [All operations](https://skmtc.dev/dotdigital/apis/apiconnector-com/llms.txt) - [OpenAPI document](https://skmtc.dev/dotdigital/apis/apiconnector-com/revisions/391b93e8d24a?raw)