YM REST Services

<back to all web services

MarkupRender

Requires Authentication
Requires any of the roles:admin, oauthadmin
The following routes are available for this service:
POST/Ams/{ClientID}/MarkupRenderRender markup from MarkupId and store it in the corresponding destination (email campaign, custom page, content area, etc).
GET/Ams/{ClientID}/MarkupRender/{MarkupId}Render markup from MarkupId for Preview Only. Does not update page or campaign.
MarkupRender Parameters:
NameParameterData TypeRequiredDescription
MarkupIdpathintNo
BaseDto Parameters:
NameParameterData TypeRequiredDescription
UsingRedisformboolNo
AppInitTimeformDateTimeNo
ServerIDformstringNo
BaseSharedDto Parameters:
NameParameterData TypeRequiredDescription
ClientIDformintNo
ResponseStatusformResponseStatusNo
BypassCacheformboolNo
DateCachedformDateTimeNo
DeviceformDeviceNo
MarkupRenderResponse Parameters:
NameParameterData TypeRequiredDescription
ContentformstringNo
MarkupTypeformMarkupTypeNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /Ams/{ClientID}/MarkupRender HTTP/1.1 
Host: ws.yourmembership.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"MarkupId":0,"UsingRedis":true,"AppInitTime":"2024-05-03T08:16:34.0403300-04:00","ServerID":"WS-5-31-738","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T08:43:48.7422534-04:00","Device":"Desktop"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Content":"String","MarkupType":"None","MarkupId":0,"UsingRedis":true,"AppInitTime":"2024-05-03T08:16:34.0403300-04:00","ServerID":"WS-5-31-738","ClientID":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"BypassCache":false,"DateCached":"2024-05-03T08:43:48.7422534-04:00","Device":"Desktop"}