GET reference-data/{dataset}/records/{recordid}

Overview

The Reference-Data API permits interaction with existing custom data tables associated with your company.  You can use the GET /v2/reference-data/{dataset}/records/{recordid} call to return specified data loaded from other processes for targeting and personalization.

Resource URI

GEThttps://api.yesmail.com/v2/reference-data/{dataset}/records/{id}

Call Description

The GET /reference-data/{dataset}/records/{recordid} call returns the reference data associated with {id} from the specified {dataset}. {id} can be a single or composite key. If it's a compostite key then the key should be formed in alphabetical order using a | delimiter,e.g. a|b|c.

Parameters

Parameter

Required

Description

dataset

Yes

The specific dataset where reference data associated with an id exists.

id

Yes

The id or primary key associated with reference data that is to be returned.

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, or the specified record does not exist within the dataset.

 

Response Payload: 
{
    "payloadId": "00003089-1770",
    "itemNumber": "32948",
    "name": "Artisan Goodtime Openback",
    "itemUrl": "https://banjo.com/product/the-artisan-goodtime-openback/",
    "itemPrice": "729.00"
}