/
OP
optimove
/
Optimove API
Search skmtc…
⌘K
Docs
Sign in
Sign in
APIs
Generators
Stacks
Projects
Docs
History
Schema
Sources
Checked 2w ago · Updated 2w ago
View markdown
optimove
Optimove API
get
Get a promocode by id
v1
latest
OpenAPI 3.0.1
2026-07-24
210
349
345.4 KB
Actions
13
Api Key
1
Batch Query
1
Brand
1
Customers
28
Data Management
4
EmbeddedMessage
1
External Content
1
External System Integration
14
General
4
HealthCheck
1
internal
1
Leaderboard Statistics
3
Leaderboards
4
Levels
3
Management
5
Message
4
Missions
5
Model
4
Optimail
7
Player Profile
2
Player Rewards
2
preview
2
PromoCodeCommand
9
PromoCodeQuery
5
post
Customers Assignment
get
Get upload URL for code files
get
Get a promocode by id
post
Report Customer Redemptions
post
Customer Validation
PromotionCommand
9
PromotionQuery
2
PublisherCommand
3
Query
1
References
3
Rewards
1
Schema
1
SMS Unsubscribes
2
Target Groups
4
target-group
9
TenantCommand
3
TenantQuery
1
Theme
1
Topics
4
Transactional Mail
5
Triggered Conditional Execution Approval
1
Triggered Conditional Execution Settings
3
Triggered Conditional Execution Webhooks
4
Triggers
2
Value Segment
5
post
Add Device
delete
Remove Device
post
Tracking Opens
post
Send Push
delete
Cancel Scheduled Push
post
Send In-App Message
get
Get Unsubscribes
post
Add Unsubscribes (V1)
delete
Delete Unsubscribes (V1)
get
Get Preferences
put
Update Preferences
get
Get Smart Campaign Preferences
put
Update Smart Campaign Preferences
post
Register Player
post
Prize Codes
get
Assigned Prizes
get
Leaderboard
get
Segments
put
/records
post
/records
delete
/records
PromoCodeQuery
Get a promocode by id
get
/v1/promocodes/{promocodeId}
Path parameters
promocodeId
string
required
Response
A successful response.
PromocodequeryserviceGetByIdResponse
required
promocodeId
string
promotionId
string
state
'NOT_EXIST'
|
'AVAILABLE'
|
'PROMOTION_ASSIGNED'
|
'CAMPAIGN_LINKED'
|
'HIDDEN'
version
integer
createdAt
string
date-time
updatedAt
string
date-time
availableCommands
PromocodecommandAvailableCommand[]
uniqueCodes
object
type
'GENERIC'
|
'PERSONALIZED'
|
'NO_CODE'
fallbackConfig
'UNKNOWN'
|
'USE_FALLBACK_CODE'
|
'REJECT_CUSTOMER'
allocationConfig
'UNSET'
|
'ALWAYS_NEW_CODE'
|
'ONE_CODE_PER_CUSTOMER'
alertConfig
CodeUniqueCodesAlertConfig
campaignIds
string[]