Replace the subject types of a GENERIC studio
Replaces the whole list of subject types of a GENERIC studio: what a customer brings (a dog, a head of hair) and
which attributes describe it. A detailing (AUTO) studio cannot change its built-in CAR type: 409 CONFLICT.
A type has a code (A-Z, 0-9, _, starting with a letter, at most 32 characters), a label and up to 30
attributes, each with a key (starts with a lower-case letter), a label, a type (text, number, choice,
bool), options (only for choice) and required. identityKeys name the attributes that make one subject the
same subject again (the same dog on the next visit); empty = every order is a new subject. summaryKeys name the
attributes shown in the one-line summary of a subject. A wrong definition is 400 INVALID_INPUT with field
naming the place (types[0].attributes[1].key). Orders already stored keep what they recorded. 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
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
types*array<>The subject types now stored.
application/json- response
types*array<>curl -X PUT 'https://api.shyni.io/api/v1/subject-types' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "types": [ { "code": "string", "label": "string" } ]}'Response 200
The subject types now stored.
{ "types": [ { "code": "string", "label": "string", "attributes": [ { "key": "string", "label": "string", "type": "text", "options": [ "string" ], "required": true } ], "identityKeys": [ "string" ], "identityFallbackKeys": [ "string" ], "summaryKeys": [ "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 409
The request is well-formed but the studio's current state forbids it.
{ "code": "CONFLICT", "message": "The voucher cannot be deactivated because it is not active."}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."}