GET reference-data/{dataset}?view=schema

Overview

The Reference-Data API permits interaction with existing custom data tables associated with your company.  You can use the API's GET /v2/reference-data/{dataset}?view=schema call to return the attributes that are available in the custom data table arrays for the specified Api-User.

Resource URI

GET https://api.yesmail.com/v2/reference-data/{dataset}?view=schema

Call Description

The GET reference-data/{dataset}?view=schema call returns the attributes that are available in the custom data table arrays for the specified Api-User.

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.

404 Not Found

The specified dataset does not exist.

 

 

Response Payload: 
{ 
    "datasetName": [
        {
            "attributeName": "firstAtribute",
            "dataType": "string",
            "length": 15
        },
        {
            "attributeName": "secondAttribute",
            "dataType": "string",
             "length": 20
        },
       <...additional attributes...>
    ]       
}