Optimove
Description
Check out our Optimove integrations
Refresh AUTH Token
Run manually if needed
Get ValueSegments
Returns all defined value segment names and IDs
Set Customer Channel Preference
Set communication mode for particular customer IDs for particular channels
Add Template
Creates a new Optimail template
Add Unsubscribers
Adds one or more email addresses to a global unsubscribe list of a particular brand
Delete Unsubscribers
Deletes one email addresses from the global unsubscribe list of a particular brand
Send Transactional Mail
Sends a specific transactional email template to a recipient
Get Customer Future Values
Returns customer IDs and their current future values
Get PromoCodes By Campaign
Returns the recipient group IDs, action IDs and promo codes for a particular campaign ID
Get Last Data Update
Returns the date of the most recently available customer data.
Get TargetGroup Name
Returns the target group name associated with a particular target group ID
Get TargetGroupID
Returns the target group ID associated with a particular target group name
Get PromoCodes By TargetGroup
Returns all recipient group IDs, action IDs and promo codes associated with a given target group on a particular date
Get ActionDetails By TargetGroup
Returns the action IDs, action duration (in days), lead time (in days) and the execution channels associated with a given target group on a particular date
Get Executed CampaignDetails
Returns details of every campaign executed on a particular date
Get Execution Channels
Returns all execution channels that were in use in a campaign
Get Executed Campaign Channel Details
Returns the details of a particular channel used in a particular executed campaign
Get Executed Campaigns By Channel
Returns the list of campaigns executed for a particular channel on a particular date
Get CampaignDetails
Returns details of a particular campaign
Get CustomerActions By TargetGroup
Returns a list of customers and the details of the marketing actions they received, for a particular target group ID on a particular date.
Get Customers Activity EventAttributes
Returns an array of all customer IDs that triggered a particular SDK event on a particular date, along with associated details
RemoveCustomerPII
Causes Optimove to delete all personally identifiable information associated with specified customer IDs
Get ValueSegment Name
Returns the value segment name associated with a particular value segment ID
Get ValueSegmentID
Returns the value segment ID associated with a particular value segment name
Delete Promotions
Removes previously added promo codes
Get Customers By ValueSegment
Returns the list of customer IDs associated with a particular value segment at the current time
Add Promotions
Adds promo codes and associated names that will be available for selection when running a campaign
Get Customers ValueSegment Changed
The customer IDs returned are those whose value segment changed during the last day for which data is available.
Update Customer Attributes
Update Customer Attribute
Get Customer AttributeChangers
Returns an array of customer IDs, and their before and after attribute values, for customers whose selected attribute changed from the past period to the current one
Get TargetGroup Details
Returns an array of IDs, names and priorities for all defined target groups
Add Customer Attribute
Get Customers By Action
Returns the list of customer IDs associated with a particular recipient group and action on a particular date, plus an optional customer attribute
Get Customer OneTimeActions By Date
Returns a list of customers and the details of the marketing actions they received as part of one-time campaigns executed on a particular date
Get Customer OneTimeActions By Campaign
Returns a list of customers and the details associated with a particular one-time campaign
Get Customer Last Action Executed
Returns details of the last action executed for a particular customer ID
Get Customer ActionDetails By Date
Returns customer IDs and details of the campaigns sent to them on a particular date
Get Customers ActionEnded By Date
Returns customer IDs and details of the campaigns they received, for action durations which ended on a particular date
Get Customer ExecutionDetails By Campaign
Returns an array of all customer IDs and the details associated with each customer for a particular campaign ID
Get Customer SendDetails By Campaign
Returns an array of all customer IDs, channel IDs, send times and channel send IDs for a particular campaign ID
Get Customer SendDetails By Channel
Returns an array of all customer IDs, template IDs, send times and customer attributes for a particular combination of channel ID and campaign ID
Get Customer SendDetails By Attribute
Returns an array of all customer IDs, template IDs, send times and customer attributes for a particular combination of channel ID, campaign ID and CustomerAttribute
Get Processed Campaign Customers
Returns an array of all customer IDs and associated promotion codes for a particular campaign ID
Get Currently Targeted Customers
Returns an array of all customer IDs currently included in one or more campaigns
Register Event Listener
Specifies the URL of a listener to which Optimove will report events of the specified type (e.g., "campaign scheduled").
Get Lifecycle StageList
Returns all available lifecycle stages (for use in other functions, e.g., GetCustomerFutureValues
Unregister Event Listener
Instructs Optimove to stop reporting events of the specified event type to a previously-registered listener.
Get Customer Attribute List
Returns all the available customer attribute names (which can be passed to certain other functions as an input parameter) and a description of each.
Get Microsegment List
Returns an array containing the details of all microsegments.
Get Microsegment Changers
Returns an array of customer IDs, and their before and after micro-segment IDs, for customers whose micro-segment changed during the last day for which data is available.
Get Action Name
Returns the action name associated with a particular action ID
Get Action ID
Returns the action ID associated with a particular action name
Get All Actions
Returns all defined action IDs and corresponding action names
Get Actions By TargetGroup
Returns all the recipient group IDs and action IDs associated with a particular target group on a particular date
Get PromoCodes
Returns all target group IDs, action IDs and promo codes for a particular date
Get TargetGroups By Date
Returns the list of target group IDs for which an action was executed on a particular date
Get Canceled Campaign Customers
Returns an array of all customer IDs that had been included in a campaign that was canceled, along with their associated action IDs and promo codes
Get Customer ProductDetails By Campaign
Returns an array of customer IDs and recommended Product IDs for each customer targeted by a particular product recommendation campaign
Get Customer ProductDetails By Date
Returns an array of customer IDs and recommended Product IDs for each customer targeted by any product recommendation campaign on a particular date
Get Customer Product Recommendations
Returns product recommendations (replenishment or recommendation) generated for customers by Optimove
Get CampaignInteraction Customers
Returns an array of Customer IDs and associated details for each customer who performed a particular interaction (generated a particular event) via a particular channel on a particular date
Get Customer Channel Interactions
Returns the details of a particular customer’s interactions with campaigns sent during a particular date range
Get Promotions
Returns an array of all defined promo codes and associated names
Update Customer PromotionStatus
Informs Optimove of the status of activated promotions for particular customer IDs for a particular campaign ID
Add External Realtime Triggers
Defines one or more realtime triggers handled by an external system so that they are selectable by users for realtime campaigns within the Optimove UI
Get Unsubscribers
Allows to retrieve email addresses that are a part of a global unsubscribe list of a particular brand
Send Finalized Transactional Mail
Sends a transactional email template, containing your custom HTML content, to a recipient
Get Transactional UserMetrics
Returns post-execution transactional email metrics for a specific recipient