IPromotionPlanningService
/
Steam Web API Documentation
by
xPaw
Steam
IAccountCartService
IAccountHardwareService
IAccountPrivacyService
IAccountPrivateAppsService
IAppContentDescriptorService
IAssetSetPublishingService
IAuctionService
IAuthenticationService
IAuthenticationSupportService
IBillingService
IBroadcastService
IChatRoomService
ICheatReportingService
ICheckoutService
IClanFAQSService
IClanService
IClientCommService
IClientMetricsService
ICloudService
ICommentModerationService
ICommunityService
IContentFilteringService
IContentModerationService
IContentServerConfigService
IContentServerDirectoryService
ICrashReportService
ICredentialsService
IDailyDealService
IDataPublisherService
IEconMarketService
IEconService
IEmbeddedClientService
IFamilyGroupsService
IForumsService
IFriendMessagesService
IFriendsListService
IGameCoordinator
IGameInventory
IGameNotificationsService
IGamePerformanceStatsService
IGameRecordingClipService
IGameServersService
IHardwareTeamService
IHelpRequestLogsService
IInventoryService
ILobbyMatchmakingService
ILoyaltyRewardsService
IMarketingMessagesService
IMobileAppService
IMobileAuthService
IMobileDeviceService
IMobileNotificationService
INewsService
IOnlinePlayService
IParentalService
IPartnerAppNotesService
IPartnerDeadlineService
IPartnerDismissService
IPartnerFinancialsService
IPartnerMeetSteamService
IPartnerMembershipInviteService
IPartnerStoreBrowseService
IPhoneService
IPhysicalGoodsService
IPlayerService
IPlaytestService
IProductInfoService
IPromotionEventInvitesService
IPromotionPlanningService
CreatePlan
CreateSalePageForPromo
CreateTentativePlan
DeletePlan
GetAdvertisingAppsForPartner
GetAllActivePlan
GetAllPlansForApps
GetAllPlansForPartner
GetPlan
GetPlanByAssociationID
GetPlanByInputAccessKey
GetPlanCompletedInDateRange
GetPlansUpdatedSince
GetPromotionPlanForSalePages
GetPromotionPlanSalesDaily
GetSalePageCandidatesForPromo
GetUpcomingScheduledDiscounts
MarkLocalizationAssetComplete
SearchPlan
SendNotification
UpdatePlan
UpdatePlanInputData
UpdatePlanPartnerInfo
IPromotionStatsService
IPublishedFileModerationService
IPublishedFileService
IPublishingService
IQuestService
IRemoteClientService
ISaleFeatureService
ISaleItemRewardsService
IShoppingCartService
ISiteLicenseService
ISteamApps
ISteamAwardsService
ISteamBitPay
ISteamBoaCompra
ISteamBroadcast
ISteamCDN
ISteamChartsService
ISteamCloudGaming
ISteamCommunity
ISteamDirectory
ISteamEconomy
ISteamEnvoy
ISteamGPTRenderFarmService
ISteamGPTService
ISteamGameServerStats
ISteamLeaderboards
ISteamLearnService
ISteamMLService
ISteamMicroTxn
ISteamMicroTxnSandbox
ISteamNews
ISteamNodwin
ISteamNotificationService
ISteamPayPalPaymentsHub
ISteamPublishedItemSearch
ISteamPublishedItemVoting
ISteamRemoteStorage
ISteamSpecialSurvey
ISteamTVService
ISteamUser
ISteamUserAuth
ISteamUserOAuth
ISteamUserStats
ISteamWebAPIUtil
ISteamWorkshop
IStoreAppSimilarityService
IStoreBrowseService
IStoreCatalogService
IStoreCurationService
IStoreMarketingService
IStorePreferencesService
IStoreQueryService
IStoreSalesService
IStoreService
IStoreTopSellersService
ISupportAgentsService
ISupportService
ITestExternalPrivilegeService
ITestService
ITrustService
ITwoFactorService
IUserAccountService
IUserGameNotesService
IUserReviewsService
IUserStoreVisitService
IVACManagementService
IVideoService
IWishlistService
IWorkshopService
Counter-Strike 2
ICSGOPlayers_730
ICSGOServers_730
ICSGOStreamSystem_730
ICSGOTournaments_730
IEconItems_730
IGCVersion_730
Dota 2
IDOTA2AutomatedTourney_570
IDOTA2CustomGames_570
IDOTA2Events_570
IDOTA2Fantasy_570
IDOTA2Guild_570
IDOTA2League_570
IDOTA2MatchStats_570
IDOTA2Match_570
IDOTA2Operations_570
IDOTA2Plus_570
IDOTA2StreamSystem_570
IDOTA2Teams_570
IDOTA2Ticket_570
IDOTAChat_570
IEconDOTA2_570
IEconItems_570
IGCVersion_570
Team Fortress 2
IEconItems_440
IGCVersion_440
ITFItems_440
ITFPromos_440
ITFSystem_440
Deadlock
ICitadelAdmin_1422450
IGCVersion_1422450
Portal 2
IEconItems_620
IPortal2Leaderboards_620
ITFPromos_620
Dota Underlords
IClientStats_1046930
IEconItems_1046930
IGCVersion_1046930
Artifact Classic
IEconItems_583950
IGCVersion_583950
Artifact Foundry
IEconItems_1269260
IGCVersion_1269260
Dota 2 Experimental
IDOTA2AutomatedTourney_247040
IDOTA2CustomGames_247040
IDOTA2Events_247040
IDOTA2Fantasy_247040
IDOTA2Guild_247040
IDOTA2League_247040
IDOTA2MatchStats_247040
IDOTA2Match_247040
IDOTA2Operations_247040
IDOTA2Plus_247040
IDOTA2StreamSystem_247040
IDOTA2Teams_247040
IDOTA2Ticket_247040
IDOTAChat_247040
IEconDOTA2_247040
IEconItems_247040
IGCVersion_247040
Dota 2 Staging
IDOTA2AutomatedTourney_2305270
IDOTA2CustomGames_2305270
IDOTA2Events_2305270
IDOTA2Fantasy_2305270
IDOTA2Guild_2305270
IDOTA2League_2305270
IDOTA2Operations_2305270
IDOTA2Plus_2305270
IDOTA2Teams_2305270
IDOTAChat_2305270
IGCVersion_2305270
Deadlock Experimental
ICitadelAdmin_3488080
IGCVersion_3488080
Deadlock Unknown
ICitadelAdmin_3781850
IGCVersion_3781850
UNDOCUMENTED
POST
CreatePlan
Execute
https://api.steampowered.com/IPromotionPlanningService/CreatePlan/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
plan
CPromotionPlan
No
↳
promotion_id
fixed64
No
↳
admin_jsondata
string
No
↳
partner_jsondata
string
No
↳
input_jsondata
string
No
↳
rtime32_start_time
uint32
No
↳
rtime32_end_time
uint32
No
↳
partner_id
uint32
No
↳
input_access_key
string
No
↳
last_update_time
uint32
No
↳
partner_readonly_jsondata
string
No
↳
partner_writable_jsondata
string
No
↳
assets_readonly_jsondata
string
No
↳
assets_writable_jsondata
string
No
UNDOCUMENTED
POST
CreateSalePageForPromo
Execute
https://api.steampowered.com/IPromotionPlanningService/CreateSalePageForPromo/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
clan_account_id
uint32
No
clan_event_gid
fixed64
No
rtime_sale_start
uint32
No
rtime_sale_end
uint32
No
daily_deal_gid
fixed64
No
promotion_gid
fixed64
No
create_asset_request
bool
No
partner_id
uint32
No
advertising_appid
uint32
No
UNDOCUMENTED
POST
CreateTentativePlan
Execute
https://api.steampowered.com/IPromotionPlanningService/CreateTentativePlan/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
plan
CPromotionPlan
No
↳
promotion_id
fixed64
No
↳
admin_jsondata
string
No
↳
partner_jsondata
string
No
↳
input_jsondata
string
No
↳
rtime32_start_time
uint32
No
↳
rtime32_end_time
uint32
No
↳
partner_id
uint32
No
↳
input_access_key
string
No
↳
last_update_time
uint32
No
↳
partner_readonly_jsondata
string
No
↳
partner_writable_jsondata
string
No
↳
assets_readonly_jsondata
string
No
↳
assets_writable_jsondata
string
No
UNDOCUMENTED
POST
DeletePlan
Execute
https://api.steampowered.com/IPromotionPlanningService/DeletePlan/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
promotion_id
fixed64
No
UNDOCUMENTED
GetAdvertisingAppsForPartner
Execute
https://api.steampowered.com/IPromotionPlanningService/GetAdvertisingAppsForPartner/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
partner_id
uint32
No
UNDOCUMENTED
GetAllActivePlan
Execute
https://api.steampowered.com/IPromotionPlanningService/GetAllActivePlan/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
UNDOCUMENTED
GetAllPlansForApps
Execute
https://api.steampowered.com/IPromotionPlanningService/GetAllPlansForApps/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
appids[0]
+
uint32[]
No
exclude_sales
bool
No
exclude_direct_featuring
bool
No
UNDOCUMENTED
GetAllPlansForPartner
Execute
https://api.steampowered.com/IPromotionPlanningService/GetAllPlansForPartner/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
partnerid
uint32
No
start_date_after_rtime
uint32
No
start_date_before_rtime
uint32
No
show_hidden
bool
No
start_date
uint32
No
end_date
uint32
No
UNDOCUMENTED
GetPlan
Execute
https://api.steampowered.com/IPromotionPlanningService/GetPlan/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
promotion_id
fixed64
No
UNDOCUMENTED
GetPlanByAssociationID
Execute
https://api.steampowered.com/IPromotionPlanningService/GetPlanByAssociationID/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
requested[0]
+
CPromoAssociation[]
No
↳
type
int32
No
enum
↳
gid
fixed64
No
↳
promotion_planid
fixed64
No
UNDOCUMENTED
GetPlanByInputAccessKey
Execute
https://api.steampowered.com/IPromotionPlanningService/GetPlanByInputAccessKey/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
input_access_key
string
No
UNDOCUMENTED
GetPlanCompletedInDateRange
Execute
https://api.steampowered.com/IPromotionPlanningService/GetPlanCompletedInDateRange/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
oldest_rtime
uint32
No
newest_rtime
uint32
No
promotion_types[0]
+
string[]
No
UNDOCUMENTED
GetPlansUpdatedSince
Execute
https://api.steampowered.com/IPromotionPlanningService/GetPlansUpdatedSince/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
rtime
uint32
No
upto_rtime
uint32
No
UNDOCUMENTED
GetPromotionPlanForSalePages
Execute
https://api.steampowered.com/IPromotionPlanningService/GetPromotionPlanForSalePages/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
request_list[0]
+
CPromotionPlanning_GetPromotionPlanForSalePages_Request_CSalePage[]
No
↳
clan_account_id
uint32
No
↳
gid_clan_event
fixed64
No
UNDOCUMENTED
GetPromotionPlanSalesDaily
Execute
https://api.steampowered.com/IPromotionPlanningService/GetPromotionPlanSalesDaily/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
promotionids[0]
+
uint64[]
No
partnerid
uint32
No
UNDOCUMENTED
GetSalePageCandidatesForPromo
Execute
https://api.steampowered.com/IPromotionPlanningService/GetSalePageCandidatesForPromo/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
account_id
uint32
No
include_published
bool
No
UNDOCUMENTED
GetUpcomingScheduledDiscounts
Execute
https://api.steampowered.com/IPromotionPlanningService/GetUpcomingScheduledDiscounts/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
rtstart
uint32
No
rtend
uint32
No
include_packages
bool
No
filter_modified_sales_rank
bool
No
UNDOCUMENTED
POST
MarkLocalizationAssetComplete
Execute
https://api.steampowered.com/IPromotionPlanningService/MarkLocalizationAssetComplete/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
promotion_id
fixed64
No
value
bool
No
UNDOCUMENTED
SearchPlan
Execute
https://api.steampowered.com/IPromotionPlanningService/SearchPlan/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
token
string
No
UNDOCUMENTED
POST
SendNotification
Execute
https://api.steampowered.com/IPromotionPlanningService/SendNotification/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
promotion_id
fixed64
No
notification_type
int32
No
enum
only_explicit_email_addresses
bool
No
If true, then only contact explicitly added emails to the promotion plan
UNDOCUMENTED
POST
UpdatePlan
Execute
https://api.steampowered.com/IPromotionPlanningService/UpdatePlan/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
plan
CPromotionPlan
No
↳
promotion_id
fixed64
No
↳
admin_jsondata
string
No
↳
partner_jsondata
string
No
↳
input_jsondata
string
No
↳
rtime32_start_time
uint32
No
↳
rtime32_end_time
uint32
No
↳
partner_id
uint32
No
↳
input_access_key
string
No
↳
last_update_time
uint32
No
↳
partner_readonly_jsondata
string
No
↳
partner_writable_jsondata
string
No
↳
assets_readonly_jsondata
string
No
↳
assets_writable_jsondata
string
No
promotion_id
fixed64
No
UNDOCUMENTED
POST
UpdatePlanInputData
Execute
https://api.steampowered.com/IPromotionPlanningService/UpdatePlanInputData/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
plan
CPromotionPlan
No
↳
promotion_id
fixed64
No
↳
admin_jsondata
string
No
↳
partner_jsondata
string
No
↳
input_jsondata
string
No
↳
rtime32_start_time
uint32
No
↳
rtime32_end_time
uint32
No
↳
partner_id
uint32
No
↳
input_access_key
string
No
↳
last_update_time
uint32
No
↳
partner_readonly_jsondata
string
No
↳
partner_writable_jsondata
string
No
↳
assets_readonly_jsondata
string
No
↳
assets_writable_jsondata
string
No
promotion_id
fixed64
No
UNDOCUMENTED
POST
UpdatePlanPartnerInfo
Execute
https://api.steampowered.com/IPromotionPlanningService/UpdatePlanPartnerInfo/v1/
Name
Value
Type
Required
Description
key
click to set
string
Yes
Access key
plan
CPromotionPlan
No
↳
promotion_id
fixed64
No
↳
admin_jsondata
string
No
↳
partner_jsondata
string
No
↳
input_jsondata
string
No
↳
rtime32_start_time
uint32
No
↳
rtime32_end_time
uint32
No
↳
partner_id
uint32
No
↳
input_access_key
string
No
↳
last_update_time
uint32
No
↳
partner_readonly_jsondata
string
No
↳
partner_writable_jsondata
string
No
↳
assets_readonly_jsondata
string
No
↳
assets_writable_jsondata
string
No
promotion_id
fixed64
No