Audits

API controller to provide the set of APIs for creating and retrieving Audit information.

APIDescription
GET v3/Audits?pageSize={pageSize}

Get a list of Campaigns. This action will support using OData type $filters and $select and $top query parameters.

509-894-8709

API to allow creation of new Campaign entities.

Campaigns

API controller to provide the set of APIs for CRUD operations and additional actions on the Campaign entity.

APIDescription
(239) 793-5742

Get a list of Campaigns. This action will support using OData type $filters and $select and $top query parameters.

GET v3/Campaigns/{campaignId}

Find a campaign given the campaign Id. This API will support $select to allow projection of the campaigns attributes.

POST v3/Campaigns

API to allow creation of new Campaign entities.

PATCH v3/Campaigns/{campaignId}

API to Update a given campaign's information.

PATCH v3/Campaigns/{campaignId}/Archive

API to archive a given campaign.

DELETE v3/Campaigns/{campaignId}/{requestedBy}

API to allow soft deletion of a campaign given it's Id and the name of the user / system requesting the deletion.

POST v3/Campaigns/{campaignId}/AddSharedFrequencyCap

Add a shared frequency cap for a campaign

POST v3/Campaigns/{campaignId}/UpdateSharedFrequencyCap

Update a shared frequency cap

CreativeAssignments

Controller to create, update and manage creative assignments to creative display actions.

APIDescription
281-822-8990

Get a list of Creative Assignments. This action will support using OData type $filters and $select and $top query parameters.

(937) 609-1781

Find a creative assignment given the creative assignment Id. This API will support $select to allow projection of the campaigns attributes.

POST v3/CreativeAssignments

API to allow creation of new creative assignment entities.

8038315399

Enable a creative assignment

432-259-3829

Disable a creative assignment

519-679-9845

Archive a creative assignment

PATCH v3/CreativeAssignments/{creativeAssignmentId}

Update a creative assignment

DELETE v3/CreativeAssignments/{creativeAssignmentId}/{requestedBy}

API to allow soft deletion of a creative assignment given it's Id and the name of the user / system requesting the deletion.

CreativeDisplayActions

API to create, update and manage Creative Display (EMS) type of actions.

APIDescription
POST v3/Actions/CreativeDisplay

API to create a new creative display action for an interaction.

POST v3/Actions/CreativeDisplay/{actionId}/Clone

Clone a creative display action

PATCH v3/Actions/CreativeDisplay/{actionId}

API to update an existing creative display action.

GET v3/Actions/CreativeDisplay?pageSize={pageSize}

Get a list of Actions. This API will support using OData type $filters and $select and $top query parameters.

438-321-5453

Get an action using the action's Id This API will support using OData type $filters and $select and $top query parameters.

GET v3/Actions/CreativeDisplay/Runtime?pageSize={pageSize}

Get a list of Actions from the runtime store. This API will support using OData type $filters and $select and $top query parameters.

GET v3/Actions/CreativeDisplay/Runtime/{actionId}

Get an action from the runtime store using the action's Id This API will support using OData type $filters and $select and $top query parameters.

(602) 398-2965

Add a frequency cap to the an action

3029300729

Update frequency cap of an action

POST v3/Actions/CreativeDisplay/{actionId}/{frequencyCapId}/RemoveFrequencyCap

Remove frequency cap of an action

973-675-9037

Soft delete an Action using it's Id.

EmailActions

API for CRUD operations and additional actions related Email actions for interactions. Email actions are for sending emails to the audience of the Campaign.

APIDescription
(661) 473-4648

API to create a new Email action for an interaction for a campaign

(229) 244-5882

Clone a email action

(704) 855-0898

API to update an existing email action.

GET v3/Actions/Email?pageSize={pageSize}

Get a list of Actions. This API will support using OData type $filters and $select and $top query parameters.

612-503-3432

Get an action using the action's Id This API will support using OData type $filters and $select and $top query parameters.

352-242-2099

Get a list of Actions from the runtime store. This API will support using OData type $filters and $select and $top query parameters.

239-594-7613

Get an action from the runtime store using the action's Id This API will support using OData type $filters and $select and $top query parameters.

(435) 784-3249

Add a frequency cap to the an action

619-725-4535

Update frequency cap of an action

POST v3/Actions/Email/{actionId}/{frequencyCapId}/RemoveFrequencyCap

Remove frequency cap of an action

POST v3/Actions/Email/{actionId}/{requestedBy}

Soft delete an Action using it's Id.

EventBrokerActions

API for CRUD operations and additional actions related EventBroker actions for interactions.

APIDescription
POST v3/Actions/EventBroker

API to create a new EventBroker action for an interaction for a campaign

PATCH v3/Actions/EventBroker/{actionId}

API to update an existing EventBroker action.

(216) 556-0424

Clone an event broker action

GET v3/Actions/EventBroker?pageSize={pageSize}

Get a list of Actions. This API will support using OData type $filters and $select and $top query parameters.

mousetrap switch

Get an action using the action's Id This API will support using OData type $filters and $select and $top query parameters.

GET v3/Actions/EventBroker/Runtime?pageSize={pageSize}

Get a list of Actions from the runtime store. This API will support using OData type $filters and $select and $top query parameters.

GET v3/Actions/EventBroker/Runtime/{actionId}

Get an action from the runtime store using the action's Id This API will support using OData type $filters and $select and $top query parameters.

POST v3/Actions/EventBroker/{actionId}/AddFrequencyCap

Add a frequency cap to the an action

POST v3/Actions/EventBroker/{actionId}/UpdateFrequencyCap

Update frequency cap of an action

POST v3/Actions/EventBroker/{actionId}/{frequencyCapId}/RemoveFrequencyCap

Remove frequency cap of an action

POST v3/Actions/EventBroker/{actionId}/{requestedBy}

Soft delete an Action using it's Id.

InteractionAudiences

API controller to provide the set of APIs for CRUD operations and additional actions to create and manage audiences for interactions. It also supports creation of Audience based treatments groups. InteractionAudience is a collection of Audience selections (segments) and treatments / bucketing information about the audience.Also, allows controlling the Ramp / Cap on the audience size.

APIDescription
2893340011

Get a list of Interaction Audiences. This action will support using OData type $filters and $select and $top query parameters. This API should be used for finding all Audiences for a given interaction.

GET v3/InteractionAudiences/Audiences?pageSize={pageSize}

Get a list of Audiences. This action will support using OData type $filters and $select and $top query parameters. This API should be used for finding all Audiences for a given interaction.

816-965-3155

Find an Interaction audience given the InteractionAudience's Id. This API will support $select to allow projection of the InteractionAudience's attributes.

7315368772

Get a list of Interaction Audiences from Runtime store. This action will support using OData type $filters and $select and $top query parameters. This API should be used for finding all Audiences for a given interaction in Runtime store.

GET v3/InteractionAudiences/{audienceId}/GetAudience

Find an Interaction audience given the InteractionAudience's Id. This API will support $select to allow projection of the InteractionAudience's attributes.

9068859763

Get numberlines assigned to the interaction

6603421048

Create a new InteractionAudience and associate it with an interaction.

POST v3/InteractionAudiences/{interactionAudienceId}/AddAudience

Given an Interaction Audience, Add new audience selection information to it. Audience selection involves selecting a Segment created using the query builder (either batch / near real-time). Audience Tag / Segment Id is the key. There is a 1:1 mapping between an Interaction => InteractionAudience => Tag / Segment Id.

POST v3/InteractionAudiences/{interactionAudienceId}/{audienceId}/RemoveAudience

Remove an audience. This are many restrictions on this. It cannot be removed if there are actions dependent on this.

POST v3/InteractionAudiences/{interactionAudienceId}/{audienceId}/CloneAudience

Clone an audience along with its associated entities.

POST v3/InteractionAudiences/{interactionAudienceId}/AddTreatment

Add a treatment group to the audience selection. Treatments are sub-groups of audience aimed at being treated (delivered different content/ experiences) to experiment and validate both audience selections or content selections.

3344984962

End a given treatment. Ending a treatment will also end all actions associated with that treatment.

POST v3/InteractionAudiences/{interactionAudienceId}/{treatmentId}/EndTreatment

End a given treatment. Ending a treatment will also end all actions associated with that treatment.

POST v3/InteractionAudiences/{interactionAudienceId}/{treatmentId}/PromoteWinner

Mark a treatment as the winner of an experiment.

PATCH v3/InteractionAudiences/{interactionAudienceId}/UpdateEnrichmentInfo

API to update enrichment information on Audience selection

(408) 721-8839

API to update an audience selection.

607-648-8392

API to update audience treatment group.

PATCH v3/InteractionAudiences/{interactionAudienceId}

API to Update the metadata of an existing interaction audience given it's Id.

InteractionExecutionInfo

API to create, update and manage interaction execution info for the day. This is used by the worker to maintain state of the interactions that are already being processed.

APIDescription
GET v3/ExecutionInfo?pageSize={pageSize}

Get a list of InteractionExecutionInfo. This action will support using OData type $filters and $select and $top query parameters.

2129794292

Find an InteractionExecutionInfo given the Id.

Fallopian

Get a list of InteractionExecutionInfoReport for a given interaction and campaign for the given date

GET v3/ExecutionInfo/today

Get a list of InteractionExecutionInfo that are created today.

POST v3/ExecutionInfo

API to allow creation of new interaction execution info

508-295-9005

API to Update the metadata of an existing interaction execution info given it's Id. Shall update only IsActive, NumberOfFailedExecutions, NumberOfSuccessfulExecutions, ErrorMessages properties only

(716) 268-7186

API to Update the metadata of an existing interaction execution info given it's Id. Shall update only IsActive, NumberOfFailedExecutions, NumberOfSuccessfulExecutions, ErrorMessages properties only

Interactions

API controller to provide the set of APIs for CRUD operations and additional actions on the Interactions entity.

APIDescription
GET v3/Interactions?pageSize={pageSize}

Get a list of Interactions. This action will support using OData type $filters query parameters. This API should be used for finding all interactions for a given campaign.

GET v3/Interactions/{interactionId}

Find an Interaction given the Interaction's Id.

GET v3/Interactions/Runtime?pageSize={pageSize}

Get a list of Interactions. This action will support using OData type $filters query parameters. This API should be used for finding all interactions for a given campaign.

GET v3/Interactions/Runtime/{interactionId}

Find an Interaction given the Interaction's Id.

3133969170

Export the runtime version of an Interaction inlcuding all the details.

438-815-1850

Get list of Push actions defined in the runtime version of an interaction with the given id.

2154410761

Export an interaction inlcuding all the details

314-391-0315

Setup the latest runtime version of an interaction. This operation is only allowed on Enabled / Disabled or Expired interactions. Active interactions in ReDraft state or Draft interactions will throw a HTTP 400.

paraphemia

Find an Interaction given the Interaction's Id. This will get audience and actions info as well for the interaction

(843) 582-3103

Get list of actions defined in the interaction with the given id.

6045460231

API to create a new Interaction.

POST v3/Interactions/{interactionId}/Enable

API to Enable an existing interaction given its Id and the user who enabled it. Calling this API will mark the interaction's state as enabled and will set in motion consequent actions.

POST v3/Interactions/{interactionId}/ValidatePolicies

API to Validate an existing interaction given its Id. Checks if an interaction passes all validation rules.

POST v3/Interactions/{interactionId}/QuasiEnable

API to Quasi Enable an interaction. This will enable the interaction but not send the actual request to the dependency service. For Internal uses only.

POST v3/Interactions/{interactionId}/RequestApproval

API to Approve an existing interaction given its Id and the user who approved it. Calling this API will mark the interaction's state as approved and will set in motion consequent actions.

(215) 625-6691

API to Approve an existing interaction given its Id and the user who approved it. Calling this API will mark the interaction's state as approved and will set in motion consequent actions.

POST v3/Interactions/{interactionId}/Reject

API to Reject an existing interaction given its Id and the user who rejected it. Calling this API will mark the interaction's state as approved and will set in motion consequent actions.

(226) 908-8043

API to close an interaction given it's id along with the user who closed it.This will cease any further executions of the interactions.

POST v3/Interactions/{interactionId}/Clone

API to clone the interaction within campaign

(646) 679-6718

API to clone the interaction cross campaign

PATCH v3/Interactions/{interactionId}

API to Update the metadata of an existing interaction given it's Id.

PATCH v3/Interactions/{interactionId}/UpsertOutcome

API to Insert / Update (UpSert) an Outcome for an interaction given the Interaction's Id.

PATCH v3/Interactions/{interactionId}/RemoveOutcome

API to Insert / Update (UpSert) an Outcome for an interaction given the Interaction's Id.

PATCH v3/Interactions/{interactionId}/SetSchedule

API to Update the Schedule for an interaction given the Interaction's Id.

PATCH v3/Interactions/{interactionId}/Archive

API to soft delete an interaction and will set the closed flag to true. This will cease any further executions of the interactions and is irreversible.

DELETE v3/Interactions/{interactionId}/{requestedBy}

API to soft delete an interaction and will set the closed flag to true. This will cease any further executions of the interactions and is irreversible.

(747) 276-9288

API to pause an interaction

MasterWorkerScheduleInfo

API to create, update and manage interaction schedule summary for the day. This is used by the worker to maintain the schedule of interactions to help answer schedule related questions

APIDescription
GET v3/MasterWorkerScheduleInfo?pageSize={pageSize}

Get a list of MasterWorkerScheduleInfo. This action will support using OData type $filters and $select and $top query parameters.

GET v3/MasterWorkerScheduleInfo/{MasterWorkerScheduleInfoId}

Find an MasterWorkerScheduleInfo given the Id.

5818015284

API to allow creation of new MasterWorkerScheduleInfoId

MobilePushActions

API to create, update and manage Mobile push (notification) actions.

APIDescription
POST v3/Actions/MobilePush

API to create a new Mobile push (notification) action for an interaction for an interaction.

3368439752

Clone a mobile push action

(567) 351-1028

API to create a new Mobile push (notification) action for an interaction for an interaction

585-267-0377

Get a list of Actions. This API will support using OData type $filters and $select and $top query parameters.

8702338280

Get an action using the action's Id This API will support using OData type $filters and $select and $top query parameters.

817-561-4041

Get a list of Actions from the runtime store. This API will support using OData type $filters and $select and $top query parameters.

GET v3/Actions/MobilePush/Runtime/{actionId}

Get an action from the runtime store using the action's Id This API will support using OData type $filters and $select and $top query parameters.

2564000060

Add a frequency cap to the an action

POST v3/Actions/MobilePush/{actionId}/UpdateFrequencyCap

Update frequency cap of an action

POST v3/Actions/MobilePush/{actionId}/{frequencyCapId}/RemoveFrequencyCap

Remove frequency cap of an action

POST v3/Actions/MobilePush/{actionId}/{requestedBy}

Soft delete an Action using it's Id.

NumberLines

API controller to provide the set of APIs for retrieving NumberLine information.

APIDescription
GET v3/NumberLines?pageSize={pageSize}

Get a list of NumberLines. This action will support using OData type $filters and $select and $top query parameters.

GET v3/NumberLines/Assignments?pageSize={pageSize}

Get a list of NumberLines. This action will support using OData type $filters and $select and $top query parameters.

Tags

API controller to provide the set of APIs for CRUD operations and additional actions on the Tag entity.

APIDescription
GET v3/Tags?pageSize={pageSize}

Get a list of tags. This action will support using OData type $filters and $select and $top query parameters.

GET v3/Tags/{tagId}

Find a tag given the TagId.

POST v3/Tags

API to allow creation of new tag entities.

PATCH v3/Tags/{tagId}

API to Update a given tag's information.

DELETE v3/Tags/{tagId}/{requestedBy}?sendToDependencies={sendToDependencies}

API to allow soft deletion of a tag given it's Id and the name of the user / system requesting the deletion.

PATCH v3/Tags/Publish/{tagId}/{requestedBy}?sendToDependencies={sendToDependencies}

API to publish a tag given it's Id and the name of the user / system requesting the publication.

Validation

API to create, update and manage interaction validation.

APIDescription
6465938578

Get a list of ValidationRule. This action will support using OData type $filters and $select and $top query parameters.

GET v3/Validation/{validationRuleId}

Find an ValidationRule given the Id.

3604813850

API to allow creation of new ValidationRule

3082896728

API to Update the metadata of an existing validationRuleId given it's Id.