Alta API Documentation

string

required

Unique identifier for the opt-out entry (UUID).

string

required

Always "communication-opt-out".

string

required

The identifier value (e.g. email address, phone number, LinkedIn URL).

string

required

The type of the identifier. One of "email", "linkedin", "phone", or "domain".

boolean

required

Whether this entry was manually added (as opposed to automatically added, e.g. from an unsubscribe).

string

Optional display label for this opt-out entry.

string

required

ISO 8601 timestamp when the object was created.

string

required

ISO 8601 timestamp when the object was last updated.

Example

{
  "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"
}

Getting started

Endpoints

Objects & Definitions

Communication opt-out

Example

​Example

Example