Campaign Designer

The Campaign Designer Engine helps a user to create or update any campaign. The Campaign Designer Engine contains four submodules that help you to perform the following set of actions:

  • To capture basic details of campaign like the name, description, priority, start date, and end date. You can also categorize channels for campaign as offline or online channels.
  • To set target customers and events
    • You can set target audience for the campaign by selecting the available attributes and their values. For example, you can set a campaign targeting an audience whose annual income is above $5000.
    • You can choose an event that can trigger the campaign. For example, upon making a transaction you can trigger a campaign.
  • To provide offline communication details. You can select different modes of offline communication, such as SMS, EMAIL, and PUSH NOTIFICATIONS.
  • To provide online communication details. You can select the online campaign details from pre -configured screens, such as pre-login screen, post login screen, and dashboard.
API Description Introduced In
getPlaceholders This API fetches the pre-configured channel's information such as Web or Mobile and also screen information such as pre-login, post login, and dashboard. 2020.04
getEvents This API fetches all available events. 2020.04
getCampaigns This API fetches all available campaigns . 2020.04
createCampaign This API creates a campaign. 2020.04
updateCampaign This API updates campaign details and status. 2020.04
getProfiles This API fetches all available profiles that are configured. 2020.04
createProfile This API creates a new profile. 2020.04
getAllDefaultCampaigns This API fetches the details of the default campaign. 2020.04
updateDefaultCampaigns This API updates the details of the default campaign. 2020.04
getAndUpdateUsersForSegment This API fetches the active users for a particular segment. 2020.04
updateProfile This API updates the user profile. 2020.07
ClosedgetPlaceholders
 
Description: This API fetches the pre-configured channel's information such as Web or Mobile and also screen information such as pre-login, post login, and dashboard.
Method: GET
URL: {base_url}/services/data/v1/CampaignManagementObjService/operations/campaignmanagement/getPlaceholders
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

placeHolders [ ]

Contains a list of all the placeholders and their properties.

Parameters

placeHolders/placeholderIdentifier

Specifies the screen name information such as PRELOGIN, POSTLOGIN, APPLY_FOR_NEW_ACCOUNT, or ACCOUNT_DASHBOARD.

placeHolders/placeholderId

Specifies the unique ID of the placeholder.

placeHolders/application

Specifies the application name for which the information is being captured for such as “Retail Banking”.

placeHolders/placeholderDescription

Specifies the placeholder information.

placeHolders/placeholderName

Specifies the Screen name such as Homepage. Is applicable for a new account and the account dashboard.

placeHolders/imageSize

Specifies the size of the image.

placeHolders/channelSubType

Specifies the channel Information of the application, such as Mobile or Web.

placeHolders/imageResolution

Specifies the expected resolution of the image.

placeHolders/imageScale

Specifies the scale of the image (1X, 2X).

{
  "placeHolders": [
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH001",
      "application": " RETAIL_BANKING",
      "placeholderDescription": "Sample place holder description",
      "placeholderName": "Homepage",
      "imageSize": "51200",
      "channelSubType": "MOBILE",
      "imageResolution": "375x106",
      "imageScale": "1x"
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH002",
      "application": " RETAIL_BANKING",
      "placeholderDescription": "Sample place holder description",
      "placeholderName": "Homepage",
      "imageSize": "51200",
      "channelSubType": "MOBILE",
      "imageResolution": "750x212",
      "imageScale": "2x"
    }
  ],
  "opstatus": 0,
  "httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: The request is invalid.
  • Error code : 500
    Error message: Error Occurred, Unable to fetch PlaceHolder.
  • Error code : 400
    Error message: Transformation Operation Failed for PlaceHolder.
  • Error code : 400
    Error message: No Record(s) found for the given ID / Criteria.
Associated Enterprise APIs: placeholders
ClosedgetEvents
 
Description: This API fetches all available events.
Method: GET
URL: {base_url}/services/data/v1/CampaignManagementObjService/operations/campaignmanagement/ getEvents
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

eventTriggers [ ]

Contains a list of event triggers that are available.

Parameters

eventTriggers/eventCode

Specifies the unique event code

eventTriggers/eventTriggerId

Specifies the unique event trigger id.

eventTriggers/eventDescription

Specifies the event description.

eventTriggers/eventSource

Specifies the source of the event (Transact/DS)

eventTriggers/eventName

Specifies the name of event

eventTriggers/triggerType

Specifies the type of event (Internal/ External)

 {
  "eventTriggers": [
    {
      "eventCode": "SURPLUSFUNDS",
      "eventTriggerId": "ET001",
      "eventDescription": "Customer has surplus Funds in the selected account",
      "eventSource": "Transact/DS",
      "eventName": "SurplusFunds",
      "triggerType": "External"
    },
    {
      "eventCode": "UPDATEPHONE",
      "eventTriggerId": "ET003",
      "eventDescription": "Customer updated the phone number",
      "eventSource": "Transact/CRM/DS",
      "eventName": "PhoneUpdate",
      "triggerType": "Internal"
    }
  ],
  "opstatus": 0,
  "httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: The request is invalid.
  • Error code : 500
    Error message: Error Occurred, Unable to fetch PlaceHolder.
  • Error code : 400
    Error message: Transformation Operation Failed for PlaceHolder.
  • Error code : 400
    Error message: No Record(s) found for the given ID / Criteria.
Associated Enterprise APIs eventtriggers
ClosedgetCampaigns
 
Description: This API fetches all available campaigns.
Method: POST
URL: {base_url}/services/data/v1/CampaignManagementObjService/operations/campaignmanagement/ getCampaigns
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:
ClosedView the Response Parameters

campaigns[ ]

Contains a list of campaigns.

Parameters

campaigns/campaignType

Specifies the type of campaign.

campaigns/onlineContents

Specifies the online channel that is configured for the campaign.

campaigns/productId

Specifies the product details that are configured for the campaign.

campaigns/endDate

Specifies the end date of the campaign.

campaigns/campaignId

Specifies the unique ID of the campaign

campaigns/channelTypes

Specifies the channel types that are configured for the campaign (Online/Offline)

campaigns/channelSubType

Specifies the channel Information (Mobile/Web).

campaigns/productGroupId

product group details configured for the campaign

campaigns/offlineTemplates

Specifies the offline channels that are configured for the campaign.

campaigns/offlineTemplates/offlineTemplateId

Specifies the unique ID for the offline template

campaigns/offlineTemplates/subject

Specifies the subject that is configured for the offline channel communication.

campaigns/offlineTemplates/channelSubType

Specifies the type of the offline template (SMS/Email/Push notifications).

campaigns/offlineTemplates/content

Specifies the content that must be sent in the offline template.

campaigns/objectiveType

Specifies the objective type of campaign such as Marketing or Informational.

campaigns/campaignPriority

Specifies the priority of the campaign.

campaigns/campaignStatus

Specifies the status of the campaign (active/paused/terminated).

campaigns/eventTriggerDetailss

Specifies the event trigger details for the campaign.

campaigns/eventTriggerDetailss/eventCode

Specifies the unique event code.

campaigns/eventTriggerDetailss/eventTriggerId

Specifies the unique trigger id.

campaigns/eventTriggerDetailss/eventDescription

Specifies the event description.

campaigns/eventTriggerDetailss/eventSource

Specifies the source of the event (Transact/DS).

campaigns/eventTriggerDetailss/eventName

Specifies the name of the event.

campaigns/eventTriggerDetailss/triggerType

Specifies the type of event such as Internal or External.

campaigns/profileDetailss

Specifies the profile details that are configured for a campaign.

campaigns/profileDetailss/profileName

Specifies the profile name.

campaigns/profileDetailss/profileDescription

Specifies the profile description.

campaigns/profileDetailss/profileId

Specifies the unique profile id.

campaigns/profileDetailss/profileConditionss

Specifies the list of profiles configured for campaign.

campaigns/profileDetailss/profileConditionss/conditionExpression

Specifies the condition to query the list of customers applicable for the campaign.

campaigns/profileDetailss/profileConditionss/dataContextName

Specifies the name of the data context on which condition expression is applied.

campaigns/profileDetailss/profileConditionss/dataContextId

Specifies the ID of the data context on which condition expression is applied.

campaigns/profileDetailss/profileConditionss/dataContextEndPoints

Specifies the end point of the data context on which condition expression is applied.

campaigns/profileDetailss/profileConditionss/profileConditionId

Specifies the unique id for the condition.

campaigns/profileDetailss/profileConditionss/dataContextDescription

Specifies the description of the data context on which condition expression is applied.

campaigns/campaignDescription

Specifies the description of the campaign.

campaigns/campaignName

Specifies the name of the campaign.

campaigns/startDate

Specifies the start date of the campaign.

campaigns/channelDetails

Specifies the channel details.

campaigns/channelDetailss/channelPriority

Specifies the priority of the channel.

campaigns/channelDetailss/channelSubType

Specifies the channel type such as SMS, EMAIL, PUSH NOTIFICATIONS, MOBILE, WEB.

NOTE: All the body parameters are mandatory. You can leave the value to the parameter key as blank, but in the request you must mention the param key.

ClosedView the Response Sample Code 
{
  "campaigns": [
    {
      "campaignType": "SINGLE",
      "onlineContents": [],
      "productId": "PERSONAL.LOAN",
      "endDate": "2025-02-19 00:00:00.0",
      "campaignId": "CP001",
      "channelTypes": [
        "OFFLINE"
      ],
      "productGroupId": "PERSONAL.LOANS",
      "offlineTemplates": [
        {
          "offlineTemplateId": "OT2007842019",
          "subject": "Account OVerdrawn ",
          "channelSubType": "SMS",
          "content": "Hello SMS"
        }
      ],
      "objectiveType": "UPSELL",
      "campaignPriority": 13,
      "campaignStatus": "SCHEDULED_ACTIVE_COMPLETED",
      "eventTriggerDetailss": [
        {
          "eventCode": "OVERDRAWNACCOUNT",
          "eventTriggerId": "ET002",
          "eventDescription": "The account in consideration is overdrawn",
          "eventSource": "Transact/DS",
          "eventName": "OverdrawnAccount",
          "triggerType": "External"
        }
      ],
      "profileDetailss": [
        {
          "profileName": "Profile Overdraft",
          "profileDescription": "Profile 5 created for 101003",
          "profileId": "PRF005",
          "profileConditionss": [
            {
              "conditionExpression": "TotalBalance < 1000",
              "dataContextName": "All Customers NBP",
              "dataContextId": "DC001",
              "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP",
              "profileConditionId": "5",
              "dataContextDescription": "This is the next best product recommendation"
            }
          ]
        }
      ],
      "campaignDescription": "Campaign Account Overdrawn",
      "campaignName": "Account Over Drawn",
      "startDate": "2020-03-18 00:00:00.0",
      "channelDetailss": [
        {
          "channelPriority": "2",
          "channelSubType": "WEB"
        },
        {
          "channelPriority": "2",
          "channelSubType": "SMS"
        }
      ]
    }
  ],
  "opstatus": 0,
  "httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: The request is invalid.
  • Error code : 500
    Error message: Error Occurred, Unable to fetch Campaign.
  • Error code : 400
    Error message: Transformation Operation Failed for Campaign.
  • Error code : 400
    Error message: No Record(s) found for the given ID / Criteria.
Associated Enterprise APIs campaigns
ClosedcreateCampaign
 
Description: This API creates a campaign.
Method: POST
URL: {base_url}/services/data/v1/CampaignManagementObjService/operations/campaignmanagement/ createCampaign
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:
ClosedView Body Request Parameters

campaignName

Specifies the name of the campaign.

campaignDescription

Specifies the description of the campaign.

campaignPriority

Specifies the priority of the campaign

startData

Specifies the start date of the campaign.

endData

Specifies the end date of the campaign.

campaignType

Specifies the type of campaign.

objectiveType

Specifies the objective type of campaign such as Marketing or Informational.

productId

Specifies the product ID.

productGroupId

Specifies the product group details that are configured for the campaign.

eventTriggerIdList

Specifies the events details for the campaigns.

eventTriggerIdList/id

Specifies the unique ID’s of the events

profileIdList

Specifies the profile details that are configured for the campaign.

profileIdList/id

Specifies the unique profile id.

channelType

Specifies the channel types that are configured for the campaign (Online/Offline).

channelType/Type

Specifies the channel types that are configured for campaign like Online or Offline.

offlineTemplate

Specifies the offline templates that are configured for the campaign.

offlineTemplate/offlineTemplateId

Specifies the unique ID of the offline template.

offlineTemplate/channelSubType

Specifies the type of offline template (SMS/Email/Push notifications).

offlineTemplate/subject

Specifies the subject that is configured for offline channel communication.

offlineTemplate/content

Specifies the content that must be sent in the offline template.

/onlineContent

Specifies the online channels that are configured for the campaign.

onlineContent/onlineContentId

Specifies the unique ID for online template. The field is empty if you are creating a campaign.

onlineContent/placeHolderId

Specifies the placeholder id

onlineContent/targetURL

Specifies the target URL that is configured for the channel and the screen.

onlineContent/imageURL

Specifies the image URL configured for the channel and screen.

channelDetails

Specifies the list of all channels that are configured for the campaign (Online and Offline).

channelDetails/channelSubType

Specifies the priority of the channel.

channelDetails/channelPriority

Specifies the channel type such as SMS, EMAIL, PUSH NOTIFICATIONS, MOBILE, or WEB.

NOTE: All the body parameters are mandatory. You can leave the value to the parameter key as blank, but in the request you must mention the param key.

ClosedView Body Request Sample Code 
{
  "campaignName": "Test Ad Name",
  "campaignDescription": "Test Ad Desc",
  "campaignPriority": "87",
  "startDate": "2020-04-01",
  "endDate": "2020-04-30",
  "campaignType": "SINGLE",
  "objectiveType": "Informational",
  "productId": null,
  "productGroupId": null,
  "eventTriggerIdList": [
    {
      "id": "ET004"
    }
  ],
  "profileIdList": [
    {
      "id": "PRF2008437848"
    }
  ],
  "channelType": [
    {
      "type": "OFFLINE"
    },
    {
      "type": "ONLINE"
    }
  ],
  "offlineTemplate": [
    {
      "offlineTemplateId": "",
      "channelSubType": "SMS",
      "subject": "",
      "content": "SMS Content"
    }
  ],
  "onlineContent": [
    {
      "onlineContentId": "",
      "placeholderId": "PH001",
      "targetURL": "https://target.png",
      "imageURL": "https://1.png"
    },
    {
      "onlineContentId": "",
      "placeholderId": "PH002",
      "targetURL": "https://target.png",
      "imageURL": "https://1.png"
    },
    {
      "onlineContentId": "",
      "placeholderId": "PH003",
      "targetURL": "https://target.png",
      "imageURL": "https://1.png"
    }
  ],
  "channelDetails": [
    {
      "channelSubType": "SMS",
      "channelPriority": "2"
    },
    {
      "channelSubType": "MOBILE",
      "channelPriority": "2"
    }
  ]
}
Response:

Parameters

code

Error code when request is failed

Id

ID of the profile created

Message

Error message when the request is failed

{
"code": "",
"opstatus": 0,
"id": "CP2008438168",
"message": "",
"httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: Request Body is missing
  • Error code : 400
    Error message: Empty Request. Incase of multiple requests, all or any of the request is empty
  • Error code : 400
    Error message: Date validation failed
  • Error code : 400
    Error message: Error Occurred, Unable to save Campaign
  • Error code : 400
    Error message: Record %s already exist %s will be replaced by corresponding id at runtime.
  • Error code : 400
    Error message: Transformation Operation Failed for Campaign
  • Error code : 400
    Error message: Date parsing failed, invalid date format
  • Error code : 400
    Error message: Start Date is invalid
  • Error code : 400
    Error message: End Date is invalid
  • Error code : 400
    Error message: Mandatory Input field %s is missing %s can be either of the following based on the missing mandatory field value CampaignId / ObjectiveType / CampaignPriority / CampaignName / CampaignDescription / ChannelType / EventTrigger / StartDate / EndDate / ChannelDetails / OnlineContent / OfflineTemplate
Associated Enterprise APIs: campaigns
ClosedupdateCampaign
 
Description: This API is used to update a campaign details and status.
Method: POST
URL: {base_url}/services/data/v1/CampaignManagementObjService/operations/campaignmanagement/ updateCampaign
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:
ClosedView the Request Parameters

campaignName

Specifies the name of the campaign.

campaignDescription

Specifies the description of the campaign.

campaignPriority

Specifies the priority of the campaign

startData

Specifies the start date of the campaign.

endData

Specifies the end date of the campaign.

campaignType

Specifies the type of campaign.

objectiveType

Specifies the objective type of campaign such as Marketing or Informational.

productId

Specifies the product ID.

productGroupId

Specifies the product group details that are configured for the campaign.

eventTriggerIdList

Specifies the events details for the campaigns.

eventTriggerIdList/id

Specifies the unique ID’s of the events

profileIdList

Specifies the profile details that are configured for the campaign.

profileIdList/id

Specifies the unique profile id.

channelType

Specifies the channel types that are configured for the campaign (Online/Offline).

channelType/Type

Specifies the channel types that are configured for campaign like Online or Offline.

offlineTemplate

Specifies the offline templates that are configured for the campaign.

offlineTemplate/offlineTemplateId

Specifies the unique ID of the offline template.

offlineTemplate/channelSubType

Specifies the type of offline template (SMS/Email/Push notifications).

offlineTemplate/subject

Specifies the subject that is configured for offline channel communication.

offlineTemplate/content

Specifies the content that must be sent in the offline template.

/onlineContent

Specifies the online channels that are configured for the campaign.

onlineContent/onlineContentId

Specifies the unique ID for online template. The field is empty if you are creating a campaign.

onlineContent/placeHolderId

Specifies the placeholder id

onlineContent/targetURL

Specifies the target URL that is configured for the channel and the screen.

onlineContent/imageURL

Specifies the image URL configured for the channel and screen.

channelDetails

Specifies the list of all channels that are configured for the campaign (Online and Offline).

channelDetails/channelSubType

Specifies the priority of the channel.

channelDetails/channelPriority

Specifies the channel type such as SMS, EMAIL, PUSH NOTIFICATIONS, MOBILE, or WEB.

campaignId

Specifies the unique identifier of the campaign.

campaignStatus

Specifies the status of the campaign (Active/Paused/Terminated).

NOTE: All the body parameters are mandatory. You can leave the value to the parameter key as blank, but in the request you must mention the param key.

ClosedView the Request Sample Code 
{
   "campaignName": "Test Ad Name",
  "campaignDescription": "Test Ad Desc",
  "campaignPriority": "87",
  "startDate": "2020-04-01",
  "endDate": "2020-04-15",
  "campaignType": "SINGLE",
  "objectiveType": "Regulatory",
  "productId": null,
  "productGroupId": null,
  "eventTriggerIdList": [
    {
      "id": "ET005"
    },
    {
      "id": "ET004"
    }
  ],
  "profileIdList": [
    {
      "id": "PRF2008437848"
    }
  ],
  "channelType": [
    {
      "type": "OFFLINE"
    },
    {
      "type": "ONLINE"
    }
  ],
  "offlineTemplate": [
    {
      "offlineTemplateId": "OT2008438172",
      "channelSubType": "SMS",
      "subject": "",
      "content": "SMS Content"
    },
    {
      "offlineTemplateId": "",
      "channelSubType": "PUSH NOTIFICATIONS",
      "subject": "",
      "content": "PUSH NOTIFICATIONS"
    }
  ],
  "onlineContent": [
    {
      "onlineContentId": "OC2008438169",
      "placeholderId": "PH001",
      "targetURL": "https://target2.png",
      "imageURL": "https://2.png"
    },
    {
      "onlineContentId": "OC2008438170",
      "placeholderId": "PH002",
      "targetURL": "https://target2.png",
      "imageURL": "https://2.png"
    },
    {
      "onlineContentId": "OC2008438171",
      "placeholderId": "PH003",
      "targetURL": "https://target2.png",
      "imageURL": "https://2.png"
    }
  ],
  "channelDetails": [
    {
      "channelSubType": "SMS",
      "channelPriority": "2"
    },
    {
      "channelSubType": "PUSH NOTIFICATIONS",
      "channelPriority": "2"
    },
    {
      "channelSubType": "MOBILE",
      "channelPriority": "2"
    }
  ],
  "campaignId": "CP2008438168",
  "campaignStatus": "SCHEDULED_ACTIVE_COMPLETED"
}
Response:

Parameters

code

Error code when request is failed.

Id

ID of the profile created.

Message

Error message when the request is failed.

Status

Request status like success or failed.

{
   "code": "",
  "opstatus": 0,
  "id": "CP2008438168",
  "message": "",
  "status": "Success",
  "httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: Request Body is missing
  • Error code : 400
    Error message: Empty Request. Incase of multiple requests, all or any of the request is empty
  • Error code : 400
    Error message: Date validation failed
  • Error code : 400
    Error message: Empty Request. Incase of multiple requests, all or any of the request is empty
  • Error code : 500
    Error message: Error Occurred, Unable to fetch Campaign.
  • Error code : 400
    Error message: Existing Campaign record for the id [%s] not found %s will be replaced by the corresponding campaign id
  • Error code : 400
    Error message: There is an ID mismatch between %s and %s will be replaced by the campaign id values passed in the request body and path parameter respectively
  • Error code : 400
    Error message: Error Occurred, Unable to save Campaign.
  • Error code : 400
    Error message: Transformation Operation Failed for Campaign
  • Error code : 400
    Error message: Mandatory Input field %s is missing %s can be either of the following based on the missing mandatory field value CampaignId / ObjectiveType / CampaignPriority / CampaignName / CampaignDescription / ChannelType / EventTrigger / StartDate / EndDate / ChannelDetails / OnlineContent / OfflineTemplate
Associated Enterprise APIs: campaigns(CAMPAIGN-ID)
ClosedgetProfiles
 
Description: This API fetches all the available profiles that are configured.
Method: POST
URL: {base_url}/ services/data/v1/CampaignManagementObjService/operations/profile/getProfiles
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

allProfiles[ ]

List of all profiles

Parameters

allProfiles/profileName

Specifies the name of the profile.

allProfiles/profileDescription

Specifies the description of profile.

allProfiles/profileId

Specifies the unique ID of profile.

allProfiles/profileConditionss

Specifies the list of conditions specified for the profile.

allProfiles/profileConditionss/conditionExpression

Specifies the filter expression configured for a data context.

allProfiles/profileConditionss/dataContextName

Specifies the data context name.

allProfiles/profileConditionss/dataContextId

Specifies the data context ID.

allProfiles/profileConditionss/dataContextEndPoints

Specifies the data context Endpoint.

allProfiles/profileConditionss/profileConditionId

Specifies the unique profile condition ID.

allProfiles/profileConditionss/dataContextDescription

Specifies the data context description.

{
  "allProfiles": [
    {
      "profileName": "Test Profile Name",
      "profileDescription": "Test Profile Desc",
      "profileId": "PRF2008437848",
      "profileConditionss": [
        {
          "conditionExpression": "EstMonthlyExpenseVarGroup%20eq%20%2703.%20High%27%20and%20EstAnnualIncomeGroup%20eq%20%27B.%20100K-250K%27",
          "dataContextName": "Customer Attrition Model flow",
          "dataContextId": "CUSTOMER_ATTRITION_MODEL_FLOW",
          "dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomers",
          "profileConditionId": "PC2008437849",
          "dataContextDescription": "DataContext created for Customer Attrition Model flow Profiles"
        }
      ]
    }
  ],
  "opstatus": 0,
  "httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: The request is invalid
  • Error code : 500
    Error message: Error Occurred, Unable to fetch PlaceHolder
  • Error code : 400
    Error message: Transformation Operation Failed for PlaceHolder
  • Error code : 400
    Error message: No Record(s) found for the given ID / Criteria
Associated Enterprise APIs: profiles
ClosedcreateProfile
 
Description: This API creates a new profile.
Method: POST
URL: {base_url}/ services/data/v1/CampaignManagementObjService/operations/profile/createProfile
Security Level: Authorization Required
Header Request: X-Kony-Authorization
Body Request:

Parameters

profileName

Specifies the profile name.

profileDescription

Specifies the profile description.

profileConditions

Specifies the list of conditions that are to be selected for creating the profile.

profileConditions/conditionExpression

Specifies the filter expression selected for querying a data context

profileConditions/dataContextId

Specifies the data context id.

NOTE: All the body parameters are mandatory. You can leave the value to the parameter key as blank, but in the request you must mention the param key.

{
  "profileName": "Test Profile Name",
  "profileDescription": "Test Profile Desc",
  "profileConditions": [
    {
      "profileConditionId": "",
      "conditionExpression": "EstMonthlyExpenseVarGroup%20eq%20%2703.%20High%27%20and%20EstAnnualIncomeGroup%20eq%20%27B.%20100K-250K%27",
      "dataContextId": "CUSTOMER_ATTRITION_MODEL_FLOW"
    }
  ]
}
Response:

Parameters

code

Error code when request is failed

Id

ID of the profile created

Message

Error message when the request is failed

Status

Request status like success or failed

{
    "code": "",
    "opstatus": 0,
    "id": "PRF2009417109",
    "message": "",
    "status": "Success",
    "httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: Request Body is missing
  • Error code : 400
    Error message: Empty Request. Incase of multiple requests, all or any of the request is empty
  • Error code : 500
    Error message: Error Occurred, Unable to fetch Profile.
  • Error code : 400
    Error message: Record %s already exist %s will be replaced by the corresponding profile id
  • Error code : 400
    Error message: Error Occurred, Unable to save Profile.
  • Error code : 400
    Error message: Transformation Operation Failed for Profile
  • Error code : 400
    Error message: Mandatory Input field %s is missing %s can be either of the following based on the missing mandatory field value ProfileName / ProfileDescription / ProfileConditions / ConditionExpression / DataContextId
Associated Enterprise APIs: profiles
ClosedgetAllDefaultCampaigns
 
Description: This API fetches the details of the default campaign.
Method: POST
URL: {base_url}/services/data/v1/CampaignManagementObjService/operations/campaignmanagement/getAllDefaultCampaigns
Security Level: Authorizied App User
Header Request: X-Kony-Authorization
Body Request:

None
Response:

campaignLists [ ]

Contains a list of placeholder details that specify information about the channel and screen.

Parameters

campaignLists/placeholderIdentifier

Specifies the screen name information such as PRELOGIN, POSTLOGIN, APPLY_FOR_NEW_ACCOUNT, or ACCOUNT_DASHBOARD.

campaignLists/placeholderId

Specifies the placeholder id.

campaignLists/placeholderDescription

Specifies the place holder description.

campaignLists/imageURL

Specifies the image URL configured for the channel and screen.

campaignLists/placeholderDescription

Specifies the place holder description.

campaignLists/channelSubType

Specifies the image URL configured for the channel and screen.

campaignLists/imageResolution

Specifies the expected resolution of image

campaignLists/targetURL

Specifies the target URL configured for the channel and screen

campaignLists/onlineContentId

Specifies the unique ID of the online content template.

placeHolders/imageScale

Specifies the scale of the image (1X).

placeHolders/imageIndex

Specifies the Image index. As default campaigns can accommodate upto 3 carousel images, image index specifies the index of this image.

ClosedView Response Sample Code 
{
  "campaignLists": [
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH001",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-1.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "375x106",
      "targetURL": "https://google.com",
      "onlineContentId": "OC001",
      "imageScale": "1x",
      "imageIndex": 1
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH002",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-2x-1.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "750x212",
      "targetURL": "https://google.com",
      "onlineContentId": "OC002",
      "imageScale": "2x",
      "imageIndex": 1
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH003",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-3x-1.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "1125x318",
      "targetURL": "https://google.com",
      "onlineContentId": "OC003",
      "imageScale": "3x",
      "imageIndex": 1
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH001",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-2.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "375x106",
      "targetURL": "https://google.com",
      "onlineContentId": "OC004",
      "imageScale": "1x",
      "imageIndex": 2
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH002",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-2x-2.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "750x212",
      "targetURL": "https://google.com",
      "onlineContentId": "OC005",
      "imageScale": "2x",
      "imageIndex": 2
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH003",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-3x-2.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "1125x318",
      "targetURL": "https://google.com",
      "onlineContentId": "OC006",
      "imageScale": "3x",
      "imageIndex": 2
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH001",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-3.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "375x106",
      "targetURL": "https://google.com",
      "onlineContentId": "OC007",
      "imageScale": "1x",
      "imageIndex": 3
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH002",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-2x-3.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "750x212",
      "targetURL": "https://google.com",
      "onlineContentId": "OC008",
      "imageScale": "2x",
      "imageIndex": 3
    },
    {
      "placeholderIdentifier": "PRELOGIN",
      "placeholderId": "PH003",
      "placeholderDescription": "Sample place holder description",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-3x-3.jpg",
      "placeholderName": "Homepage",
      "channelSubType": "MOBILE",
      "imageResolution": "1125x318",
      "targetURL": "https://google.com",
      "onlineContentId": "OC009",
      "imageScale": "3x",
      "imageIndex": 3
    }
  ],
  "opstatus": 0,
  "httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: The request is invalid
  • Error code : 500
    Error message: Error Occurred, Unable to fetch OnlineContent.
  • Error code : 400
    Error message: Transformation Operation Failed for OnlineContent
  • Error code : 400
    Error message: No Record(s) found for the given ID / Criteria
Associated Enterprise APIs defaultcampaigndetails
ClosedupdateDefaultCampaigns
 
Description: This API updates the details of the default campaign.
Method: POST
URL: {base_url}/services/data/v1/CampaignManagementObjService/operations/campaignmanagement/updateDefaultCampaigns
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

defaultCampaign

The default campaign that has to be updated

Parameters

defaultCampaign/placeholderId

Specifies a unique ID for the placeholder.

defaultCampaign/onlineContentId

Specifies a unique ID for the online content template.

defaultCampaign/imageURL

Specifies the image URL that must be configured for the channel and the screen.

defaultCampaign/targetURL

Specifies the target URL that must be configured for the channel and the screen.

defaultCampaign/imageIndex

Specifies an image index. As default campaigns can accommodate upto 3 carousel images, image index specifies the index of these images.

NOTE: All the body parameters are mandatory. You can leave the value to the parameter key as blank, but in the request you must mention the param key.

ClosedView Request Sample Code 
{
  "defaultCampaign": [
    {
      "placeholderId": "PH001",
      "onlineContentId": "OC001",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-1.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "1"
    },
    {
      "placeholderId": "PH002",
      "onlineContentId": "OC002",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-2x-1.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "1"
    },
    {
      "placeholderId": "PH003",
      "onlineContentId": "OC003",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-3x-1.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "1"
    },
    {
      "placeholderId": "PH001",
      "onlineContentId": "OC004",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-2.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "2"
    },
    {
      "placeholderId": "PH002",
      "onlineContentId": "OC005",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-2x-2.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "2"
    },
    {
      "placeholderId": "PH003",
      "onlineContentId": "OC006",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-3x-2.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "2"
    },
    {
      "placeholderId": "PH001",
      "onlineContentId": "OC007",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-1x-3.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "3"
    },
    {
      "placeholderId": "PH002",
      "onlineContentId": "OC008",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-2x-3.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "3"
    },
    {
      "placeholderId": "PH003",
      "onlineContentId": "OC009",
      "imageURL": "https://retailbanking1.konycloud.com/dbimages/campaign-mobile-prelogin-3x-3.jpg",
      "targetURL": "https://manage.kony.com",
      "imageIndex": "3"
    }
  ]
}
Response: 
 {
"opstatus": 0,
"httpStatusCode": 200
}
Error Code(s):
  • Error code : 400
    Error message: Error Occurred, Unable to save OnlineContent.
  • Error code : 400
    Error message: Transformation Operation Failed for OnlineContent
Associated Enterprise APIs: defaultcampaigndetails
ClosedgetAndUpdateUsersForSegment
 
Description: This API is used to fetch the dynamic count of the customers (Number of active users) that belong to a profile category. When you fetch the count of customers based on a profile condition there is a time interval, within this period there could have been new customers added to the same profile condition. This API helps you in such scenarios by regularly updating the count.
Method: POST
URL: /services/data/v1/CampaignManagementObjService/operations/profile/getAndUpdateUsersForSegment
Security Level: Authorized App User
Header Request: X-Kony-Authorization
Body Request:

segment

Specifies the segment from which the active users must be fetched.

Parameters

segment/profileId

Specifies the profile ID.

segment/profileConditions

Specifies the various profile conditions that are required to fetch the active users.

segment/profileConditions/conditionExpression

Specifies the condition that must be applied for the profile.

segment/profileConditions/dataContextId

Specifies the unique identifier of dataContext.

segment/profileConditions/dataContextEndPoints

Specifies the endpoint URI of the data context that must be fetched.

{
"segment": {
"profileId": "PRF2016748143",
"profileConditions": [
{
"conditionExpression": "CustomerIndustry%20eq%20%2712345678%27",
"dataContextId": "DC001",
"dataContextEndPoints": "http://tmnstransact2.southeastasia.cloudapp.azure.com/APIService/odata/Tenant1/Dataset_AllCustomersNBP"
}
]
}
}
Response: 
 {
    "opstatus": 0,
    "Success": "true", 
    "httpStatusCode": 0,
 }
Error Code(s):
  • Error code : 21799
    Error message: Error while processing getProfiles response.
  • Error code : 21800
    Error message: Error while invoking or processing datacontextservice.
  • Error code : 21801
    Error message: Error while invoking or processing updateprofiles response.
  • Error code : 21802
    Error message: Unexpected error while processing updateUsersForSegments.
  • Error code : 21803
    Error message: Segment input or mandatory fields cannot be empty.
  • Error code : 21804
    Error message: Error while invoking datacontextservice.
  • Error code : 21805
    Error message: Error while getting profiles.
Associated Enterprise APIs: {{ms-host}}:// ms-campaign-api/api/v1.0.0/origination/campaigns/profiles  PUT
ClosedupdateProfile
 
Description: This API updates the user profile.
Method: PUT
URL: /services/data/v1/CampaignManagementObjService/operations/profile/updateProfile
Security Level: Authenticated App User
Header Request: X-Kony-Authorization
Body Request:

Parameters

profile

Specifies the various profile details

profile/profileId (Mandatory)

Specifies the unique ID of the profile that must be updated.

profile/profileName (Mandatory)

Specifies the name of the profile that has to be updated.

profile/profileDescription (Mandatory)

Specifies the description related to the profile that must be updated.

profile/profileStatus

Specifies the status of the profile such as active or inactive.

profile/numberOfUsers

Specifies the number of users for a profile that must be updated.

profile/softDeleteIndicator

Specifies whether the profile can be soft deleted.

profile/profileCreationDate

Specifies the date of creation of the profile.

profile/profileDeactivatedDate

Specifies the date of deactivation of the profile.

profile/profileConditions (Mandatory)

Specifies the list of conditions for the profile

profile/profileConditions/profileConditionId

Specifies the unique condition ID of the profile.

profile/profileConditions/conditionExpression (Mandatory)

Specifies the filter expression that is configured for a data context.

profile/profileConditions/dataContextId (Mandatory)

Specifies the ID based on the data context.

//Sample Response for deactivating profile
{
  "profile": {
    "profileId": "PRF2015726138",
    "profileName": "Test Name",
    "profileDescription": "desc",
    "profileStatus": "Deactive",
    "profileConditions": [
      {
        "profileConditionId": null,
        "conditionExpression": "CustomerIndustry%20eq%20%2712345678%27%20and%20Gender%20eq%20%27Male%27",
        "dataContextId": "DC001"
      }
    ]
  }
}

//Sample Response for activating profile
{
  "profile": {
    "profileId": "PRF2015726138",
    "profileName": "Test Name",
    "profileDescription": "desc",
    "profileStatus": "Active",
    "profileConditions": [
      {
        "profileConditionId": null,
        "conditionExpression": "CustomerIndustry%20eq%20%2712345678%27%20and%20Gender%20eq%20%27Male%27",
        "dataContextId": "DC001"
      }
    ]
  }
}

//Sample Response for deleting profile
{
  "profile": {
    "profileId": "PRF2015726138",
    "profileName": "Test Name",
    "profileDescription": "Delete",
    "profileStatus": "Active",
    "profileConditions": [
      {
        "profileConditionId": null,
        "conditionExpression": "CustomerIndustry%20eq%20%2712345678%27%20and%20Gender%20eq%20%27Male%27",
        "dataContextId": "DC001"
      }
    ]
  }
}
Response:

Parameters

/profileId

Specifies the ID of the profile that is updated.

/status

Specifies the update status.

/message

Specifies the success or failure message.

{
    "profileId": "PRF2018360024",
    "status": "Success",
    "message": "PRF2018360024 updated successfully"
}
Error Code(s): 
[
    {
        "message": "There is an ID mismatch between PRF2018360024 and PRF201836002",
        "code": "400"
    }
]
[
    {
        "message": "Empty Request. Incase of multiple requests, all or any of the request is empty",
        "code": "400"
    }
]
[
    {
        "message": "Mandatory Input field ProfileName is missing",
        "code": "400"
    }
]
 [
    {
        "message": "Mandatory Input field ProfileName is missing",
        "code": "400"
    }
]
[
    {
        "message": "Mandatory Input field ProfileDescription is missing",
        "code": "400"
    }
]
[
    {
        "message": "Existing Profile record for the id [PRF201836002] not found",
        "code": "400"
    }
]
[
    {
        "message": "Mandatory Input field ProfileConditions is missing",
        "code": "400"
    }
]
[
    {
        "message": "Mandatory Input field ConditionExpression is missing",
        "code": "400"
    }
]
[
    {
        "message": "Mandatory Input field DataContextId is missing",
        "code": "400"
    }
]
[
    {
        "message": " Request Body is missing ",
        "code": "0"
    }
]
Associated Enterprise APIs: {{ms-host}}:// ms-campaign-api/api/v1.0.0/origination/campaigns/profiles/{profileId}  PUT

Bookmark Name Actions
BACK

In this topic

Feedback
x

Are you sure you want to log-off?