PUT 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 API's PUT /v2/reference-data/{dataset}/records/{recordid} call to add to or modify specified data loaded from other processes for targeting and personalization.

Resource URI

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

Call Description

The/reference-data/{dataset}/records/{recordid} call adds or modifies 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 to be added to or modified exists.

recordid

Yes

The specific id or primary key associated with reference data that is to be added to or modified.

HTTP Return Codes

Code

Description

200 OK

The request has succeeded.

201 Created

The resource (e.g. new subscriber) has been created successfully.

400 Bad Request The request could not be understood by the server due to malformed syntax.  For example, incorrect syntax of parameters, invalid parameter values, subscriber attribute does not exist, missing email address for new subscriber, or subscriber email address fails superficial validation.

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.

409 Conflict

This occurs when the If-Match condition is used, and the specified ETag does not match the current ETag for the resource.

 

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