Update a post

PUT

/posts/{postId}

Modifies the content, media, or scheduling settings of an existing post

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.postly.ai/v2/posts/683594f9d6bb51f6b3000000' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY;' \
--data-raw '{
    "text": "string",
    "timezone": "string",
    "media": [
        {
            "url": "string",
            "type": "string"
        }
    ],
    "target_platforms": [
        {
            "identifier": "string",
            "id": "string"
        }
    ],
    "workspace": "string",
    "one_off_schedule": {
        "one_off_date": "string",
        "time": "string",
        "timezone": "string"
    },
    "recurring_schedule": {
        "expression": "string",
        "start_date": "string",
        "end_date": "string",
        "time": "string",
        "timezone": "string",
        "week_days": [
            {
                "num": "string",
                "value": true
            }
        ],
        "day_of_month": 0,
        "rate_value": 0,
        "rate_unit": "string"
    },
    "platform_posts": [
        {
            "identifier": "string",
            "text_override": "string",
            "media_override": [
                {
                    "url": "string",
                    "type": "string"
                }
            ],
            "settings": {
                "identifier": "string",
                "tags": [
                    "string"
                ],
                "language_tags": "string",
                "one_off_schedule": {
                    "one_off_date": "string",
                    "time": "string",
                    "timezone": "string"
                },
                "recurring_schedule": {
                    "expression": "string",
                    "start_date": "string",
                    "end_date": "string",
                    "time": "string",
                    "timezone": "string",
                    "week_days": [
                        {
                            "num": "string",
                            "value": true
                        }
                    ],
                    "day_of_month": 0,
                    "rate_value": 0,
                    "rate_unit": "string"
                }
            }
        }
    ]
}'

Response Example

200 - Example 1

{
    "code": "string",
    "message": "string"
}

Request

Authorization

API Key

Add parameter in header

X-API-KEY

Example:

X-API-KEY: ********************

Path Params

postId

string

required

24-character hexadecimal identifier of the post to edit

Example:

683594f9d6bb51f6b3000000

Body Params application/json

text

string

optional

Optional text content of the post

timezone

string

required

Optional timezone for scheduling the post, in IANA format (e.g., "Africa/Lagos")

media

array [object {2}]

optional

Optional media items to include in the post

url

string

required

Public URL of the uploaded file

type

string

required

MIME type of the media (e.g., image/png, video/mp4)

target_platforms

array[object (PostTargetPlatform) {2}]

required

List of platforms where the post will be published

identifier

string

required

Unique name of the platform (e.g., facebook)

string

required

For platforms with pages (e.g., Facebook, LinkedIn, YouTube), this is the page ID.
For platforms without pages (e.g., TikTok, Bluesky, X/Twitter), this is the account ID.

workspace

string

required

24-character hexadecimal workspace identifier

one_off_schedule

object (OneOffSchedule)

optional

Optional one-off schedule for the post

one_off_date

string

required

Date for a one-time post as a valid ISO 8601 date-time string

time

string

required

Time of day for the scheduled post, as a valid ISO 8601 date-time string

timezone

string

optional

Timezone for interpreting dates and times (default "UTC")

recurring_schedule

object (RecurringSchedule)

optional

Optional recurring schedule for the post

expression

string

required

Cron or rate expression defining the schedule. E.g "cron(0 9 * * ? *)" # Every day at 09:00 UTC

start_date

string

required

Start date for the recurring schedule

end_date

string

optional

End date of the recurring schedule

time

string

required

Time of day for the scheduled post, as a valid ISO 8601 date-time string

timezone

string

optional

Timezone for interpreting dates and times (default "UTC")

week_days

array[object (WeekDayMapping) {2}]

optional

Optional Map of weekdays (0=Sunday to 6=Saturday) to include in recurring schedules

day_of_month

integer

optional

Day of month for monthly schedules

rate_value

integer

optional

Value for rate-based schedules

rate_unit

string

optional

Unit for rate-based schedules

platform_posts

array[object (PlatformPost) {4}]

optional

Optional platform specific posts to override original content

identifier

string

required

Platform identifier for this post

text_override

string

optional

Optional text to override the original content for this platform

media_override

array[object (FileData) {2}]

optional

Optional media list to override the original media for this platform

settings

optional

Base settings for platform-specific post scheduling and metadata. E.g specify bluesky specific settings like language, labels

Examples

Responses

🟢200Success

application/json

Body

code

string

required

200

message

string

required

Post update successful

🟠400BadRequestResponse

🟠401UnAuthorizedResponse

Modified at 2025-05-30 16:28:22

Create a post

Fetch a post