> ## Documentation Index
> Fetch the complete documentation index at: https://docs.altahq.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Communication opt-out

> A Do Not Contact list entry representing an opted-out identifier.

<ParamField path="id" type="string" required>
  Unique identifier for the opt-out entry (UUID).
</ParamField>

<ParamField path="objectType" type="string" required>
  Always `"communication-opt-out"`.
</ParamField>

<ParamField path="identifier" type="string" required>
  The identifier value (e.g. email address, phone number, LinkedIn URL).
</ParamField>

<ParamField path="identifierType" type="string" required>
  The type of the identifier. One of `"email"`, `"linkedin"`, `"phone"`, `"sms"`, `"whatsapp"`, or `"web_chat"`.
</ParamField>

<ParamField path="isManuallyAdded" type="boolean" required>
  Whether this entry was manually added (as opposed to automatically added, e.g. from an unsubscribe).
</ParamField>

<ParamField path="label" type="string">
  Optional display label for this opt-out entry.
</ParamField>

<ParamField path="createdAt" type="string" required>
  ISO 8601 timestamp when the object was created.
</ParamField>

<ParamField path="updatedAt" type="string" required>
  ISO 8601 timestamp when the object was last updated.
</ParamField>

## Example

```json theme={null}
{
  "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "objectType": "communication-opt-out",
  "identifier": "john@example.com",
  "identifierType": "email",
  "isManuallyAdded": true,
  "label": "John Doe",
  "createdAt": "2024-02-20T10:00:00Z",
  "updatedAt": "2024-02-20T10:00:00Z"
}
```