Set user preferences
Creates or updates the payment channel preference for a user. This is a server-side endpoint and should not be called from the client.
Versioned HMAC-SHA256 signature authenticating server-to-server SDK requests (your backend calling Stash), as opposed to client-side SDK operations. Recommended over the deprecated X-Stash-Api-Key for the best security. Header format: v1;{appId};{unixMillisTimestamp};{base64Signature} (semicolon-delimited). {base64Signature} is the base64-encoded HMAC-SHA256 of the string {unixMillisTimestamp}.{requestBody} using your app ingress secret (the ingress secret is shown base64-encoded in Studio; base64-decode it to the raw bytes used as the HMAC key), where {requestBody} is the request body exactly as you send it for POST and PUT requests (the compact canonical request JSON is also accepted) and empty for GET requests. A signature over the exact bytes verifies for bodies of up to 18 KiB (18,432 bytes); a larger body may be refused with 401 even when correctly signed. The timestamp must be within 5 minutes of Stash server time. Your appId is your immutable app identifier, shown in Stash Studio under Project Settings > App details; your ingress secret is under Project Settings > API Secrets.
In: header
Path Parameters
User ID (external user ID from the game/application). Extracted from URL path.
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
curl -X POST "https://example.com/sdk/server/user_preferences/string" \ -H "Content-Type: application/json" \ -d '{ "paymentChannel": "UNSPECIFIED" }'{}How is this guide?
Get user preferences GET
Retrieves the payment channel preference for a specific user. Returns 404 NotFound if no preference is set.
Get maintenance mode GET
Returns whether your web shop is in maintenance mode and, while it is, since when. Each shop may make up to 60 calls every 60 seconds; above that it returns 429 with a RetryInfo detail giving how long to wait. This is a server-side endpoint and should not be called from the client.