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

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

submitFormSubmission

Обновлено

POST /api/v1/form-submissions

submitFormSubmission

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

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"Required for a nonempty POST body by the canonical24-hour HTTP response receipt."
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

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

Ответы

ПолеЗначение
202.content.application/json.schema202.content.application/json.schema
202.description"Accept a form submission for the authenticated tenant"
202.headers.X-Bot-Username.description"Active tenant public bot username, when available"
202.headers.X-Bot-Username.schema202.headers.X-Bot-Username.schema
202.headers.X-Client-Slug.description"Active tenant public slug, when available"
202.headers.X-Client-Slug.schema202.headers.X-Client-Slug.schema
202.headers.X-RateLimit-Limit.description"Computed request budget"
202.headers.X-RateLimit-Limit.schema202.headers.X-RateLimit-Limit.schema
202.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
202.headers.X-RateLimit-Remaining.schema202.headers.X-RateLimit-Remaining.schema
202.headers.X-RateLimit-Reset.description"Budget reset Unix timestamp"
202.headers.X-RateLimit-Reset.schema202.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Malformed or unknown request field, or missing Idempotency-Key on a nonempty POST body"
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"Form does not exist for 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"VALIDATION_ERROR: submission violates form declaration; changed idempotent body emits IDEMPOTENCY_KEY_MISMATCH"
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"

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

ПолеЗначение
operationId"submitFormSubmission"
tags["form-submissions"]
x-idempotency"http-cache"