Retrieve List Recipient using query attribute
get
/rest/api/v1.3/lists/{listName}/members
Request
Supported Media Types
- application/x-www-form-urlencoded
Path Parameters
-
listName: string
List Name
Query Parameters
-
fs: string
Comma separated list of fields to retrieve or 'all'
-
id: string
ID corresponding to the query attribute
-
qa: string
Query Attribute. Can be either 'r' (RIID_), 'e' (EMAIL_ADDRESS_), 'c' (CUSTOMER_ID_), or 'm' (MOBILE_NUMBER_).
Response
Supported Media Types
- application/json
Default Response
Root Schema : Profile List Recipients
Type:
object
Title:
Show Source
Profile List Recipients
-
mergeRule:
object mergeRule
Merge rule used to merge recipient records in a Profile List. Only used during the merge operation.
-
recordData:
object recordData
Record data that represents Field Names and corresponding values for the recipient.
Nested Schema : mergeRule
Type:
object
Merge rule used to merge recipient records in a Profile List. Only used during the merge operation.
Show Source
-
defaultPermissionStatus(optional):
string
Allowed Values:
[ "OPTIN", "OPTOUT" ]
This value must be specified as either OPTIN or OPTOUT and would be applied to all of the records contained in the API call. If this value is not explicitly specified, then it is set to OPTOUT. -
htmlValue(optional):
string
Value of incoming preferred email format data. For example, 'H' may represent a preference for HTML formatted email.
-
insertOnNoMatch(optional):
boolean
Indicates what should be done for records where a match is not found (true = insert / false = no insert).
-
matchColumnName1(optional):
string
Allowed Values:
[ "RIID_", "CUSTOMER_ID_", "EMAIL_ADDRESS_", "MOBILE_NUMBER_", "EMAIL_MD5_HASH_", "EMAIL_SHA256_HASH_" ]
First match column for determining whether an insert or update should occur. -
matchColumnName2(optional):
string
Allowed Values:
[ "RIID_", "CUSTOMER_ID_", "EMAIL_ADDRESS_", "MOBILE_NUMBER_", "EMAIL_MD5_HASH_", "EMAIL_SHA256_HASH_" ]
Second match column for determining whether an insert or update should occur. (optional). -
matchOperator(optional):
string
Allowed Values:
[ "NONE", "AND" ]
Operator to join match column names -
optinValue(optional):
string
Value of incoming opt-in status data that represents an opt-in status. For example, 'I' may represent an opt-in status.
-
optoutValue(optional):
string
Value of incoming opt-out status data that represents an optout status. For example, '0' may represent an opt-out status.
-
rejectRecordIfChannelEmpty(optional):
string
String containing comma-separated channel codes that if specified will result in record rejection when the channel address field is null. Channel codes are 'E' (Email), 'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has a null for Email or Mobile Number value should be rejected. This parameter can also be set to null or to an empty string, which will cause the validation to not be performed for any channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_. When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty string setting is effectively ignored for that channel.
-
textValue(optional):
string
Value of incoming preferred email format data. For example, 'T' may represent a preference for Text formatted email.
-
updateOnMatch(optional):
string
Allowed Values:
[ "REPLACE_ALL", "NO_UPDATE" ]
Controls how the existing record should be updated.
Nested Schema : recordData
Type:
object
Record data that represents Field Names and corresponding values for the recipient.
Show Source
-
fieldNames:
array fieldNames
Field Names in the Profile List
-
mapTemplateName(optional):
string
The Map Template in CX Audience that can be used to map Field Names of the Profile List to Column Names.
-
records:
array records
Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.
Nested Schema : records
Type:
array
Array of values corresponding to the fieldNames. Each element in the array represents a single recipient.
Show Source
-
Array of:
array items
Field Values for the recipient in the Profile List
Examples
Existing members of a profile list can be retrieved one at a time by using a query attribute if the Responsys ID (RIID) for the member is not available. Please note that the total length of the string passed in for the fs parameter (containing the comma separated field names) cannot exceed 150 characters. To retrieve values of all columns, you can specify only one field with value set to "all" (if you have a column called "all", you should use two or more specific column names to avoid getting all of the columns).
FIELDS | DESCRIPTION |
---|---|
Authorization | <AUTH_TOKEN> |
FIELDS | DESCRIPTION |
---|---|
qa | Can be either "r" (RIID), "e" (EMAIL_ADDRESS), "c" (CUSTOMER_ID), or "m" (MOBILE_NUMBER) |
id | ID corresponding to the query attribute |
fs | Comma separated field list or "all" |
Sample Request URL:
/rest/api/v1.3/lists/DemoNewsLetterList/members?qa=m&fs=riid_,email_address_,customer_id_&id=9845349498;
Sample Response:Success
NOTE: Other attributes in the response like mapTemplateName and mergeRule will have default values of null/false
{ "recordData": { "fieldNames": [ "RIID_", "EMAIL_ADDRESS_", "CUSTOMER_ID_" ], "records": [ [ "4094330", "ab.na@gmail.com", null ], [ "4094326", "ab.cd@gmail.com", null ] ], "mapTemplateName": null }, "mergeRule": { "textValue": null, "insertOnNoMatch": false, "updateOnMatch": null, "matchOperator": null, "matchColumnName3": null, "matchColumnName1": null, "matchColumnName2": null, "optinValue": null, "optoutValue": null, "rejectRecordIfChannelEmpty": null, "htmlValue": null, "defaultPermissionStatus": null }, "links": [ { "rel": "self", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/members?qa=m&fs=riid_,email_address_,customer_id_&id=9845349498", "method": "GET" }, { "rel": "mergeListRecipients", "href": "/rest/api/v1.3/lists/DemoNewsLetterList/members", "method": "POST" } ] }
Example Response:Failure
{ "type": "", "title": "Invalid field name", "errorCode": "INVALID_FIELD_NAME", "detail": "Column(s) [CUSTOMER_ID] not found in the list", "errorDetails": [] }