Add a custom section
Adds a section of the studio's own (heading up to 80 characters, body plain or rich text up to 2000 characters, optional
imageId of a photo in the library) before the contact section. The first custom section is free; further ones need the
PRO plan (403 PLAN_REQUIRED). The answer is the new section with its id. Draft: the live page changes with POST /storefront/publish. Requires the storefront:write scope and an
Idempotency-Key header.
ApiKeyAuth storefront:writeAuthorizationBearer <shyni_sk_live_*>An API key, issued once and never retrievable again: an organization key in the developer
portal, or a studio key in the studio's admin (Moje studio → API). Send as Authorization: Bearer shyni_sk_live_....
Scope: storefront:write
Idempotency-Key*stringCaller-chosen idempotency token for this write. A retry under the SAME key with
the SAME body replays the first response; the SAME key with a DIFFERENT body is
422 IDEMPOTENCY_KEY_MISMATCH. See Idempotency above.
length <= 64application/json- body
heading*stringlength <= 80body*|Formatted text as a request value - plain text, or a { v: 1, doc } rich text document.
imageId?string|nullThe created section.
application/json- response
id*stringheading*stringbody*Formatted text (a studio's own wording with bold, italic, links and lists). The same text in three projections, so an integration picks what suits it.
Forward compatibility: json.v is the schema version; new node and mark types may be added in
later versions - skip nodes you don't know and fall back to plain.
imageId*string|nullcurl -X POST 'https://api.shyni.io/api/v1/storefront/custom-sections' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "heading": "string", "body": "string"}'Response 201
The created section.
{ "id": "string", "heading": "string", "body": { "plain": "string", "html": "string", "json": { "v": 0, "doc": {} } }, "imageId": "string"}Response 400
A parameter, header or request body is missing, malformed, or out of range. A request body property the endpoint does not define answers UNKNOWN_FIELD instead, with field naming it.
{ "code": "INVALID_INPUT", "message": "Parameter perPage must be between 1 and 100."}Response 401
Missing, malformed, unknown, or revoked API key (INVALID_API_KEY).
{ "code": "INVALID_API_KEY", "message": "Missing or invalid API key."}Response 403
The key is valid but the request is refused. Branch on code: INSUFFICIENT_SCOPE (the key lacks the
permission this endpoint requires), PLAN_REQUIRED (the studio is not on a plan that includes API keys,
Pro and above), ORIGIN_NOT_ALLOWED, SECRET_KEY_IN_BROWSER, or DEMO_STUDIO on a write to the demo studio.
See Authentication and Scopes above.
{ "code": "INSUFFICIENT_SCOPE", "message": "This API key does not have the permission this endpoint requires."}Response 404
The resource does not exist, or belongs to a different studio.
{ "code": "NOT_FOUND", "message": "Order not found."}Response 422
The same Idempotency-Key was already used for a request with a different body, use a new key (see Idempotency above).
{ "code": "IDEMPOTENCY_KEY_MISMATCH", "message": "This Idempotency-Key was already used for a different request. Use a new key."}Response 429
Burst rate limit exceeded.
{ "code": "RATE_LIMITED", "message": "Too many requests. Retry after the time given in the Retry-After header."}