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

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

setFormSubmissionHandled

Обновлено

PATCH /api/v1/form-submissions/{seqNum}

Mark a submission handled, or back to new

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

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["push:form_submissions"]

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

ПолеЗначение
0.description"Optional; when present the 24-hour HTTP response receipt replays the first answer."
0.in"header"
0.name"Idempotency-Key"
0.requiredfalse
0.schema0.schema
1.in"path"
1.name"seqNum"
1.requiredtrue
1.schema1.schema

Тело запроса

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

Ответы

ПолеЗначение
200.content.application/json.schema200.content.application/json.schema
200.description"The submission is in the requested state"
200.headers.X-Bot-Username.description"Active tenant public bot username, when available"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Active tenant public slug, when available"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Computed 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"Budget reset Unix timestamp"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Malformed submission number, or a body other than {handled: boolean}"
401.content.application/problem+json.schemaProblemDetails
401.description"Missing or invalid API key"
403.content.application/problem+json.schemaProblemDetails
403.description"Scope or resource policy refused the request"
404.content.application/problem+json.schemaProblemDetails
404.description"NOT_FOUND: no submission with this number in the authenticated tenant"
409.content.application/problem+json.schemaProblemDetails
409.description"CONFLICT: command with this Idempotency-Key is already processing"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED: resource policy cap exceeded"
422.content.application/problem+json.schemaProblemDetails
422.description"IDEMPOTENCY_KEY_MISMATCH: the Idempotency-Key was used with a different body"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE: resource limiter refuses or fails closed"
429.headers.Retry-After.description"Seconds supplied by resource guard when available"
429.headers.Retry-After.schema429.headers.Retry-After.schema
500.content.application/problem+json.schemaProblemDetails
500.description"INTERNAL_ERROR: unexpected storage or service failure"

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

ПолеЗначение
description"Two-way status toggle (ADR-330 D5): handled:true marks the submission handled, handled:false returns it to new. The tenant submission number addresses it. outcome changed = this call moved it; unchanged = it already was in that state. The submission card in the operators' topic is redrawn either way."
operationId"setFormSubmissionHandled"
summary"Mark a submission handled, or back to new"
tags["form-submissions"]
x-idempotency"http-cache"