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

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

setSitePageNudge

Обновлено

PUT /api/v1/tools/site/pages/{seqNum}/nudge

Replace the nudge setting of one site page

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

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

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

ПолеЗначение
0.description"Tenant, credential and handler-bound byte-shape replay key"
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.schemaSiteNudgeSettingsRequest
requiredtrue

Ответы

ПолеЗначение
200.content.application/json.schemaSiteNudgeSettings
200.description"Tenant site control-plane result"
200.headers.X-Bot-Username.description"Active bot username, when resolved"
200.headers.X-Bot-Username.schema200.headers.X-Bot-Username.schema
200.headers.X-Client-Slug.description"Active tenant slug, when resolved"
200.headers.X-Client-Slug.schema200.headers.X-Client-Slug.schema
200.headers.X-RateLimit-Limit.description"Effective request budget"
200.headers.X-RateLimit-Limit.schema200.headers.X-RateLimit-Limit.schema
200.headers.X-RateLimit-Remaining.description"Remaining request budget"
200.headers.X-RateLimit-Remaining.schema200.headers.X-RateLimit-Remaining.schema
200.headers.X-RateLimit-Reset.description"Unix window reset in seconds"
200.headers.X-RateLimit-Reset.schema200.headers.X-RateLimit-Reset.schema

Ошибки

ПолеЗначение
400.content.application/problem+json.schemaProblemDetails
400.description"Invalid strict body or page seq_num"
400.x-error-codes["VALIDATION_ERROR"]
401.content.application/problem+json.schemaProblemDetails
401.description"Missing, invalid, revoked or conflicting credential; surface JWT is refused"
401.x-error-codes["INVALID_API_KEY"]
403.content.application/problem+json.schemaProblemDetails
403.description"Missing scope, prohibited publishable credential or absent active bot"
403.x-error-codes["INSUFFICIENT_SCOPE","PUBLISHABLE_KEY_NOT_ALLOWED","NO_ACTIVE_BOT"]
409.content.application/problem+json.schemaProblemDetails
409.description"Typed domain conflict or request in flight"
409.x-error-codes["CONFLICT"]
413.content.application/problem+json.schemaProblemDetails
413.description"Resource policy size or item-count limit exceeded"
413.x-error-codes["PAYLOAD_TOO_LARGE","ITEM_COUNT_EXCEEDED"]
422.content.application/problem+json.schemaProblemDetails
422.description"Replay key reused for different input; the page is not published or is hidden; delayMinutes outside 5..10080; no such chain step; a goal link code of no link of the business; AI enabled on a plan without the AI Manager; AI enabled without an aiPrompt"
422.x-error-codes["IDEMPOTENCY_KEY_MISMATCH","SITE_NUDGE_PAGE_NOT_ELIGIBLE","SITE_NUDGE_DELAY_OUT_OF_RANGE","SITE_NUDGE_STEP_NOT_FOUND","SITE_NUDGE_GOAL_LINK_NOT_FOUND","SITE_NUDGE_AI_NOT_ON_PLAN","SITE_NUDGE_AI_PROMPT_REQUIRED"]
429.content.application/problem+json.schemaProblemDetails
429.description"Resource rate budget exceeded or unavailable"
429.headers.Retry-After.description"Retry delay in seconds, when supplied by the limiter"
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 internal failure"
500.x-error-codes["INTERNAL_ERROR"]

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

ПолеЗначение
description"Owner-only site:write. The whole setting, not a patch: all six body fields are required. delayMinutes is 5 to 10080 (seven days); one wait per person at a time: reopening the page restarts the timer, another page replaces the wait only when its nudge is on with a step or AI and the person is not in its 30-day cooldown, and the same person is not nudged again on the same page for 30 days after a nudge. A running wait uses the setting as it was when it started; if the nudge is off or the page hidden or unpublished when the timer fires, the wait is cancelled (superseded, nothing sent), which is also what isEnabled false does to pending waits. A tap on a goal link set on any page of the business ends the wait. stepSeq is the tenant seq_num of a chain step or null; aiEnabled with aiPrompt (1 to 2000 characters; aiEnabled true without one is refused) runs the AI Manager after the step and needs a plan that includes it; goalLinkCodes (at most 50) are codes of links the business owns, bare or with the dl_ prefix. Refusals carry their own code and recipe. No secret approval gate. Idempotency-Key is optional for PUT."
operationId"setSitePageNudge"
summary"Replace the nudge setting of one site page"
tags["site"]
x-idempotency.conflictStatus422
x-idempotency.implementation"global-cache"
x-idempotency.replayStatus200
x-idempotency.requiredfalse
x-idempotency.scope["client","credential","controller-handler","key"]
x-idempotency.ttlSeconds86400
x-pagination.queryParameters[]
x-pagination.supportedfalse
x-scope-semantics"ALL"