UNDOCUMENTEDPOST

CreateMarketingMessage

Create a new marketing message.

https://api.steampowered.com/IMarketingMessagesService/CreateMarketingMessage/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
CMarketingMessageProto No
↳ fixed64 No
↳ string No
↳ EMarketingMessageType Noenum
↳ EMarketingMessageVisibility Noenum
↳ uint32 No
↳ EMarketingMessageAssociationType Noenum
↳ uint32 No
↳ string No
↳ uint32 No
↳ uint32 No
↳ string No
↳ string No
↳
bool No
↳ uint32 No
↳ uint32 No
↳ uint32 No
↳ uint32 No
↳ uint32 No
↳ string No
↳ string No
↳ string No
↳ uint32 No
↳ string No
↳ string No
↳ string No
bool NoIf set, then overwrite the template_vars and additional_restrictions keyvalues from json
UNDOCUMENTEDPOST

DeleteMarketingMessage

Delete a marketing message.

https://api.steampowered.com/IMarketingMessagesService/DeleteMarketingMessage/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No

Returns a boolean if the user has pending marketing messages. Intended to be fast.

https://api.steampowered.com/IMarketingMessagesService/DoesUserHavePendingMarketingMessages/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
string No
int32 No
int32 NoEOSType from client
int32 No
UNDOCUMENTEDPOST

FindMarketingMessages

Search for marketing messages by name, type, etc.

https://api.steampowered.com/IMarketingMessagesService/FindMarketingMessages/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
EMarketingMessageLookupType Noenum
fixed64 No
EMarketingMessageType Noenum
fixed64[] No
string No
uint32 No

Get a list of active marketing messages.

https://api.steampowered.com/IMarketingMessagesService/GetActiveMarketingMessages/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
string No
bool NoWill not return any marketing message that requires ownership/playtime/wishlist

Get a single marketing message, cacheable.

https://api.steampowered.com/IMarketingMessagesService/GetDisplayMarketingMessage/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
StoreBrowseContext No
↳ string No
↳ int32 No
↳ string No
StoreBrowseItemDataRequest NoIf passed, item data will be returned
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ int32 No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ StoreBrowseItemDataRequest No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No

Get a single marketing message, cacheable.

https://api.steampowered.com/IMarketingMessagesService/GetDisplayMarketingMessageAdmin/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
StoreBrowseContext No
↳ string No
↳ int32 No
↳ string No
StoreBrowseItemDataRequest NoIf passed, item data will be returned
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ int32 No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ StoreBrowseItemDataRequest No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No

Get a single marketing message, which can be customized per user.

https://api.steampowered.com/IMarketingMessagesService/GetDisplayMarketingMessageForUser/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
StoreBrowseContext No
↳ string No
↳ int32 No
↳ string No
StoreBrowseItemDataRequest NoIf passed, item data will be returned
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ int32 No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ StoreBrowseItemDataRequest No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
UNDOCUMENTEDPOST

GetMarketingMessage

Get a single marketing message. Admin account needed for non-active messages

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessage/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessageClickedStats/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No

For a specific marketing message, then all of the viewership stats for the date range it was intended to be visible to customers

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessageViewerStats/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesForApps/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
uint32[] No
https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesForPartner/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
uint32 No

Get a list of active marketing messages filtered for a specific user.

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesForUser/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
bool No
string No
int32 No
int32 NoEOSType from client
int32 No
StoreBrowseContext NoOptional, server can fill in from country code/language if not set
↳ string No
↳ int32 No
↳ string No
StoreBrowseItemDataRequest NoIf passed, item data will be returned
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ int32 No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳ StoreBrowseItemDataRequest No
↳
bool No
↳
bool No
↳
bool No
↳
bool No
↳
bool No

For a time range, return the seen stats across all of the marketing messages

https://api.steampowered.com/IMarketingMessagesService/GetMarketingMessagesViewerRangeStats/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
uint32 No
uint32 No

partner endpoint to get a marketing message preview that is approved for publishing

https://api.steampowered.com/IMarketingMessagesService/GetPartnerMessagePreview/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
uint32 No

Are there any marketing messages that are staged for this partner to control publishing and visibility upon?

https://api.steampowered.com/IMarketingMessagesService/GetPartnerReadyToPublishMessages/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
uint32 No
https://api.steampowered.com/IMarketingMessagesService/GetPastMarketingMessages/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
uint32 No
uint32 No
UNDOCUMENTEDPOST

MarkMessageClicked

https://api.steampowered.com/IMarketingMessagesService/MarkMessageClicked/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
uint32 No
int32 Noenum
int32 Noenum
UNDOCUMENTEDPOST

MarkMessageSeen

Mark that a user has viewed a message (so we won't show it again)'.

https://api.steampowered.com/IMarketingMessagesService/MarkMessageSeen/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
uint32 NoWhere in the stack was the marketing message, 1-based, zero means we don't know
EMarketingMessageTemplateType NoWhich type of template did they see

partner endpoint to publish a marketing message

https://api.steampowered.com/IMarketingMessagesService/PublishPartnerMessage/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
uint32 No
UNDOCUMENTEDPOST

UpdateMarketingMessage

Modify a marketing message.

https://api.steampowered.com/IMarketingMessagesService/UpdateMarketingMessage/v1/
NameValueTypeRequiredDescription
click to setstring Yes Access key
fixed64 No
CMarketingMessageProto No
↳ fixed64 No
↳ string No
↳ EMarketingMessageType Noenum
↳ EMarketingMessageVisibility Noenum
↳ uint32 No
↳ EMarketingMessageAssociationType Noenum
↳ uint32 No
↳ string No
↳ uint32 No
↳ uint32 No
↳ string No
↳ string No
↳
bool No
↳ uint32 No
↳ uint32 No
↳ uint32 No
↳ uint32 No
↳ uint32 No
↳ string No
↳ string No
↳ string No
↳ uint32 No
↳ string No
↳ string No
↳ string No
bool NoIf set, then overwrite the template_vars and additional_restrictions keyvalues from json