Skip to main content
POST
Accept Content Agent slot

Authorizations

X-API-Key
string
header
required

API key for authentication. Get yours from the Promptwatch dashboard under Settings > API Keys.

Path Parameters

id
string<uuid>
required

Content schedule slot id.

Body

application/json
pastDueAction
enum<string>

Required when the slot's publishAt is already in the past (unless publishTiming is IMMEDIATE_ON_APPROVAL). publish_now publishes immediately; reschedule moves to the next valid window.

Available options:
publish_now,
reschedule

Response

Default Response

id
string<uuid>
required

Resource identifier

status
enum<string>
required

Slot lifecycle status.

Available options:
PLANNED,
GENERATING,
REVIEW,
APPROVED,
SCHEDULED,
PUBLISHED,
DEFERRED,
SUPPRESSED,
FAILED
generateBy
string<date-time>
required

When generation is due.

publishAt
string<date-time>
required

Scheduled publish time.

priorityScore
number | null
required
prioritizationReason
string | null
required
scheduledAtReason
string | null
required
documentConfiguration
object
required

Per-slot content options applied when the piece is generated.

documentId
string<uuid> | null
required
documentTitle
string | null
required
contentType
enum<string> | null
required
Available options:
ARTICLE,
BLOG_POST,
OPINION,
LISTICLE,
HOW_TO,
REVIEW,
COMPARISON,
CASE_STUDY,
INTERVIEW,
DOCUMENTATION,
WIKI,
PRODUCT_PAGE,
LANDING_PAGE,
PRESS_RELEASE,
GENERIC_CONTENT,
PRODUCT_COMPARISON
contentLength
enum<string> | null
required
Available options:
SHORT,
MEDIUM,
LONG
toneOfVoice
enum<string> | null
required
Available options:
PROFESSIONAL,
CASUAL,
TECHNICAL,
CONVERSATIONAL,
NEUTRAL,
AUTHORITATIVE,
FRIENDLY,
PERSUASIVE
personaId
string<uuid> | null
required
personaName
string | null
required
title
string
required

Display title for the scheduled piece.

publishAttempts
integer
required
failureReason
string | null
required
autoApproved
boolean
required
publishSource
enum<string> | null
required
Available options:
AUTOMATIC,
MANUAL
publishedAt
string<date-time> | null
required

Timestamp (ISO 8601)

publishedByName
string | null
required
source
string
required

Backlog source label (content gap, prompt, etc.).

recommendationTitle
string | null
required
contentGapId
string<uuid> | null
required
promptId
string<uuid> | null
required
publishState
enum<string> | null
required
Available options:
LIVE,
DRAFT
cmsProvider
string | null
required
liveUrl
string | null
required
viewUrl
string | null
required

Best available link (live, draft, or CMS editor).

viewUrlKind
enum<string> | null
required
Available options:
live,
draft,
cmsEditor
content
string
required

Markdown draft body; empty until generated.

description
string | null
required
declineReason
string | null
required
recommendationDetails
string | null
required
recommendationImpact
string | null
required
recommendationEffort
string | null
required