Optimizely Recipients API

Manage recipients and recipient lists for email campaigns.

Documentation GitHub OpenAPI

Operations 20

Each operation below carries the questions people ask an LLM about it and the instructions they give an agent to run it. Generated by API Evangelist overlay

GET /{clientId}/recipients/{recipientListId} List recipients in a recipient list · List recipients #

Ask an LLM

“Who is on one of my Optimizely Campaign recipient lists?”

“Can I pull every recipient stored in a particular mailing list?”

Tell an agent

List the recipients in recipient list {recipientListId} for client {clientId}.

Show me everyone on list {recipientListId}.

POST /{clientId}/recipients/{recipientListId} Add a single recipient to a list · Add a recipient #

Ask an LLM

“How can I subscribe one new email address to a recipient list?”

“Can I set a first and last name when adding a single recipient?”

Tell an agent

Add {email} as a new recipient on list {recipientListId} in client {clientId}.

Add recipient {email} named {first_name} {last_name} to list {recipientListId}.

PUT /{clientId}/recipients/{recipientListId} Bulk add recipients to a list · Add multiple recipients to a recipient list. #

Ask an LLM

“How do I import a batch of recipients into a recipient list in one request?”

“Can I attach an opt-in process when adding many recipients at once?”

Tell an agent

Bulk add these recipients {recipients} to list {recipientListId} in client {clientId}.

Add multiple recipients to list {recipientListId} using opt-in process {optinProcessId}.

DELETE /{clientId}/recipients/{recipientListId} Remove many recipients from a list · Delete recipients from a recipient list #

Ask an LLM

“Can I remove several recipients from a list by their IDs in one call?”

“What happens if I bulk-delete from a list without giving recipient IDs or a removal type?”

Tell an agent destructive · confirm first

Remove recipients {recipientIds} from list {recipientListId} in client {clientId}.

Bulk-remove recipients from list {recipientListId} by removal type {removalType}.

GET /{clientId}/recipients/{recipientListId}/{recipientId} Get one recipient's details · Get a recipient #

Ask an LLM

“What details are stored for a specific recipient on a list?”

“Can I look up a single subscriber record by recipient ID?”

Tell an agent

Get recipient {recipientId} from list {recipientListId}.

Show the record for {recipientId} on list {recipientListId} under client {clientId}.

PUT /{clientId}/recipients/{recipientListId}/{recipientId} Update a recipient's email and name · Update a recipient #

Ask an LLM

“How do I correct a subscriber's first or last name on a list?”

“Can I change the stored email address of an existing recipient record?”

Tell an agent

Update recipient {recipientId} on list {recipientListId} to email {email} in client {clientId}.

Rename recipient {recipientId} on list {recipientListId} to {first_name} {last_name}.

DELETE /{clientId}/recipients/{recipientListId}/{recipientId} Remove one recipient from a list · Delete a recipient #

Ask an LLM

“How do I take a single subscriber off a recipient list?”

“Can I delete just one recipient by ID without affecting the rest of the list?”

Tell an agent destructive · confirm first

Delete recipient {recipientId} from list {recipientListId}.

Remove {recipientId} from recipient list {recipientListId} for client {clientId}.

POST /{clientId}/recipients/{recipientListId}/{recipientId} Update attribute values of one recipient · Update attribute values of a recipient #

Ask an LLM

“Can I append text to one recipient's string field instead of overwriting it?”

“How do I change a single subscriber's list field values like city or segment?”

Tell an agent

Set attribute values {data} on recipient {recipientId} in list {recipientListId} in client {clientId}.

Apply {data} to recipient {recipientId} on list {recipientListId} in {mode} mode.

GET /{clientId}/recipients/{recipientListId}/count Count recipients in a list · Get the total number of recipients in a recipient list #

Ask an LLM

“How many recipients are on my recipient list right now?”

“Can I count only the recipients that match a target group?”

Tell an agent

Count the recipients on list {recipientListId} in client {clientId}.

Count recipients on list {recipientListId} in target group {targetGroup}.

GET /{clientId}/recipients/{recipientListId}/distinctvalues/count Count recipients per distinct field value · Get the total number of recipients for distinct attribute values #

Ask an LLM

“How many recipients share each value of a field like country?”

“Can I get a breakdown of subscriber counts per distinct attribute value?”

Tell an agent

Count recipients per distinct {attributeName} value on list {recipientListId} in client {clientId}.

Break down target group {targetGroup} on list {recipientListId} by {attributeName} with counts.

GET /{clientId}/recipients/{recipientListId}/distinctvalues Get distinct values of a recipient field · Get all distinct attribute values of a recipient #

Ask an LLM

“What unique values appear in a given field across my recipient list?”

“Can I only examine the first few characters when collecting distinct field values?”

Tell an agent

List the distinct values of field {attributeName} on list {recipientListId} in client {clientId}.

Get unique {attributeName} values on list {recipientListId} using the first {threshold} characters.

PUT /{clientId}/recipients/{recipientListId}/modify Update attributes for several named recipients · Update attribute values of multiple recipients #

Ask an LLM

“How do I change field values for a batch of specific recipients at once?”

“Can I update attributes of many listed subscribers in a single request?”

Tell an agent

Update attribute values for recipients {recipients} on list {recipientListId} in client {clientId}.

Batch-modify recipients {recipients} on list {recipientListId} with update mode {updateMode}.

POST /{clientId}/recipients/{recipientListId}/modify Update attributes for a target group · Update attribute values of recipients filtered by a target group #

Ask an LLM

“Can I set a field value for every recipient that matches a target group?”

“How do I mass-update subscribers selected by a segment rather than by ID?”

Tell an agent

Set {data} for all recipients in target group {targetGroup} on list {recipientListId} in client {clientId}.

Prepend or append values in target group {targetGroup} of list {recipientListId} using mode {mode}.

GET /{clientId}/recipients/{recipientListId}/{recipientId}/optinstatus Check a recipient's opt-in status · Check status optin of given recipient #

Ask an LLM

“Has this subscriber confirmed their opt-in on the list?”

“Can I check whether one email address is opted in before mailing it?”

Tell an agent

Check the opt-in status of {recipientId} on list {recipientListId} in client {clientId}.

Tell me if {recipientId} is opted in to list {recipientListId}.

GET /{clientId}/recipients/{recipientListId}/{recipientId}/valid Check if a recipient can receive mailings · Check whether a recipient is valid #

Ask an LLM

“Is this recipient blacklisted, unsubscribed or over the bounce limit on one list?”

“Can I check mailing eligibility for SMS rather than email on a single list?”

Tell an agent

Check whether {recipientId} is valid to mail on list {recipientListId} in client {clientId}.

Verify {recipientId} can receive {mediaType} on list {recipientListId}.

POST /{clientId}/recipients/trackingoptout Stop tracking a recipient's opens and clicks · Create a tracking opt-out #

Ask an LLM

“How do I stop recording email opens and clicks for one recipient?”

“Can a subscriber opt out of action-based tracking but stay on the list?”

Tell an agent

Create a tracking opt-out for {recipientId}.

Turn off open and click tracking for recipient {recipientId} under client {clientId}.

DELETE /{clientId}/recipients/trackingoptout Resume tracking a recipient's opens and clicks · Delete a tracking opt-out #

Ask an LLM

“How do I turn open and click tracking back on for a recipient who opted out?”

“Can I remove an existing tracking opt-out?”

Tell an agent destructive · confirm first

Delete the tracking opt-out for {recipientId} in client {clientId}.

Reactivate open and click tracking for recipient {recipientId}.

GET /{clientId}/recipients Check a recipient's validity across lists · Check whether a recipient is valid in multiple recipient lists #

Ask an LLM

“Can one recipient receive mailings on several of my lists at once?”

“What happens if I check recipient validity without naming any lists?”

Tell an agent

Check if {recipientId} is valid on recipient lists {recipientListIds} in client {clientId}.

Check {recipientId}'s mailing eligibility across all my recipient lists.

DELETE /{clientId}/recipients Delete a recipient's action history · Delete the recipient history #

Ask an LLM

“How do I erase all the open and click history stored for one recipient?”

“Can I record a reason when wiping a subscriber's action data?”

Tell an agent destructive · confirm first

Wipe all action data for recipient {recipientKey} in client {clientId}.

Delete the history of recipient {recipientKey} with reason {reason}.

POST /{clientId}/recipients/updaterecipientid Change a recipient's ID · Update a recipient ID #

Ask an LLM

“A subscriber changed their email; how do I rename their recipient ID?”

“Can I swap an existing recipient ID for a new one?”

Tell an agent

Change recipient ID {recipientId} to {newRecipientId}.

Rename recipient {recipientId} to new ID {newRecipientId} for client {clientId}.

Optimizely Recipients API

Operations 20

Documentation

Specifications

Other Resources

Work with this as data

MCP server

Tools for apis

Call it yourself

Get an API key

OpenAPI Specification