Proteside Endpoint referenceStores
Update store profile, SDK config and recipients
PATCH
Any subset of fields. recipients is a replace-set: the list sent becomes the full list of pinned recipients.
bearerAuthheader
AuthorizationBearer <token>API token created in Settings → API. Scopes are attached to the token; each operation lists its required scope in x-scope.
id*stringFormat
uuidorg_id?stringPartners only (orgs:manage): act on this child organization. May also be sent as org_id in JSON bodies.
Format
uuidapplication/json- body
mode?stringValue in
"monitor""block"calibration_seconds?integerRange
10 <= value <= 120overlay_check_interval_ms?integerRange
500 <= value <= 60000installation_order_policy?stringValue in
"warn""silent"payment_methods?array<>sensitive_fields?array<string>|null → SDK defaults
expected_iframe_origins?array<string>Hosts (suffix match) of expected payment iframes, e.g. js.stripe.com
allowed_service_workers?array<string>Same-origin paths; [] = no restriction
gtm_containers?array<>Approved GTM containers; [] = no restriction
developer_mode?booleantrue pauses the SDK (config returns paused:true)
release_channel?stringValue in
"stable""latest"name?stringLength
length <= 120country?stringLength
2 <= length <= 2timezone?stringemergency_contact?string|nullrecipients?array<>Replace-set
Items
items <= 50Updated store
application/json- response
id?stringFormat
uuidorg_id?stringFormat
uuidname?stringdomain?stringcountry?stringtimezone?stringstatus?stringValue in
"active""suspended""deleted"sdk_key?stringsafe_slug?string|nullemergency_contact?string|nullcreated_at?stringFormat
date-timeupdated_at?stringFormat
date-timesdk_config?|nullrecipients?array<>curl -X PATCH "https://example.com/stores/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{ "mode": "block", "gtm_containers": [ "GTM-ABC1234" ], "recipients": [ { "method": "pix", "key": "financeiro@lojadojoao.com.br" } ] }'{ "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "org_id": "a40f5d1f-d889-42e9-94ea-b9b33585fc6b", "name": "string", "domain": "string", "country": "string", "timezone": "string", "status": "active", "sdk_key": "string", "safe_slug": "string", "emergency_contact": "string", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "sdk_config": { "mode": "monitor", "calibration_seconds": 0, "overlay_check_interval_ms": 0, "installation_order_policy": "warn", "payment_methods": [ "pix" ], "sensitive_fields": [ "string" ], "expected_iframe_origins": [ "string" ], "allowed_service_workers": [ "string" ], "gtm_containers": [ "string" ], "developer_mode": true, "release_channel": "stable", "updated_at": "2019-08-24T14:15:22Z" }, "recipients": [ { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "method": "pix", "key_masked": "string", "key_hash": "string", "label": "string", "active": true, "created_at": "2019-08-24T14:15:22Z" } ]}