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

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

cancelEventRegistration

Обновлено

POST /api/v1/tools/event-registrations/{seqNum}/cancel

cancelEventRegistration

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

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["events:write"]

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

ПолеЗначение
0.description"Nonblank key; durable receipt keyed by client, operation and key. Replay returns stored result; changed request 422, in-flight/prior failure 409, foreign actor 403."
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema
1.description"Canonical decimal positive-int4 registration sequence, 1..2147483647."
1.in"path"
1.name"seqNum"
1.requiredtrue
1.schema1.schema

Тело запроса

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

Ответы

ПолеЗначение
201.content.application/json.schema201.content.application/json.schema
201.description"cancelEventRegistration"
201.headers.X-Bot-Username.description"Active tenant public bot username, when available"
201.headers.X-Bot-Username.schema201.headers.X-Bot-Username.schema
201.headers.X-Client-Slug.description"Active tenant public slug, when available"
201.headers.X-Client-Slug.schema201.headers.X-Client-Slug.schema
201.headers.X-RateLimit-Limit.description"Computed request budget"
201.headers.X-RateLimit-Limit.schema201.headers.X-RateLimit-Limit.schema
201.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
201.headers.X-RateLimit-Remaining.schema201.headers.X-RateLimit-Remaining.schema
201.headers.X-RateLimit-Reset.description"Budget reset Unix timestamp"
201.headers.X-RateLimit-Reset.schema201.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"VALIDATION_ERROR or IDEMPOTENCY_KEY_REQUIRED"
401.content.application/problem+json.schemaProblemDetails
401.description"INVALID_API_KEY: header OR bearer tgf_*; no surface JWT alternative."
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE, PUBLISHABLE_KEY_NOT_ALLOWED or FORBIDDEN (credential actor does not belong to tenant)"
404.content.application/problem+json.schemaProblemDetails
404.description"NOT_FOUND: tenant-scoped event, user, ticket or registration."
409.content.application/problem+json.schemaProblemDetails
409.description"IDEMPOTENCY_KEY_IN_FLIGHT, IDEMPOTENCY_KEY_FAILED or missing credential provenance"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED"
422.content.application/problem+json.schemaProblemDetails
422.description"IDEMPOTENCY_KEY_MISMATCH"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE"
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"

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

ПолеЗначение
operationId"cancelEventRegistration"
tags["events"]
x-idempotency"durable-receipt"
x-paginationnull