Update a post

Updates an editable post. Every body field is optional; omitted fields keep their current values, and omitting all timing fields keeps the current scheduling and draft status. At most one of publishNow, scheduledFor, isDraft, or queuedFromProfile may select a new timing mode.

Authorization

bearerAuth

AuthorizationBearer <token>

PostZen API key.

In: header

Path Parameters

postId*string

PostZen post id.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Provide exactly one creation mode: publishNow, scheduledFor, isDraft, or queuedFromProfile. platforms is required unless isDraft is true.

title?string

Internal post title. YouTube uses this as the fallback video title when settings.title is omitted.

content?string

Shared post text. Platform-specific validation still applies.

mediaItems?array<>

Duplicate URLs are removed before the post is created.

platforms?array<>

scheduledFor?string

ISO 8601 date for scheduled posts. Must be at least 60 seconds in the future.

publishNow?boolean

Publish synchronously where possible.

isDraft?boolean

Create a draft. platforms is optional for drafts.

queuedFromProfile?string

Profile id whose queue places the post. PostZen assigns the next free slot and returns it as scheduledFor. Do not call GET /v1/queue/next-slot and pass the result as scheduledFor: the slot is only claimed by the create call itself, so a fetched slot can be taken by another request before yours arrives, and the post would be scheduled outside the queue.

queueId?string

Specific queue on queuedFromProfile. Defaults to that profile's default queue. Requires queuedFromProfile.

timezone?string

Ignored in queue mode; queued posts take the queue's timezone.

tags?array<string>

Response Body

`application/json`

curl -X PUT "https://example.com/v1/posts/string" \  -H "Content-Type: application/json" \  -d '{}'

{  "post": {    "_id": "string",    "title": "string",    "content": "string",    "status": "string",    "scheduledFor": "2019-08-24T14:15:22Z",    "queueId": "string",    "timezone": "string",    "platforms": [      {        "platform": "twitter",        "accountId": {          "_id": "string",          "platform": "twitter",          "username": "string",          "displayName": "string",          "isActive": true        },        "status": "draft",        "platformPostUrl": "http://example.com",        "error": "string"      }    ]  },  "message": "string"}

{  "error": "JSON body is required"}

{  "error": "Unauthorized"}

{  "error": "The Free plan includes 2 connected accounts. Upgrade your plan to connect more.",  "code": "paymentRequired",  "reason": "freeTierExceeded",  "documentationUrl": "https://docs.postzen.dev/api-reference/connect/create-connect-url",  "dashboardUrl": "https://app.postzen.dev/settings?tab=billing",  "details": {    "planId": "free",    "includedAccounts": 2,    "freeTierAccountLimit": 2,    "currentAccountCount": 2,    "hasPaymentMethod": false  }}

{  "error": "API key requires read_write permission"}

{  "error": "Not found"}

{  "error": "Post publishing is in progress. Retry after it completes.",  "type": "invalid_request_error",  "code": "post_publish_in_progress",  "param": null}

{  "error": "rate_limited",  "retryAfter": 30}

Authorization

Path Parameters

Request Body

Response Body

200application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

429application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`