Change a business
Changes the name, the time zone, the allowed domains or the customer e-mail policy (customerEmails) of a business the organization OWNS; an omitted field
stays, allowedDomains replaces the whole list ([] clears it). A business the organization only has access
to, an unknown, foreign 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
name?stringlength <= 255timezone?stringallowedDomains?array<string>items <= 10customerEmails?stringWhether Shyni e-mails the business's customers, see BusinessCustomerEmails.
"off""branded"The changed business.
application/json- response
id*stringSend it as Shyni-Business to act on this business.
name*stringslug*stringindustry*string"AUTO""GENERIC"timezone*stringIANA time zone.
mode*string"live""test"sandbox*booleanA sandbox business (sample data, simulated payments, test mails); its mode is always test.
archived*booleancreatedAt*stringdate-timeallowedDomains*array<string>Websites a publishable key of this business may be used from.
customerEmails*|Whether Shyni e-mails the business's customers. off (default for a new business): nothing is sent, your
platform sends its own e-mails from the webhooks. branded: Shyni sends the customer e-mails under your
organization's brand, as " přes Shyni". null for a studio the organization only has access to (a
studio always mails its own customers).
"off""branded"nullcurl -X PATCH 'https://api.shyni.io/api/v1/businesses/string' \ -H 'Authorization: Bearer shyni_sk_test_YOUR_KEY' \ -H 'Idempotency-Key: 7f3c9a52-1d4e-4b86-a0c7-5e2b9d8f6a13' \ -H 'Content-Type: application/json' \ -d '{}'Response 200
The changed business.
{ "id": "string", "name": "string", "slug": "string", "industry": "AUTO", "timezone": "string", "mode": "live", "sandbox": true, "archived": true, "createdAt": "2019-08-24T14:15:22Z", "allowedDomains": [ "string" ], "customerEmails": "off"}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 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."}