REST API for Unica Campabign offer lists

Description

APIs for offer lists in Unica Campaign.

Methods

get: /v1/offerlist
getOfferListDetails Returns the list of OfferLists
Gives the list of OfferList details.

Parameters

listRefID (optional)
Query Parameter — Returns the offerlists details for these offerlist references.

Return type

ComponentOrFolderInfo

Example result

Content-Type: application/json
{
  "staticListMembers" : [ 123456789 ],
  "creatorFlag" : 123,
  "componentCode" : "aeiou",
  "compositeRefIds" : "aeiou",
  "parentFolderId" : 123456789,
  "description" : "aeiou",
  "securityPolicy" : "aeiou",
  "smartList" : true,
  "reference" : {
    "componentTypeEnum" : "",
    "id" : 123456789
  },
  "retiredList" : true,
  "creatorObjectId" : 123456789,
  "name" : "aeiou",
  "attributes" : "",
  "smartListInfo" : {
    "includeSubFolder" : true,
    "query" : "aeiou",
    "maxSize" : 123,
    "scopeFolders" : [ "{}" ]
  }
}
put: /v1/offerlist
updateOfferList Updates the OfferList
Updates the given OfferLists.

Parameters

listRefID (optional)
Form Parameter — OfferList reference id.
name (optional)
Form Parameter — New name of OfferList.
description (optional)
Form Parameter — New description of OfferList.
isSmartList (optional)
Form Parameter — Is this a smart OfferList? Indicates whether list is smart or static.
listMembers (optional)
Form Parameter — New OfferList members.
smartOfferListInfoJSON (optional)
Form Parameter — New smart OfferList details.
creatorObjectId (optional)
Form Parameter — Creator Object Id is used to link a folder in Unica Campaign with a folder in HCL Plan.
clearExisting (optional)
Form Parameter — Indicates whether existing information must be cleared. If true, existing list members are cleared before adding new members. If false, new members are appended to existing members.

Return type

String

Example result

Content-Type: application/json
"aeiou"
post: /v1/offerlist
createOfferList Creates OfferList
Creates OfferList with given data.

Parameters

name (optional)
Form Parameter — Name of new OfferList.
description (optional)
Form Parameter — Description of new OfferList.
securityPolicy (optional)
Form Parameter — Security policy of new OfferList.
listMembers (optional)
Form Parameter — Member offers of new OfferList.
folderid (optional)
Form Parameter — FolderId of new OfferList.
owner (optional)
Form Parameter — Owner of new OfferList.
creatorObjectId (optional)
Form Parameter — Creator Object Id.

Return type

Long

Example result

Content-Type: application/json
123456789
post: /v1/offerlist/createSmartOffer
createSmartOfferList Creates smart OfferList
Creates smart OfferList with given data.

Parameters

name (optional)
Form Parameter — Name of new OfferList.
description (optional)
Form Parameter — Description of new OfferList.
securityPolicy (optional)
Form Parameter — Security policy of new OfferList.
smartOfferListInfoJSON (optional)
Form Parameter — Smart Offer list details of new OfferList.
folderid (optional)
Form Parameter — FolderId of new OfferList.
owner (optional)
Form Parameter — Owner of new OfferList.
creatorObjectId (optional)
Form Parameter — Creator object Id.

Return type

Long

Example result

Content-Type: application/json
123456789
post: /v1/offerlist/delete
deleteOffersAndLists Deletes OfferLists
Deletes offerlists in bulk.

Parameters

listRefIDs (optional)
Form Parameter — OfferList references of the OfferLists to be deleted.

Return type

array[Reference]

Example result

Content-Type: application/json
[ {
  "componentTypeEnum" : "",
  "id" : 123456789
} ]
post: /v1/offerlist/retire
retireOfferLists Retires OfferLists
Retires one or more offerlists in bulk.

Parameters

listRefIDs (optional)
Form Parameter — OfferList references of the OfferLists to be retired.

Return type

String

Example result

Content-Type: application/json
"aeiou"

Return types

SmartListInfo

query
String
maxSize
Integer
includeSubFolder
Boolean
scopeFolders
array[Object]

ComponentOrFolderInfo

retiredList
Boolean
compositeRefIds
String
creatorObjectId
Long
creatorFlag
Integer
name
String
attributes
Map[string,IAttribute]
description
String
reference
Reference
securityPolicy
String
smartList
Boolean
componentCode
String
smartListInfo
SmartListInfo
staticListMembers
array[Long]
parentFolderId
Long

Reference

componentTypeEnum
ComponentTypeEnum
id
Long

List

empty
Boolean