| name | data type | constraints | description |
|---|---|---|---|
| id | number | ||
| status | CampaignStatusEnum | ||
| code | string | required, max size: 255, min size: 1 | |
| referenceDescription | string | ||
| notified | boolean | ||
| processingThreadId | number | ||
| messages | array of Message | ||
| transient | boolean | ||
| codeChanged | boolean | ||
| descriptionOrCode | string | ||
| media | MediaEnum | ||
| referenceCode | string | ||
| priority | PriorityEnum | ||
| historized | boolean | ||
| endDate | number | ||
| startDate | number | ||
| parentEntityType | object | ||
| appendGeneratedCode | boolean | ||
| auditableFields | array of AuditableFieldHistory | ||
| description | string | max size: 255, min size: 0 | |
| scheduleDate | number | ||
| subMedia | string | ||
| parentEntity | BusinessEntity | ||
| descriptionAndCode | string | ||
| version | number | ||
| auditable | Auditable | ||
| useAnyMedia | boolean |
Example
{
"id" : 12345,
"status" : "RUNNING",
"code" : "...",
"referenceDescription" : "...",
"notified" : true,
"processingThreadId" : 12345,
"messages" : [ {
"transient" : true,
"subMedia" : "...",
"templateCode" : "...",
"parameters" : [ {
"notified" : true,
"id" : 12345,
"referenceCode" : "...",
"parentEntity" : { },
"message" : { },
"descriptionAndCode" : "...",
"value" : "...",
"auditableFields" : [ { }, { } ],
"referenceDescription" : "...",
"auditable" : { },
"descriptionOrCode" : "...",
"historized" : true,
"appendGeneratedCode" : true,
"code" : "...",
"parentEntityType" : { },
"description" : "...",
"transient" : true,
"version" : 12345,
"codeChanged" : true
}, {
"notified" : true,
"id" : 12345,
"referenceCode" : "...",
"parentEntity" : { },
"message" : { },
"descriptionAndCode" : "...",
"value" : "...",
"auditableFields" : [ { }, { } ],
"referenceDescription" : "...",
"auditable" : { },
"descriptionOrCode" : "...",
"historized" : true,
"appendGeneratedCode" : true,
"code" : "...",
"parentEntityType" : { },
"description" : "...",
"transient" : true,
"version" : 12345,
"codeChanged" : true
} ],
"rejectionReason" : "...",
"id" : 12345,
"version" : 12345,
"campaign" : {
"id" : 12345,
"status" : "TERMINATED",
"code" : "...",
"referenceDescription" : "...",
"notified" : true,
"processingThreadId" : 12345,
"messages" : [ { }, { } ],
"transient" : true,
"codeChanged" : true,
"descriptionOrCode" : "...",
"media" : "FAX",
"referenceCode" : "...",
"priority" : "SLOW",
"historized" : true,
"endDate" : 12345,
"startDate" : 12345,
"parentEntityType" : { },
"appendGeneratedCode" : true,
"auditableFields" : [ { }, { } ],
"description" : "...",
"scheduleDate" : 12345,
"subMedia" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"auditable" : { },
"useAnyMedia" : true
},
"priority" : "SLOW",
"contact" : {
"auditable" : { },
"socialIdentifier" : "...",
"cfValues" : { },
"messages" : [ { }, { } ],
"enterprise" : true,
"auditableFields" : [ { }, { } ],
"externalRef1" : "...",
"vip" : true,
"notified" : true,
"cfAccumulatedValues" : { },
"addressBook" : { },
"descriptionAndCode" : "...",
"contactPolicy" : { },
"parentCFEntities" : [ { }, { } ],
"descriptionOrCode" : "...",
"address" : { },
"name" : { },
"historized" : true,
"externalRef2" : "...",
"code" : "...",
"parentEntity" : { },
"codeChanged" : true,
"referenceCode" : "...",
"jobTitle" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"comment" : "...",
"assistantPhone" : "...",
"registrationNo" : "...",
"primaryContact" : { },
"importedFrom" : "...",
"importedBy" : "...",
"parentEntityType" : { },
"referenceDescription" : "...",
"contactInformation" : { },
"contactInformationNullSafe" : { },
"addressBookContacts" : [ { }, { } ],
"appendGeneratedCode" : true,
"company" : "...",
"uuid" : "...",
"position" : "...",
"legalEntityType" : { },
"transient" : true,
"reference" : "...",
"agreedToUA" : true,
"tags" : [ "...", "..." ],
"websiteUrl" : "...",
"prospect" : true,
"assistantName" : "...",
"contactCategories" : [ { }, { } ],
"isCompany" : true,
"vatNo" : "..."
},
"media" : "POSTAL_MAIL",
"status" : "TREATED"
}, {
"transient" : true,
"subMedia" : "...",
"templateCode" : "...",
"parameters" : [ {
"notified" : true,
"id" : 12345,
"referenceCode" : "...",
"parentEntity" : { },
"message" : { },
"descriptionAndCode" : "...",
"value" : "...",
"auditableFields" : [ { }, { } ],
"referenceDescription" : "...",
"auditable" : { },
"descriptionOrCode" : "...",
"historized" : true,
"appendGeneratedCode" : true,
"code" : "...",
"parentEntityType" : { },
"description" : "...",
"transient" : true,
"version" : 12345,
"codeChanged" : true
}, {
"notified" : true,
"id" : 12345,
"referenceCode" : "...",
"parentEntity" : { },
"message" : { },
"descriptionAndCode" : "...",
"value" : "...",
"auditableFields" : [ { }, { } ],
"referenceDescription" : "...",
"auditable" : { },
"descriptionOrCode" : "...",
"historized" : true,
"appendGeneratedCode" : true,
"code" : "...",
"parentEntityType" : { },
"description" : "...",
"transient" : true,
"version" : 12345,
"codeChanged" : true
} ],
"rejectionReason" : "...",
"id" : 12345,
"version" : 12345,
"campaign" : {
"id" : 12345,
"status" : "PAUSED",
"code" : "...",
"referenceDescription" : "...",
"notified" : true,
"processingThreadId" : 12345,
"messages" : [ { }, { } ],
"transient" : true,
"codeChanged" : true,
"descriptionOrCode" : "...",
"media" : "DUNNING_MEDIA",
"referenceCode" : "...",
"priority" : "SLOW",
"historized" : true,
"endDate" : 12345,
"startDate" : 12345,
"parentEntityType" : { },
"appendGeneratedCode" : true,
"auditableFields" : [ { }, { } ],
"description" : "...",
"scheduleDate" : 12345,
"subMedia" : "...",
"parentEntity" : { },
"descriptionAndCode" : "...",
"version" : 12345,
"auditable" : { },
"useAnyMedia" : true
},
"priority" : "SLOW",
"contact" : {
"auditable" : { },
"socialIdentifier" : "...",
"cfValues" : { },
"messages" : [ { }, { } ],
"enterprise" : true,
"auditableFields" : [ { }, { } ],
"externalRef1" : "...",
"vip" : true,
"notified" : true,
"cfAccumulatedValues" : { },
"addressBook" : { },
"descriptionAndCode" : "...",
"contactPolicy" : { },
"parentCFEntities" : [ { }, { } ],
"descriptionOrCode" : "...",
"address" : { },
"name" : { },
"historized" : true,
"externalRef2" : "...",
"code" : "...",
"parentEntity" : { },
"codeChanged" : true,
"referenceCode" : "...",
"jobTitle" : "...",
"description" : "...",
"id" : 12345,
"version" : 12345,
"comment" : "...",
"assistantPhone" : "...",
"registrationNo" : "...",
"primaryContact" : { },
"importedFrom" : "...",
"importedBy" : "...",
"parentEntityType" : { },
"referenceDescription" : "...",
"contactInformation" : { },
"contactInformationNullSafe" : { },
"addressBookContacts" : [ { }, { } ],
"appendGeneratedCode" : true,
"company" : "...",
"uuid" : "...",
"position" : "...",
"legalEntityType" : { },
"transient" : true,
"reference" : "...",
"agreedToUA" : true,
"tags" : [ "...", "..." ],
"websiteUrl" : "...",
"prospect" : true,
"assistantName" : "...",
"contactCategories" : [ { }, { } ],
"isCompany" : true,
"vatNo" : "..."
},
"media" : "QUEUE",
"status" : "REJECTED"
} ],
"transient" : true,
"codeChanged" : true,
"descriptionOrCode" : "...",
"media" : "POSTAL_MAIL",
"referenceCode" : "...",
"priority" : "SLOW",
"historized" : true,
"endDate" : 12345,
"startDate" : 12345,
"parentEntityType" : { },
"appendGeneratedCode" : true,
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "RENEWAL",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "OTHER",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ],
"description" : "...",
"scheduleDate" : 12345,
"subMedia" : "...",
"parentEntity" : {
"descriptionOrCode" : "...",
"auditableFields" : [ {
"historized" : true,
"notified" : true,
"auditType" : "RENEWAL",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
}, {
"historized" : true,
"notified" : true,
"auditType" : "OTHER",
"historable" : true,
"fieldName" : "...",
"currentState" : { },
"notfiable" : true,
"previousState" : { }
} ],
"version" : 12345,
"historized" : true,
"appendGeneratedCode" : true,
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"parentEntity" : { },
"parentEntityType" : { },
"description" : "...",
"referenceDescription" : "...",
"codeChanged" : true,
"referenceCode" : "...",
"code" : "...",
"transient" : true,
"descriptionAndCode" : "...",
"id" : 12345,
"notified" : true
},
"descriptionAndCode" : "...",
"version" : 12345,
"auditable" : {
"lastModified" : 12345,
"updated" : 12345,
"updater" : "...",
"created" : 12345,
"creator" : "...",
"lastUser" : "..."
},
"useAnyMedia" : true
}