GET target-lists?view=schema

Overview

Target Lists can be set-up with personalization data that can be used for a variety of lists. GET target-lists?view=schema returns all the personalization data types that are available for the specified Api-User (company). Any target list can use none or all of the personalization data types created. The values for a subscriber on a list are specific for that list.

For each attribute the name, type, and length are returned in the response payload. 

Standard Attributes:

  • String
  • Number
  • Date - MM/dd/yyyy HH:mm:ss
  • Boolean

Resource URI

GET https://api.yesmail.com/v2/target-lists?view=schema

Call Description

The GET target-lists?view=schema call returns the list load attributes that are available for the specified company If the targetList array is empty in the response then personalization has not been set-up for that company.

HTTP Return Codes

Code

Description

200 OK

The request has succeeded.

401 Unauthorized

The request requires user authentication.  Invalid Api-User and/or Api-Key header value.
Response Payload: 
{
    "targetList": [
        {
            "attributeName": "GENERICATTRIBUTE00",
            "dataType": "String",
            "length": 100,
            "required": false
        },
        {
            "attributeName": "GENERICATTRIBUTE01",
            "dataType": "String",
            "length": 100,
            "required": false
        },
        {
            "attributeName": "GENERICATTRIBUTE02",
            "dataType": "String",
            "length": 100,
            "required": false
        },
        {
            "attributeName": "GENERICATTRIBUTE03",
            "dataType": "String",
            "length": 100,
            "required": false
        },
        {
            "attributeName": "GENERICATTRIBUTE04",
            "dataType": "String",
            "length": 4000,
            "required": false
        },
        {
            "attributeName": "GENERICATTRIBUTE05",
            "dataType": "String",
            "length": 4000,
            "required": false
        },
        {
            "attributeName": "ORDER_URI",
            "dataType": "String",
            "length": 4000,
            "required": false
        },
        {
            "attributeName": "ORDER_IMAGE",
            "dataType": "String",
            "length": 4000,
            "required": false
        },
        {
            "attributeName": "ORDER_DESCRIPTION",
            "dataType": "String",
            "length": 100,
            "required": false
        },
        {
            "attributeName": "ORDER_AMOUNT",
            "dataType": "String",
            "length": 100,
            "required": false
        }
    ]
}