Dev GuideAPI Reference
Dev GuideAPI ReferenceUser GuideNuGetDev CommunityOptimizely AcademySubmit a ticketLog In
API Reference

Add recipients to the internal unsubscribe list or unsubscribe recipients (max. 5000)

Add multiple recipients to a unsubscribe list or unsubscribe multiple recipients based on mailing IDs.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required

Client ID

Form Data
recipientIds
array of strings

Comma-separated list of recipient IDs (only required if the "mailIds" parameter is not specified)

recipientIds
string
enum

Media type of the delivery channel

Allowed:
mailIds
array of strings

Comma-separated list of mail IDs (only required if the "recipientIds" parameter is not specified)

mailIds
int64

ID of the recipient list to which the recipients are assigned (only if recipient list based unsubscribe is set)

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

400

The recipients could not be unsubscribed. Ensure that you did not exceed the limit of 5000 IDs.

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