Update

Parameter	Mandatory	Description	Examples	More Info
API	Yes	The API area	campaigns.json
General	Yes	Parameters described in overview	`Authorization: Bearer <access_token>` header — see Synergist API Authentication	Structure of an API call
Action	Yes	The action to perform	action=update
Input	Yes	JSON string	See below

JSON Input	Mandatory	Description	Examples
Company	Yes	Campaign company	"campaignCompany":1
Campaign name	No	Campaign name	"campaignName":"New Name from API"

Example request (OAuth 2.0):

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

   "campaignUuid": "13B75CD3006D53409543A5BFFB4DA067",
   "campaignName": "New Name from API"

    }
  ]
}

Example request (legacy username/password):

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

   "campaignUuid": "13B75CD3006D53409543A5BFFB4DA067",
   "campaignName": "New Name from API"

    }
  ]
}&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": 431,
      "campaignTimeStampModified": 1753871743,
      "campaignRecordVersionNumber": 1
    }
  ]
}