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

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

setEventPhase

Обновлено

POST /api/v1/tools/events/phase

setEventPhase

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

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"Required for POST with a body. Same-key replay; changed body returns 422."
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

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

Ответы

ПолеЗначение
201.content.application/json.schemaEventView
201.description"setEventPhase"

Ошибки

ПолеЗначение
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: X-Api-Key OR Bearer tgf_*; surface JWT is not accepted."
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE or PUBLISHABLE_KEY_NOT_ALLOWED"
404.content.application/problem+json.schemaProblemDetails
404.description"NOT_FOUND: the event sequence is absent from this tenant."
409.content.application/problem+json.schemaProblemDetails
409.description"CONFLICT: idempotency request still processing"
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED"
422.content.application/problem+json.schemaProblemDetails
422.description"FAILED_PRECONDITION: the move is not allowed from the current phase, or the start time is missing or past; IDEMPOTENCY_KEY_MISMATCH: the key was reused with a different body"
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE"
429.headers.Retry-After.description"Seconds supplied by the resource guard when available."
429.headers.Retry-After.schema429.headers.Retry-After.schema
500.content.application/problem+json.schemaProblemDetails
500.description"INTERNAL_ERROR"

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

ПолеЗначение
operationId"setEventPhase"
summary"setEventPhase"
tags["events"]
x-idempotency"generic-cache"
x-paginationnull