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

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

createMarketingCampaign

Обновлено

POST /api/v1/tools/marketing

createMarketingCampaign

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

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

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

ПолеЗначение
0.in"header"
0.name"Idempotency-Key"
0.requiredtrue
0.schema0.schema

Тело запроса

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

Ответы

ПолеЗначение
201.content.application/json.schemaMarketingCampaignResponse
201.description"Actual control-plane projection; QR signatures expire after 900 seconds"
201.headers.X-Bot-Username.description"Public active bot handle, when configured"
201.headers.X-Bot-Username.schema201.headers.X-Bot-Username.schema
201.headers.X-Client-Slug.description"Authenticated active tenant slug"
201.headers.X-Client-Slug.schema201.headers.X-Client-Slug.schema
201.headers.X-RateLimit-Limit.description"Effective requests-per-minute 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"Reset as Unix seconds"
201.headers.X-RateLimit-Reset.schema201.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"VALIDATION_ERROR or missing POST IDEMPOTENCY_KEY_REQUIRED"
400.headers.X-Bot-Username.description"Public active bot handle, when configured"
400.headers.X-Bot-Username.schema400.headers.X-Bot-Username.schema
400.headers.X-Client-Slug.description"Authenticated active tenant slug"
400.headers.X-Client-Slug.schema400.headers.X-Client-Slug.schema
400.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
400.headers.X-RateLimit-Limit.schema400.headers.X-RateLimit-Limit.schema
400.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
400.headers.X-RateLimit-Remaining.schema400.headers.X-RateLimit-Remaining.schema
400.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
400.headers.X-RateLimit-Reset.schema400.headers.X-RateLimit-Reset.schema
401.content.application/problem+json.schemaProblemDetails
401.description"INVALID_API_KEY: absent, invalid, revoked or conflicting key headers; session JWT refused"
401.headers.X-Bot-Username.description"Public active bot handle, when configured"
401.headers.X-Bot-Username.schema401.headers.X-Bot-Username.schema
401.headers.X-Client-Slug.description"Authenticated active tenant slug"
401.headers.X-Client-Slug.schema401.headers.X-Client-Slug.schema
401.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
401.headers.X-RateLimit-Limit.schema401.headers.X-RateLimit-Limit.schema
401.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
401.headers.X-RateLimit-Remaining.schema401.headers.X-RateLimit-Remaining.schema
401.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
401.headers.X-RateLimit-Reset.schema401.headers.X-RateLimit-Reset.schema
403.content.application/problem+json.schemaProblemDetails
403.description"INSUFFICIENT_SCOPE or resource/plan refusal"
403.headers.X-Bot-Username.description"Public active bot handle, when configured"
403.headers.X-Bot-Username.schema403.headers.X-Bot-Username.schema
403.headers.X-Client-Slug.description"Authenticated active tenant slug"
403.headers.X-Client-Slug.schema403.headers.X-Client-Slug.schema
403.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
403.headers.X-RateLimit-Limit.schema403.headers.X-RateLimit-Limit.schema
403.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
403.headers.X-RateLimit-Remaining.schema403.headers.X-RateLimit-Remaining.schema
403.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
403.headers.X-RateLimit-Reset.schema403.headers.X-RateLimit-Reset.schema
404.content.application/problem+json.schemaProblemDetails
404.description"NOT_FOUND for a missing or foreign tenant sequence"
404.headers.X-Bot-Username.description"Public active bot handle, when configured"
404.headers.X-Bot-Username.schema404.headers.X-Bot-Username.schema
404.headers.X-Client-Slug.description"Authenticated active tenant slug"
404.headers.X-Client-Slug.schema404.headers.X-Client-Slug.schema
404.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
404.headers.X-RateLimit-Limit.schema404.headers.X-RateLimit-Limit.schema
404.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
404.headers.X-RateLimit-Remaining.schema404.headers.X-RateLimit-Remaining.schema
404.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
404.headers.X-RateLimit-Reset.schema404.headers.X-RateLimit-Reset.schema
409.content.application/problem+json.schemaProblemDetails
409.description"CONFLICT for duplicate identity or in-flight idempotent command"
409.headers.X-Bot-Username.description"Public active bot handle, when configured"
409.headers.X-Bot-Username.schema409.headers.X-Bot-Username.schema
409.headers.X-Client-Slug.description"Authenticated active tenant slug"
409.headers.X-Client-Slug.schema409.headers.X-Client-Slug.schema
409.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
409.headers.X-RateLimit-Limit.schema409.headers.X-RateLimit-Limit.schema
409.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
409.headers.X-RateLimit-Remaining.schema409.headers.X-RateLimit-Remaining.schema
409.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
409.headers.X-RateLimit-Reset.schema409.headers.X-RateLimit-Reset.schema
413.content.application/problem+json.schemaProblemDetails
413.description"PAYLOAD_TOO_LARGE or ITEM_COUNT_EXCEEDED"
413.headers.X-Bot-Username.description"Public active bot handle, when configured"
413.headers.X-Bot-Username.schema413.headers.X-Bot-Username.schema
413.headers.X-Client-Slug.description"Authenticated active tenant slug"
413.headers.X-Client-Slug.schema413.headers.X-Client-Slug.schema
413.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
413.headers.X-RateLimit-Limit.schema413.headers.X-RateLimit-Limit.schema
413.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
413.headers.X-RateLimit-Remaining.schema413.headers.X-RateLimit-Remaining.schema
413.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
413.headers.X-RateLimit-Reset.schema413.headers.X-RateLimit-Reset.schema
422.content.application/problem+json.schemaProblemDetails
422.description"VALIDATION_ERROR for marketing domain input refusal or IDEMPOTENCY_KEY_MISMATCH for divergent retries"
422.headers.X-Bot-Username.description"Public active bot handle, when configured"
422.headers.X-Bot-Username.schema422.headers.X-Bot-Username.schema
422.headers.X-Client-Slug.description"Authenticated active tenant slug"
422.headers.X-Client-Slug.schema422.headers.X-Client-Slug.schema
422.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
422.headers.X-RateLimit-Limit.schema422.headers.X-RateLimit-Limit.schema
422.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
422.headers.X-RateLimit-Remaining.schema422.headers.X-RateLimit-Remaining.schema
422.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
422.headers.X-RateLimit-Reset.schema422.headers.X-RateLimit-Reset.schema
429.content.application/problem+json.schemaProblemDetails
429.description"RATE_LIMIT_EXCEEDED or RATE_LIMIT_UNAVAILABLE"
429.headers.Retry-After.description"Retry delay in seconds, when supplied by limiter"
429.headers.Retry-After.schema429.headers.Retry-After.schema
429.headers.X-Bot-Username.description"Public active bot handle, when configured"
429.headers.X-Bot-Username.schema429.headers.X-Bot-Username.schema
429.headers.X-Client-Slug.description"Authenticated active tenant slug"
429.headers.X-Client-Slug.schema429.headers.X-Client-Slug.schema
429.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
429.headers.X-RateLimit-Limit.schema429.headers.X-RateLimit-Limit.schema
429.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
429.headers.X-RateLimit-Remaining.schema429.headers.X-RateLimit-Remaining.schema
429.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
429.headers.X-RateLimit-Reset.schema429.headers.X-RateLimit-Reset.schema
500.content.application/problem+json.schemaProblemDetails
500.description"INTERNAL_ERROR without private implementation detail"
500.headers.X-Bot-Username.description"Public active bot handle, when configured"
500.headers.X-Bot-Username.schema500.headers.X-Bot-Username.schema
500.headers.X-Client-Slug.description"Authenticated active tenant slug"
500.headers.X-Client-Slug.schema500.headers.X-Client-Slug.schema
500.headers.X-RateLimit-Limit.description"Effective requests-per-minute budget"
500.headers.X-RateLimit-Limit.schema500.headers.X-RateLimit-Limit.schema
500.headers.X-RateLimit-Remaining.description"Remaining budget or unknown"
500.headers.X-RateLimit-Remaining.schema500.headers.X-RateLimit-Remaining.schema
500.headers.X-RateLimit-Reset.description"Reset as Unix seconds"
500.headers.X-RateLimit-Reset.schema500.headers.X-RateLimit-Reset.schema

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

ПолеЗначение
description"Authenticate with X-Api-Key or Authorization: Bearer tgf_* (API-key transport; owner session JWT is refused). Every declared scope is required. Sequences resolve under the authenticated tenant; public QR links use an opaque UniversalLink code."
operationId"createMarketingCampaign"
tags["marketing"]
x-idempotency.mismatchStatus422
x-idempotency.requiredtrue
x-idempotency.ttlSeconds86400
x-paginationnull