Delete

Delete a campaign

Delete

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areacampaigns.json
GeneralYesParameters described in overviewAuthorization: Bearer <access_token> header — see Synergist API AuthenticationStructure of an API call
ActionYesThe action to performaction=delete
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
Campaign UUIDYesUUID"campaignUuid": "13B75CD3006D53409543A5BFFB4DA067"

Example request (OAuth 2.0):

Deleting a campaign
Authorization: Bearer <access_token>
https://<SERVER>/jsonapi/campaigns.json?version=6&&action=delete&input={
  "data": [
    {

   "campaignUuid": "13B75CD3006D53409543A5BFFB4DA067"

    }
  ]
}

Example request (legacy username/password):

https://<SERVER>/jsonapi/campaigns.json?version=6&&action=delete&input={
  "data": [
    {

   "campaignUuid": "13B75CD3006D53409543A5BFFB4DA067"

    }
  ]
}&user=<username>&password=<password>

Example response:

{
  "responsecode": 1,
  "responsestatus": "OK",
  "errorcode": 0,
  "errormessage": "",
  "responsemessage": "data processed successfully.",
  "warningmessage": "",
  "success": true,
  "synversion": "15.000.0026",
  "synapiversion": 6,
  "data": [
    {
      "campaignUuid": "13B75CD3006D53409543A5BFFB4DA067",
      "campaignNo": 432
    }
  ]
}