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

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

createSavedSegment

Обновлено

POST /api/v1/tools/segments/saved

Create a saved audience filter

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

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.requiredtrue
0.schema0.schema

Тело запроса

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

Ответы

ПолеЗначение
201.content.application/json.schemaSavedSegment
201.description"Created saved segment."
201.headers.X-Bot-Username.schema201.headers.X-Bot-Username.schema
201.headers.X-Client-Slug.schema201.headers.X-Client-Slug.schema
201.headers.X-RateLimit-Limit.schema201.headers.X-RateLimit-Limit.schema
201.headers.X-RateLimit-Remaining.schema201.headers.X-RateLimit-Remaining.schema
201.headers.X-RateLimit-Reset.schema201.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Strict body validation failed or POST body lacks Idempotency-Key."
400.x-error-codes["VALIDATION_ERROR","IDEMPOTENCY_KEY_REQUIRED"]
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"]
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"title is trimmed, nonempty and at most120 characters. filter uses the canonical SegmentFilter semantic validators. Creates a new tenant sequence with version1; no send or spend."
operationId"createSavedSegment"
summary"Create a saved audience filter"
tags["segments"]
x-idempotency.mismatchStatus422
x-idempotency.requiredtrue
x-idempotency.ttlSeconds86400
x-pagination.kind"none"