POST /v1/syndication_instruction

HTTP Method: POST

Path: /v1/syndication_instruction

Authentication: API Key required

Description: This API call is used to insert an instruction to syndicate a business record to one or more publishing partners.

For the instruction to be valid:

• The business record must exist (inserted via PUT /business/json

• The publisher(s) name must be valid

Parameters

API response

For a valid business, the API response will always be success = true, but it may contain failures if one or more of the supplied publishers is not recognised.

{
 "success": true,
 "data": {
   "successes": [
     "bing",
     "centralindex"
   ],
   "failures": [
     {
       "bong": [
          "Sorry, publisher bong is not in your list of approved publishers"
       ]
     }
   ]
 }
}

Error API response

{

"success": false,

"errors": [

    "This business does not exist in the collection"

]

}