Create

Create a campaign (also called sub-project)

ParameterMandatoryDescriptionExamplesMore Info
APIYesThe API areacampaigns.json
GeneralYesParameters described in overviewuser=user&password=userStructure of an API call
ActionYesThe action to performaction=create
InputYesJSON stringSee below
JSON InputMandatoryDescriptionExamples
CompanyYesCampaign company"campaignCompany":1
Campaign nameYesCampaign name"campaignName": "Client project campaing 2025"
Client CodeNoClient code. Only pass a client code if you want the new campaign to be associated with a client"projectClientCode":"43/ANIM4"
Project NoNoProject number"campaignProjectNo":617

Example request:

creating campaing with a client & project
https://<SERVER>/jsonapi/campaigns.json?version=4&user=user&password=user&action=create&input={
  "data": [
    {
      "campaignName": "Client project campaing 2025",
      "campaignCompany": 1,
      "campaignClientCode": "43/ANIM4",
      "campaignProjectNo": 617

    }
  ]
}

Example response:

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