POST api/cms/ExecutePIMSync

Triggers a PIM sync from Salsify to data.hearthnhome.com. Authorization required.

Request Information

URI Parameters

None.

Body Parameters

PIMSyncRequest

None.

Request Formats

application/json, text/json

Sample: 
{}

application/xml, text/xml

Sample: 
<PIMSyncRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.CMS" />

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'PIMSyncRequest'.

Response Information

Resource Description

PIMSyncResponse
NameDescriptionTypeAdditional information
Success

boolean

None.
Message

string

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Message": "sample string 2"
}

application/xml, text/xml

Sample: 
<PIMSyncResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/data.hearthnhome.Models.CMS">
  <Message>sample string 2</Message>
  <Success>true</Success>
</PIMSyncResponse>