Jump to Content
Home
Guides
API Reference
Change log
API Reference
Moon (Dark Mode)
Sun (Light Mode)
Home
Guides
API Reference
Change log
Get a promocode by id
Search
JUMP TO
Optimove API
Getting Started with Optimove API
Optimove API Overview
Glossary
General Information
Generating API Keys
Authentication Guide
Roles & Permissions
Rate Limits
IP Allow List
Error Handling
General
Last Data Update
get
Register Event Listener
post
Unregister Event Listener
post
Registered Event Listeners
get
Api Key
Api Key Info
get
Model
Customer Attribute List
get
Lifecycle Stage List
get
Microsegment List
get
MicroSegment Changers
get
Actions
All Actions
get
Actions By Target Group
get
Action ID
get
Action Name
get
Action Details By Target Group
get
Promo Codes
get
Promo Codes By Campaign
get
Promo Codes By Target Group
get
Executed Campaign Details
get
Campaign Details
get
Execution Channels
get
Executed Campaigns By Channel
get
Executed Campaign Channel Details
get
Target Groups
Target Groups By Date
get
Target Group ID
get
Target Group Name
get
Target Group Details
get
Customers
Currently Targeted Customers
get
Processed Campaign Customers
get
Customer Last Action Executed
get
Customer Actions By Target Group
get
Customer One Time Actions By Campaign
get
Customer One Time Actions By Date
get
Customers By Action
get
Customers Action Ended By Date
get
Customer Send Details By Campaign
get
Customer Send Details By Channel
get
Customer Execution Details By Campaign
get
Customer Action Details By Date
get
Customer Product Details By Date
get
Customer Product Details By Campaign
get
Customer Product Recommendations
get
Customer Future Values
get
Customers Activity Event Attributes
get
Campaign Interaction Customers
get
Customer Channel Interactions
get
Customer Attributes
get
Add Customer Attribute
post
Update Customer Attributes
post
Customer Attribute Changers
get
Remove Customer PII
post
Value Segment
Value Segments
get
Value Segment ID
get
Value Segment Name
get
Customers By Value Segment
get
Value Segment Changers
get
External System Integration
Channel Templates
get
Channel Template Details
get
Add Channel Templates
post
Delete Channel Templates
post
Add Channel Apps
post
Delete Channel Apps
post
Promotions
get
Add Promotions
post
Delete Promotions
post
Activity Event List
get
Update Campaign Metrics
post
Update Campaign Interactions
post
Update Customer Promotion Status
post
Set Customer Channel Preference
post
Optimail
Template Folders
get
Email Parameters
get
Add Template
post
Update Template
post
Unsubscribers
get
Add Unsubscribers
post
Delete Unsubscribers
post
Transactional Mail
Send Transactional Mail
post
Send Finalized Transactional Mail
post
Template Details
get
Transactional Template Metrics
get
Transactional User Metrics
get
OptiMobile & OptiWeb
Overview
OptiMobile SDK Reference
No-SDK Integration
Add Device
post
Receiving Push Notifications
Tracking Opens
post
Remove Device
delete
Transactional Messaging
Send Push
post
Cancel Scheduled Push
delete
Send In-App Message
post
Testing and Troubleshooting
Optimobile Web Inbox API
Overview
REST API
Message
Get Web Inbox user messages
get
Update Web Inbox message read status
put
Report Web Inbox Message metrics
post
Delete Web Inbox message
delete
OptiText API
Unsubscribes
Add Unsubscribes
post
Get Unsubscribes
get
Delete Unsubscribes
delete
Preference Center
Get Preferences
get
Update Preferences
put
Promotions
Tenant Query
Get a tenant by id
get
Get a signed upload URL (e.g., image for Reward Type)
get
Tenant Command
Create a tenant
post
Delete an existing tenant
delete
Activate a draft or deactivated tenant
patch
Set the amount reward type default for all tenant promotions
patch
Add or change the customer property schemas
patch
Deactivate an active tenant
patch
Set the license limits & quotas
patch
Set metadata to a draft or deactivated tenant
patch
Add or change the promotion property schemas
patch
Create a tenant transaction
post
Set the unit reward type default for all tenant promotions
patch
Promotion Query
Get a promotion by id
get
Validate promotion customers
post
Promotion Command
Create a promotion
post
Archive an existing promotion
delete
Activate a draft or deactivated promotion
patch
Deactivate an active promotion
patch
Duplicate an existing promotion
post
Set metadata in promotion
patch
Set the list of promotion tiers in a promotion
patch
Set properties in a promotion
patch
Create a promotion transaction
post
Preview
Set the publishing budgets for a promotion
patch
Set the reward constraints for a promotion
patch
PromoCode Query
Get a promocode by id
get
Validates the given customers for a Promocode
post
PromoCode Command
Create a promocode
post
Assign a promotion to promocode
patch
Hide promocode from list
patch
Link a promocode to campaign
patch
Show promocode in list
patch
Create a promocode transaction
post
Unassign a promotion from promocode
patch
Unlink a promocode from campaign
patch
Sports Inventory REST API
/records
put
put
post
post
delete
delete
Get a promocode by id
get
https://example.com/v1/promocodes/
{promocodeId}
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
RESPONSE
Click
Try It!
to start a request and see the response here!
