Skip to main content
PUT
What you send is merged into the stored configuration for the API key that made the call, so one write can carry a single field or all of them. Send config_version as the version you last read: the write lands only while that is still the stored version, and the response returns the effective configuration with its new version number. Sending a field as null drops your override and returns that control to its default.
Every header control can be turned off, showClose included. With nothing visible left in it the header is not drawn at all, and closing the editor becomes the host page’s job. Keep twoDShowArtwork or twoDShowFill on, so a shopper always has a way to finish a design in the photo editor.

Authorizations

x-api-key
string
header
required

API key with sm_ prefix. Get your key at https://sudomock.com/dashboard/api-keys

Body

application/json
config_version
integer
required

Version you last read, which must still be the stored one.

Required range: x >= 0
Example:

3

config
StudioConfigPatch · object
required

Configuration values to merge into the stored configuration.

Response

200 - application/json

Successful Response

success
boolean
default:true

True when the configuration was returned.

config
object

The effective Studio configuration for this API key.

Example:
config_version
integer
default:0

Version of the stored configuration, which rises with every update.

Example:

3