К содержанию
TelegaFirst

Для AI-агентов: markdown этой страницы — /docs/api-op-updatestorefront.mdиндекс документации — /llms.txt

updateStorefront

Обновлено

PATCH /api/v1/tools/storefront

Update tenant storefront settings

Авторизация и права

Scopes: ALL. Auth alternatives: OR; scopes внутри альтернативы: ALL.

ПолеЗначение
security.0.hubApiKey[]
security.1.hubBearer[]
securitySchemes.hubApiKey.in"header"
securitySchemes.hubApiKey.name"X-Api-Key"
securitySchemes.hubApiKey.type"apiKey"
securitySchemes.hubBearer.scheme"bearer"
securitySchemes.hubBearer.type"http"
x-required-scopes["storefront:write"]

Параметры запроса

ПолеЗначение
0.description"Optional caller replay key; an empty value bypasses replay"
0.in"header"
0.name"Idempotency-Key"
0.requiredfalse
0.schema0.schema

Тело запроса

ПолеЗначение
content.application/json.schemaStorefrontUpdateRequest
requiredtrue

Ответы

ПолеЗначение
200.content.application/json.schemaStorefrontView
200.description"Tenant display settings, with no internal Client identifier"
200.headers.X-Bot-Username.description"Authenticated public bot username, when available"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Authenticated active tenant slug, when available"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Effective request budget"
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Window reset Unix seconds"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"VALIDATION_ERROR: invalid strict partial patch"
401.content.application/problem+json.schemaProblemDetails
401.description"INVALID_API_KEY: missing, invalid, revoked or conflicting credential headers; surface-session JWT is refused"
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE or NO_ACTIVE_BOT; publishable keys are refused on settings"
404.content.application/problem+json.schemaProblemDetails
404.description"NOT_FOUND: tenant row unavailable"
409.content.application/problem+json.schemaProblemDetails
409.description"SLUG_IMMUTABLE: slug cannot change, or CONFLICT: replay key is processing"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED: per-tool resource limits"
422.content.application/problem+json.schemaProblemDetails
422.description"IDEMPOTENCY_KEY_MISMATCH: same key with a different request"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE: resource budget refusal"
429.headers.Retry-After.description"Retry delay in seconds, when supplied by the limiter"
429.headers.Retry-After.schema429.headers.Retry-After.schema
500.content.application/problem+json.schemaProblemDetails
500.description"INTERNAL_ERROR: unexpected failure; no internal payload is exposed"

Дополнительные условия

ПолеЗначение
description"P3 strict partial settings patch. Omitted members remain unchanged; title/subtitle null clears them. The stored slug is a no-op; a different slug returns SLUG_IMMUTABLE. Writes use the existing context mutator. Idempotency-Key is optional; when supplied, tenant/credential/handler replay retains the result for 24 hours. Surface-session JWT and publishable keys are refused."
operationId"updateStorefront"
summary"Update tenant storefront settings"
tags["storefront"]
x-idempotency.conflictCode"IDEMPOTENCY_KEY_MISMATCH"
x-idempotency.conflictStatus422
x-idempotency.mode"optional"
x-idempotency.profile"generic-v2:StorefrontController:update"
x-idempotency.replayStatus200
x-idempotency.ttlSeconds86400
x-pagination.queryParameters[]
x-pagination.supportedfalse