Campaign Create and Update

Create Campaign

Usage: POST /data/campaign/type/{type}

Type can be either:

  • normal

  • event

  • recurring

  • subscribe

  • unsubscribe


POST Data

{
"name":"Micro Campaign-33",
"description":"Micro Campaign-33 Description",
"type":"3",
"departmentID":"100",
"quietLevel":"CAMPAIGN",
"conversationID":"120",
"event":
{
"name":"MyEvent-33",
"description":"MyEventDescription",
"parameters":
[
{"name":"Amount",
"dataType":"3",
"forwarded":"false"},
{"name":"Date",
"dataType":"93",
"forwarded":"false"},
{"name":"Merchant",
"dataType":"12",
"forwarded":"false"
}
]
}
}

Returns the new Campaign object

Example JSON Response Data

{
"id":220,
"name":"Micro Campaign-33",
"description":"Micro Campaign-33 Description",
"type":3,
"departmentID":100,
"quietLevel":"CAMPAIGN",
"languageID":1,
"mailFarmID":1,
"expirationDate":null,
"conversationID":120,
"audienceModelID":1,
"segmentModelID":1,
"priority":25,
"bounce":false,
"event":
{"id":200,
"name":"MyEvent-33",
"description":"MyEventDescription",
"parameters":
[
{"name":"Amount",
"dataType":3,
"forwarded":false},
{"name":"Date",
"dataType":93,
"forwarded":false},
{"name":"Merchant",
"dataType":12,
"forwarded":false}],
"includeXml":false}
}

Update Campaign By ID

Usage: PUT /data/campaign/id/{campaign id}/type/{type}

PUT Data

{
"id":220,
"name":"Micro Campaign-33",
"description":"Micro Campaign-33 Description",
"type":"3",
"departmentID":"100",
"quietLevel":"CAMPAIGN",
"conversationID":"140"
}

Saves the Campaign object to the database and returns the updated object.

Example JSON Response Data

{
"id":220,
"name":"Micro Campaign-33",
"description":"Micro Campaign-33544 Description",
"type":3,
"departmentID":100,
"languageID":1,
"mailFarmID":1,
"expirationDate":null,
"conversationID":140,
"audienceModelID":1,
"segmentModelID":1,
"priority":25,
"bounce":false,
"event":
{"id":200,
"name":"MyEvent-33",
"description":"MyEventDescription",
"parameters":
[
{"name":"Amount",
"dataType":3,
"forwarded":false},
{"name":"Date",
"dataType":93,
"forwarded":false},
{"name":"Merchant",
"dataType":12,
"forwarded":false}
],
"includeXml":false}
}