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

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

deleteSavedSegment

Обновлено

DELETE /api/v1/tools/segments/saved/{seqNum}

Delete an unreferenced saved filter with optimistic version

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

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

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

ПолеЗначение
0.description"Replay the same tenant, credential, controller handler and request for 24 hours."
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.schemaSavedSegmentDeleteRequest
requiredtrue

Ответы

ПолеЗначение
200.content.application/json.schemaSavedSegmentDeleteResult
200.description"Deleted saved segment."
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Strict path/body validation failed."
400.x-error-codes["VALIDATION_ERROR"]
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid, revoked, expired or conflicting API credentials; surface-session JWT is not accepted."
401.x-error-codes["INVALID_API_KEY"]
403.content.application/problem+json.schemaProblemDetails
403.description"Required effective scope, non-publishable credential and an active bot are mandatory."
403.x-error-codes["INSUFFICIENT_SCOPE","PUBLISHABLE_KEY_NOT_ALLOWED","NO_ACTIVE_BOT"]
404.content.application/problem+json.schemaProblemDetails
404.description"Sequence not found in the authenticated tenant."
404.x-error-codes["NOT_FOUND"]
409.content.application/problem+json.schemaProblemDetails
409.description"The same-key request is already processing, or the saved segment version/reference conflicts."
409.x-error-codes["CONFLICT"]
413.content.application/problem+json.schemaProblemDetails
413.description"The per-tool request size or item count exceeds the resource policy."
413.x-error-codes["PAYLOAD_TOO_LARGE","ITEM_COUNT_EXCEEDED"]
422.content.application/problem+json.schemaProblemDetails
422.description"Idempotency-Key was reused with different request inputs."
422.x-error-codes["IDEMPOTENCY_KEY_MISMATCH"]
429.content.application/problem+json.schemaProblemDetails
429.description"The per-tool rate limit is exceeded or unavailable; fail closed."
429.headers.Retry-After.description"Seconds before retry, when supplied by the resource policy."
429.headers.Retry-After.requiredfalse
429.headers.Retry-After.schema429.headers.Retry-After.schema
429.x-error-codes["RATE_LIMIT_EXCEEDED","RATE_LIMIT_UNAVAILABLE"]
500.content.application/problem+json.schemaProblemDetails
500.description"Unexpected failure; the private cause is withheld."
500.x-error-codes["INTERNAL_ERROR"]

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

ПолеЗначение
description"The JSON body requires expectedVersion. Wrong version or a broadcast reference returns409; a missing tenant sequence returns404. Idempotency-Key is optional on DELETE; a supplied key replays the completed result, while a new unkeyed request after deletion is404."
operationId"deleteSavedSegment"
summary"Delete an unreferenced saved filter with optimistic version"
tags["segments"]
x-idempotency.mismatchStatus422
x-idempotency.requiredfalse
x-idempotency.ttlSeconds86400
x-pagination.kind"none"