PATCH
/
post
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 have 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 can not be updated. You will need to delete the post and repost.

Header Parameters

Authorization
string
required
Format: Authorization: Bearer API_KEY. See API overview for more information.
Profile-Key
string
Profile Key of a user profile.

Request Body

id
string
required

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

approved
boolean

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

disableComments
boolean

Enable or disable comments on a posts. Only Instagram and LinkedIn supported.

Disabling LinkedIn comments will delete all existing comments on the thread. Instagram comments will not be deleted. TikTok comments can not 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

Pause or unpause a scheduled post. If a post us 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.

For example: