Set the stages of a service group
Replaces the stages (the tiers of the group's scale) with the given services in that order. A service that drops out becomes a
classic service again and loses its question links. A service of another group is 400 (field: serviceIds), an unknown one 404.
Answers with the group. Draft. Audited with the API key as the actor. PRO plan and above, as on the admin. Requires the catalog:write scope and an Idempotency-Key header.
ApiKeyAuth catalog: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: catalog:write
id*stringThe group id.
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
serviceIds*array<string>The service ids in scale order.
The group.
application/json- response
A service group (configurator) as the group endpoints show it: the DRAFT rows the studio edits. Every id is the logical id the
endpoints take. findings are the structure problems that block POST /catalog/publish.
id*stringslug*stringname*stringsortOrder*integercategoryId*stringinspectionMode*string"OFF""OPTION""FIRST"defaultServiceId*|The service id of the default stage.
lead*string|nullscaleTitle*string|nullimageId*string|nullstages*array<>questions*array<>entries*array<>findings*array<>curl -X PUT 'https://api.shyni.io/api/v1/service-groups/string/stages' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "serviceIds": [ "string" ]}'Response 200
The group.
{ "id": "string", "slug": "string", "name": "string", "sortOrder": 0, "categoryId": "string", "inspectionMode": "OFF", "defaultServiceId": "string", "lead": "string", "scaleTitle": "string", "imageId": "string", "stages": [ { "serviceId": "string", "name": "string", "label": "string", "forWhom": "string", "groupOrder": 0 } ], "questions": [ { "id": "string", "groupId": "string", "name": "string", "sortOrder": 0, "unansweredName": "string", "unansweredSentence": "string", "options": [ { "id": "string", "name": "string", "sentence": "string", "surcharge": 0, "scalesWithSize": true, "extraMinutes": 0, "isDefault": true } ], "stageLinks": [ { "serviceId": "string", "required": true, "requiredSentence": "string" } ] } ], "entries": [ { "id": "string", "name": "string", "lead": "string", "serviceId": "string", "optionIds": [ "string" ], "sortOrder": 0 } ], "findings": [ { "code": "string", "refs": [ "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."}