Invite the owner of a studio
Invites your client as the owner of a studio the organization still owns: Shyni e-mails him a sign-in link
(valid 7 days) naming your organization. When he signs in and accepts the terms and the privacy policy the
studio becomes his (handedOver: true); only then does the studio's own plan apply. A repeated call replaces
the previous invitation (its link stops working) and may name another address. After the hand-over the call is
409 CONFLICT. A foreign, unknown or archived id is 404 BUSINESS_NOT_FOUND. Audited with the API key as the
actor. Org-level: send no Shyni-Business header. Requires the businesses:manage scope and an Idempotency-Key header.
ApiKeyAuth businesses:manageAuthorizationBearer <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: businesses:manage
id*stringIdempotency-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
email*stringAddress the sign-in link is sent to.
name*stringHow the owner is called in the studio's team.
length <= 100The studio with the pending invitation (ownerInvite).
application/json- response
id*stringSend it as Shyni-Business to act on this studio.
name*stringslug*stringcreatedAt*stringdate-timehandedOver*booleantrue once the owner took the studio over (or the organization only has access to it); the studio's own plan applies from then on.
ownerInvite*|The pending owner invitation; null before the first invitation and after the hand-over.
curl -X POST 'https://api.shyni.io/api/v1/studios/string/owner-invite' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{ "email": "string", "name": "string"}'Response 200
The studio with the pending invitation (ownerInvite).
{ "id": "string", "name": "string", "slug": "string", "createdAt": "2019-08-24T14:15:22Z", "handedOver": true, "ownerInvite": { "email": "string", "sentAt": "2019-08-24T14:15:22Z" }}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 business does not exist, belongs to another organization, was archived or has another mode than the key (BUSINESS_NOT_FOUND) - one answer for all of them.
{ "code": "BUSINESS_NOT_FOUND", "message": "Business not found."}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."}