Create a campaign (also called sub-project)
Parameter | Mandatory | Description | Examples | More Info |
---|---|---|---|---|
API | Yes | The API area | campaigns.json | |
General | Yes | Parameters described in overview | user=user&password=user | Structure of an API call |
Action | Yes | The action to perform | action=create | |
Input | Yes | JSON string | See below |
JSON Input | Mandatory | Description | Examples |
---|---|---|---|
Company | Yes | Campaign company | "campaignCompany":1 |
Campaign name | Yes | Campaign name | "campaignName": "Client project campaing 2025" |
Client Code | No | Client code. Only pass a client code if you want the new campaign to be associated with a client | "projectClientCode":"43/ANIM4" |
Project No | No | Project 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
}
]
}