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

Get information about a recipient

Get detailed information about a recipient, such as recipient ID, creation date and modification date.

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

Client ID

string
required

Recipient ID (usually the email address)

int64
required

Recipient list ID

Query Params
attributeNames
array of strings

Comma-separated names of the fields whose recipient data is to be retrieved. Example: "firstname,lastname".

Note: You must use the internal names of the recipient list fields.
To retrieve the attribute names of a recipient list, use the getRecipientListAttributeNames operation.

attributeNames
boolean

Specify whether the opt-in data fields should be returned. Only applicable for opt-in list

Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

404

The recipient could not be found. Ensure that the required parameters such as "recipientId" and "recipientListId" are correct and the recipient exists.

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