Posts

Edit a draft

Changes a draft. Only what you send changes; null clears a field; destinations replaces the whole list. Posts that are scheduled or out already can't be edited here.

patch/posts/{id}

Request

  • Base URL: https://api.deploy.social/v1
  • URL: https://api.deploy.social/v1/posts/{id}
  • Auth: HTTP bearer

Path parameters

idstring required

Starts with post_.

Request body

media_idstring

Video posts only.

captionstring nullable

The caption every destination uses unless it has its own. null leaves it empty.

titlestring nullable

YouTube's title. null clears it. Video only.

descriptionstring nullable

YouTube's description. null clears it. Video only.

tagsstring[] nullable

Tags, without the #. YouTube only.

first_commentstring nullable

Posted as the first comment where the platform takes one. null clears it. Video only.

notify_emailboolean

Email the workspace when the post has gone out.

Example request

{
  "caption": "New caption.",
  "title": null
}

Response

The draft, as it is now.

idstring required

The post's id. Starts with post_.

statusstring required

draft, scheduled, publishing, published, partially_published, failed or cancelled. New values may be added.

kindstring required

video, photos or text. New values may be added.

media_idstring nullable required

The video's id. Starts with media_.

captionstring required
titlestring nullable required
descriptionstring nullable required
tagsstring[] nullable required
first_commentstring nullable required
scheduled_atstring date-time nullable required

When it's set to go out.

notify_emailboolean required
created_viastring required

Where it was made: app (the web app), mobile (the phone app), api or mcp.

created_atstring date-time required

When it was created.

updated_atstring date-time required

When it last changed.

review_urlstring

Drafts only: opens the draft in Deploy, to check it over and post it from there.

Example response

{
  "id": "post_cmf3k2x9a0001ab12cd34ef56",
  "status": "scheduled",
  "kind": "video",
  "media_id": "media_cmf3k0m2b0000ab12cd34ef56",
  "media": [
    {
      "media_id": "media_cmf3k0m2b0000ab12cd34ef56"
    }
  ],
  "caption": "A quick look around the studio.",
  "scheduled_at": "2026-10-01T15:00:00.000Z",
  "created_via": "api",
  "created_at": "2026-10-01T15:00:00.000Z",
  "updated_at": "2026-10-01T15:00:00.000Z",
  "destinations": [
    {
      "destination_id": "dest_cmf3k1q7z0000ab12cd34ef56",
      "platform": "youtube",
      "handle": "northsidestudio",
      "options": {
        "privacy": "public"
      },
      "status": "published",
      "progress": {
        "phase": "uploading",
        "percent": 40
      },
      "published_at": "2026-10-01T15:00:00.000Z"
    }
  ],
  "issues": [
    {
      "path": "destinations[1].options.privacy",
      "code": "required",
      "message": "TikTok needs you to choose who can watch."
    }
  ]
}

Changes

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