Publications

Update a publication

put/publications/{id}

Request

  • Base URL: https://app.openpo.st/api/v1
  • URL: https://app.openpo.st/api/v1/publications/{id}
  • Auth: one of:
    • HTTP bearer
    • API key in cookie openpost_session

Path parameters

idstring required

Publication ID

Headers

Idempotency-Keystring

Replay key scoped to the caller, Workspace, and operation

Request body

$schemastring uri

A URL to the JSON Schema for this object.

audiencestring

Target audience

clear_scheduleboolean

Clear the saved schedule and cancel its pending publication job

content_profilestring

Content profile

creation_preset'post' | 'thread' | 'story' | 'short_video' | 'video'

Starter preset; destination renditions own their formats

expected_revisioninteger required

Revision loaded by the editor

goalstring

Publication goal

inherit_random_delayboolean

Use the Workspace random-delay setting the next time this Publication is scheduled

intent'post' | 'thread' | 'story' | 'short_video' | 'video'

Deprecated compatibility alias for creation_preset

metadataobject

Publication metadata

random_delay_minutesinteger

Replace the random schedule delay in minutes (±N)

scheduled_atstring date-time

Optional schedule time

social_set_idstring

Social Set provenance; does not replace snapshotted destinations

source_textstring

Canonical source text

source_urlstring

Source URL

titlestring

Internal publication title

Example request

{
  "$schema": "https://example.com/api/v1/schemas/PublicationUpdateBody.json"
}

Response

OK

$schemastring uri

A URL to the JSON Schema for this object.

actual_run_atstring
audiencestring
content_profilestring required
created_atstring required
created_bystring required
creation_presetstring required
creation_source'web' | 'api' | 'sdk' | 'mcp' | 'cli' | 'autopost' | 'unknown' required

Low-cardinality channel that created the Publication

failure_dismissed_atstring
goalstring
idstring required
intentstring required
metadataobject required
random_delay_inheritedboolean required
random_delay_minutesinteger required
review_epochinteger
review_idstring
review_state'pending' | 'approved' | 'changes_requested' | 'needs_review'
revisioninteger required
scheduled_atstring
social_set_idstring
source_textstring required
source_urlstring
statusstring required
titlestring required
updated_atstring required
workspace_idstring required

Example response

{
  "$schema": "https://example.com/api/v1/schemas/PublicationResponse.json"
}

Changes

No recorded changes to this operation across all 1 revision of this API.