Edit a draft or scheduled post

Replaces an editable post. Drafts remain drafts with saveAsDraft=true, publish immediately with publishNow=true, or become scheduled with scheduledFor. Scheduled posts keep their schedule.

PUT/v1/posts/{postId}

Authorization

accessKey

x-access-key<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

content*string

Post text body

mediaItems?array<>

Media attachments (images, videos, GIFs)

platforms*array<|||||||||>

Target platform accounts. Drafts may be saved without an account.

publishNow?boolean

Publish immediately. scheduledFor takes precedence when provided.

saveAsDraft?boolean

Save without publishing or scheduling. Cannot be combined with publishNow=true or scheduledFor.

scheduledFor?string

ISO 8601 datetime to schedule the post for future publishing

Formatdate-time

timezone?string

IANA timezone for the scheduled time (e.g. America/New_York). Defaults to UTC.

idempotencyKey?string

Optional unique key to safely retry this request. If a post was already created with the same key for this project, the original result is returned instead of creating or publishing a duplicate. Scoped per project; reuse a fresh key for each distinct post.

Length1 <= length <= 255

Response Body

`application/json`

curl -X PUT "https://example.com/v1/posts/string" \  -H "Content-Type: application/json" \  -d '{    "content": "string",    "platforms": [      {        "platform": "twitter",        "accountId": "string"      }    ]  }'

{
  "success": true,
  "status": "draft",
  "scheduledFor": "2019-08-24T14:15:22Z",
  "postId": "string",
  "platforms": [
    {
      "platform": "twitter",
      "success": true,
      "platformPostUrl": "string",
      "error": "string",
      "warningMessage": "string"
    }
  ]
}

{
  "success": true,
  "status": "draft",
  "scheduledFor": "2019-08-24T14:15:22Z",
  "postId": "string",
  "platforms": [
    {
      "platform": "twitter",
      "success": true,
      "platformPostUrl": "string",
      "error": "string",
      "warningMessage": "string"
    }
  ]
}

{
  "success": true,
  "message": "string"
}

{
  "success": true,
  "message": "string"
}

{
  "success": true,
  "message": "string"
}

{
  "success": true,
  "message": "string"
}

{
  "success": true,
  "message": "string"
}

{
  "success": true,
  "message": "string"
}

Edit a draft or scheduled post

Authorization

Path Parameters

Request Body

Response Body

200application/json

202application/json

400application/json

402application/json

403application/json

404application/json

409application/json

503application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`