Posts

Edit post

Updates a scheduled post. Only posts with status SCHEDULED or RESCHEDULED can be edited.

Send only the fields you want to change: all fields are optional. If scheduledAt is updated, the post is automatically rescheduled with its publish queue job updated.

Platform-specific parameters (youtubeParams, tiktokParams, pinterestParams, googleBusinessParams, xCommunityId, xTaggedUsers) must match the post's platform. Sending pinterestParams on a YouTube post will return a validation error.

patch/posts/{id}

Request

Base URL: https://api.postplanify.com/api/v1
URL: https://api.postplanify.com/api/v1/posts/{id}
Auth: HTTP bearer

Path parameters

idstring uuid required

Request body

captionstring

New post caption

scheduledAtstring date-time

New scheduled time (UTC, must be in the future)

xCommunityIdstring nullable

X community ID (X posts only)

xTaggedUsersstring nullable

Tagged users for media posts (X posts only)

shortenLinksboolean

Shorten links in the caption, thread posts and first comment with the workspace's connected Bitly account when the post is published. Ignored if the workspace has no Bitly connected (the original links are posted). See "Link shortening" under Create post.

utmCampaignstring nullable

Value for utm_campaign added to links when shortenLinks is true. utm_source (the platform) and utm_medium=social are added automatically.

Example request

{
  "caption": "Updated caption for our launch post!",
  "scheduledAt": "2026-03-20T15:00:00.000Z",
  "youtubeParams": {
    "title": "My Video Title",
    "categoryId": "22",
    "tags": "tech,tutorial,howto"
  },
  "tiktokParams": {
    "privacyLevel": "PUBLIC_TO_EVERYONE",
    "autoAddMusic": true,
    "photosPostTitle": "Check out these photos"
  },
  "pinterestParams": {
    "title": "Spring Collection 2026",
    "boardId": "board-abc123",
    "boardName": "Style Inspiration",
    "link": "https://mybrand.com/spring",
    "altText": "Spring fashion collection lookbook"
  },
  "googleBusinessParams": {
    "topicType": "STANDARD",
    "actionType": "LEARN_MORE",
    "actionUrl": "https://mybrand.com/book",
    "eventTitle": "Grand Opening Weekend",
    "startDate": "2026-04-01T09:00:00.000Z",
    "endDate": "2026-04-03T18:00:00.000Z",
    "couponCode": "SAVE20",
    "redeemOnlineUrl": "https://mybrand.com/redeem",
    "termsConditions": "Valid for new customers only. Cannot be combined with other offers."
  },
  "shortenLinks": true,
  "utmCampaign": "black_friday"
}

Response

Post updated

okboolean

Example response

{
  "ok": true,
  "data": {
    "id": "a004b44d-2e69-4236-873a-081dc0d159a7",
    "workspaceId": "d35f525f-63e6-40ae-8946-8c120edb0225",
    "caption": "Check out our latest product launch! 🚀",
    "socialPlatformPostId": "17890523456789",
    "scheduledAt": "2026-03-01T12:00:00.000Z",
    "createdAt": "2026-02-19T10:30:00.000Z",
    "updatedAt": "2026-02-19T10:30:00.000Z",
    "socialAccount": {
      "id": "c47eb231-8eb2-4600-ac24-6951c7b5e3ce",
      "accountName": "mybrand",
      "accountUrl": "https://instagram.com/mybrand",
      "profilePictureUrl": "https://scontent.cdninstagram.com/profile.jpg",
      "customLabel": "Downtown"
    },
    "medias": [
      {
        "id": "f8a2c3d4-5e6f-7a8b-9c0d-1e2f3a4b5c6d",
        "name": "product-launch.jpg",
        "url": "https://cdn.postplanify.com/posts/all-types/product-launch.jpg",
        "type": "IMAGE_JPEG",
        "size": 245000,
        "width": 1080,
        "height": 1080
      }
    ],
    "logs": [
      {
        "type": "SUCCESS",
        "message": "Post created successfully",
        "createdAt": "2026-02-19T10:30:00.000Z"
      }
    ],
    "label": {
      "name": "Education",
      "color": "#3b82f6"
    },
    "metrics": {
      "views": 1842,
      "likes": 96,
      "comments": 12,
      "shares": 7,
      "engagementRate": 0.061,
      "platformMetrics": {
        "bookmarks": 14,
        "quotes": 3
      },
      "measuredAt": "2026-09-04"
    }
  }
}

Changes

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