APIs
The following business APIs are supported by Campaign microservices.
Version 1.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| Campaigns
|
getCampaigns |
/origination/campaigns |
Retrieves the list of campaigns based on the following query parameters
|
|
createCampaign |
/origination/campaigns |
Stores the campaign details |
|
|
updateCampaign |
/origination/campaigns/ {campaignId} |
Update the details of a specific campaign |
|
|
Profiles
|
getProfiles |
/origination/campaigns/profiles |
Retrieves the list of profiles based on the following query parameters
|
|
createProfile |
/origination/campaigns/profiles |
Stores the profile details |
|
|
updateProfile |
/origination/campaigns/profiles/{profileId} |
Update the details of a specific profile |
|
| Eventtriggers
|
getEventTriggers |
/origination/campaigns/eventTriggers |
Retrieves the list of event triggers based on the following query parameters
|
|
createEventTrigger |
/origination/campaigns/eventTriggers |
Stores the event trigger details |
|
|
updateEventTrigger |
/origination/campaigns/eventTriggers/{eventTriggerId}
|
Update the details of a specific event trigger |
|
| Placeholders
|
getPlaceholders |
/origination/campaigns/placeholders |
Retrieves the list of placeholders based on the following query parameters
|
|
createPlaceholder |
/origination/campaigns/placeholders |
Stores the placeholder details |
|
|
updatePlaceholder |
/origination/campaigns/placeholders/{placeholderId}
|
Update the details of a specific placeholder |
|
| Datacontexts |
getDataContexts |
/origination/campaigns/dataContexts |
Retrieves the list of datacontexts based on the following query parameters
|
| createDataContext | /origination/campaigns/dataContexts |
Stores the datacontext details |
|
| updateDataContext | /origination/campaigns/dataContexts/{dataContextId} |
Update the details of a specific datacontext |
|
| Campaigns |
getCampaignDetailsForEvents |
/origination/events/{eventId}/campaigns |
Retrieves the list of campaigns associated with eventcode in the path param and channelsubtype as query param |
| OnlineContent |
getDefaultCampaigns |
/origination/campaigns/defaultCampaigns |
Retrieves the list of default campaign details based on the following query parameters
|
| updateDefaultCampaigns | /origination/campaigns/defaultCampaigns
|
Update the details of the default campaigns |
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.
Version 1.0.1
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| Campaigns
|
getCampaignsV1_0_1 |
/origination/campaigns |
Retrieves the list of campaigns based on the following query parameters
|
|
createCampaignV1_0_1 |
/origination/campaigns |
Stores the campaign details |
|
|
updateCampaignV1_0_1 |
/origination/campaigns/ {campaignId} |
Update the details of a specific campaign |
|
|
Profiles
|
getProfilesV1_0_1 |
/origination/campaigns/profiles |
Retrieves the list of profiles based on the following query parameters
|
|
|
createProfileV1_0_1 |
/origination/campaigns/profiles |
Stores the profile details |
|
|
updateProfileV1_0_1 |
/origination/campaigns/profiles/{profileId} |
Update the details of a specific profile |
| Eventtriggers
|
getEventTriggersV1_0_1 |
/origination/campaigns/eventTriggers |
Retrieves the list of event triggers based on the following query parameters
|
|
|
createEventTriggerV1_0_1 |
/origination/campaigns/eventTriggers |
Stores the event trigger details |
|
|
updateEventTriggerV1_0_1 |
/origination/campaigns/eventTriggers/{eventTriggerId}
|
Update the details of a specific event trigger |
| Placeholders
|
getPlaceholdersV1_0_1 |
/origination/campaigns/placeholders |
Retrieves the list of placeholders based on the following query parameters
|
|
|
createPlaceholderV1_0_1 |
/origination/campaigns/placeholders |
Stores the placeholder details |
|
|
updatePlaceholderV1_0_1 |
/origination/campaigns/placeholders/{placeholderId}
|
Update the details of a specific placeholder |
| Datacontexts |
getDataContextsV1_0_1 |
/origination/campaigns/dataContexts |
Retrieves the list of datacontexts based on the following query parameters
|
| createDataContextV1_0_1 | /origination/campaigns/dataContexts |
Stores the datacontext details |
|
| updateDataContextV1_0_1 | /origination/campaigns/dataContexts/{dataContextId} |
Update the details of a specific datacontext |
|
| Campaigns |
getCampaignDetailsForEventsV1_0_1 |
/origination/events/{eventId}/campaigns |
Retrieves the list of campaigns associated with eventcode in the path param and channelsubtype as query param |
| OnlineContent |
getDefaultCampaignsV1_0_1 |
/origination/campaigns/defaultCampaigns |
Retrieves the list of default campaign details based on the following query parameters
|
| updateDefaultCampaignsV1_0_1 | /origination/campaigns/defaultCampaigns
|
Update the details of the default campaigns |
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.
Version 2.0.0
| TABLE NAME | OPERATION ID | URI | API DESCRIPTION |
|---|---|---|---|
| Campaigns
|
getCampaignsV2 |
/origination/campaigns |
Retrieves the list of campaigns based on the following query parameters
|
|
createCampaignV2 |
/origination/campaigns |
Stores the campaign details |
|
|
updateCampaignV2 |
/origination/campaigns/ {campaignId} |
Update the details of a specific campaign |
|
|
Profiles
|
getProfilesV2 |
/origination/campaigns/profiles |
Retrieves the list of profiles based on the following query parameters
|
|
createProfileV2 |
/origination/campaigns/profiles |
Stores the profile details |
|
|
updateProfileV2 |
/origination/campaigns/profiles/{profileId} |
Update the details of a specific profile |
|
| updateProfiles | /origination/engagements/profiles | Update the details of all profile | |
| Eventtriggers
|
getEventTriggersV2 |
/origination/campaigns/eventTriggers |
Retrieves the list of event triggers based on the following query parameters
|
|
createEventTriggerV2 |
/origination/campaigns/eventTriggers |
Stores the event trigger details |
|
|
updateEventTriggerV2 |
/origination/campaigns/eventTriggers/{eventTriggerId}
|
Update the details of a specific event trigger |
|
| Placeholders
|
getPlaceholdersV2 |
/origination/campaigns/placeholders |
Retrieves the list of placeholders based on the following query parameters
|
|
createPlaceholderV2 |
/origination/campaigns/placeholders |
Stores the placeholder details |
|
|
updatePlaceholderV2 |
/origination/campaigns/placeholders/{placeholderId}
|
Update the details of a specific placeholder |
|
| Datacontexts |
getDataContextsV2 |
/origination/campaigns/dataContexts |
Retrieves the list of datacontexts based on the following query parameters
|
| createDataContextV2 | /origination/campaigns/dataContexts | Stores the datacontext details | |
| updateDataContextV2 | /origination/campaigns/dataContexts/{dataContextId} | Update the details of a specific datacontext | |
| Campaigns |
getCampaignsByEvent |
/origination/events/{eventId}/campaigns |
Retrieves the list of campaigns associated with eventid in the path param and channelsubtype as query param |
| OnlineContent |
getDefaultCampaignsV2 |
/origination/campaigns/defaultCampaigns |
Retrieves the list of default campaign details based on the following query parameters
|
| updateDefaultCampaignsV2 | /origination/engagements/defaultCampaigns
|
Update the details of the default campaigns |
For the complete APIs specification, see service specification (Swagger) or Swagger JSON file.
In this topic