Dev GuideAPI ReferenceUser Guide
Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference
NuGetDev CommunityOptimizely AcademySubmit a ticket

Add a recipient to a recipient list. Double opt-in processes will not be overwritten by other opt-in processes (see <a href="https://support.optimizely.com/hc/en-us/articles/4413192291981#prioritization">Opt-in documentation</a>).

post
https://api.campaign.episerver.net/rest//recipients/
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
int64
required

Client ID

int64
required

Recipient list ID

Form Data
boolean
Defaults to false

Retrieve the mail ID for an opt-in process of type "double" or "confirmed"

string

Address of the recipient. Required if ID attribute differs from the address.

string

Recipient data. Configure "data.[attribute]" according to the corresponding recipient list field.

Does not work with the "Try it out" feature.

int64

ID of the opt-in process

string
required

Recipient ID (usually the email address)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

The required parameters for the recipient's creation are not provided. Ensure that "clientId", "recipientListId" and "recipientId" are added to the request.

409

The recipient has either been blacklisted, has exceeded the bounce limit, has unsubscribed, or exists already. Ensure that "recipientId" is correct and that the recipient does not meet any of the other criteria.

Updated 8 months ago

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/vnd.optivo.broadmail.v1+json

Updated 8 months ago