Update a Post

Update a scheduled post’s metadata

Available on Premium, Business, Enterprise plans.

Update the scheduleDate of a post, approval status of a post, notes, or visibility of a posted YouTube video.

• The post must originally have a scheduleDate and be in a “pending” status. The status can be checked with the /history or GET /post endpoints.

• The YouTube video must have been successfully posted to change visibility.

• The approval workflow requires the current status of the post be in “awaiting approval”.

Other parameters cannot be updated. You will need to delete the post and repost.

Header Parameters

Authorization

string

required

API Key of the Primary Profile.

Format: Authorization: Bearer API_KEY

Profile-Key

string

Profile Key of a User Profile.

Format: Profile-Key: PROFILE_KEY

Body Parameters

id

string

required

Ayrshare Post ID of the post to update. Ayrshare Post ID returned from /post.

approved

boolean

default: false

The original post requires approval and has a status of “awaiting approval”, set to true to approve and publish the post.

disableComments

boolean

default: false

Enable or disable comments on a post. Setting to true will disable comments. Setting to false will enable comments.

Supported platforms: Instagram and LinkedIn.

• Enabling or disabling can be done on either a scheduled post or a published post.
• Disabling comments on a published post will not delete existing comments.
• Disabling LinkedIn comments will delete all existing comments on the thread.
• Instagram comments will not be deleted.
• TikTok comments cannot be changed after publishing.

notes

string

Set notes on a post that can be retrieved via the /history endpoint. Notes are for reference only and do not affect the post.

scheduleDate

string

The datetime to schedule a future post. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2023-07-08T12:30:00Z.

Please see https://www.utctime.net/

If the datetime is in the past, the post will immediately be sent.

scheduledPause

boolean

default: false

Pause or unpause a scheduled post. If a post is unpaused and the scheduleDate is in the past, the post will immediately be publish. Consider updating the scheduleDate before unpausing.

youTubeOptions

object

Update the visibility of the YouTube video with the visibility field and values unlisted, private, or public.

Update the description, title, or categoryId. If no description or categoryId originally set, the default values are "" and 24 (Entertainment), respectively.