← Tools Reference

Ayrshare

Ayrshare integration (Social, Marketing). Imported from open-connector.

API key11 toolshttps://api.ayrshare.com/api
GET
ayrshare_get_user_profile
Get Ayrshare account or user profile details, including linked social accounts and usage metadata.

/user

1 parameter
ParamTypeRequiredDescription
instagramDetailsbooleanoptionalWhether Ayrshare should include slower additional Instagram details.
GET
ayrshare_list_post_history
List Ayrshare post history with optional filters for date range, status, type, and social platforms.

/history

8 parameters
ParamTypeRequiredDescription
limitintegeroptionalThe maximum number of history records to return.
platformsarrayoptionalThe social platforms to include in the history filter.
startDatestringoptionalThe inclusive ISO 8601 start date for history results.
endDatestringoptionalThe inclusive ISO 8601 end date for history results.
lastDaysintegeroptionalThe number of previous days to include, or 0 for all history.
statusstringoptionalThe Ayrshare post status to filter by.
typestringoptionalWhether to return immediate or scheduled posts.
autoRepostIdstringoptionalThe auto repost ID to filter by, or all for every auto repost.
POST
ayrshare_publish_post
Publish or schedule a social media post through Ayrshare using a JSON-friendly first-pass field set.

/post

8 parameters
ParamTypeRequiredDescription
poststringrequiredThe post text to send to the selected social platforms.
platformsarrayrequiredThe social platforms to publish to, or all to publish to every linked platform.
mediaUrlsarrayoptionalHTTPS image or video URLs to include in the post.
isVideobooleanoptionalWhether the media URLs should be treated as video media.
scheduleDatestringoptionalThe UTC ISO 8601 datetime when Ayrshare should publish the post.
validateScheduledbooleanoptionalWhether Ayrshare should validate a scheduled post before accepting it.
idempotencyKeystringoptionalA unique idempotency key used to reject duplicate post submissions.
notesstringoptionalInternal notes stored with the post and retrievable from history.
GET
ayrshare_get_post
Get one Ayrshare post by top-level Ayrshare post ID, including status and per-platform results.

/post/{id}

1 parameter
ParamTypeRequiredDescription
idstringrequiredThe top-level Ayrshare post ID returned by publish_post.
DELETE
ayrshare_delete_post
Delete one or more Ayrshare posts, delete all pending scheduled posts, or mark a post as manually deleted.

/post

4 parameters
ParamTypeRequiredDescription
idstringoptionalThe top-level Ayrshare post ID returned by publish_post.
bulkarrayoptionalAyrshare post IDs to bulk delete.
deleteAllScheduledbooleanoptionalWhether to delete all pending scheduled posts for the profile.
markManualDeletedbooleanoptionalWhether to mark the Ayrshare post as deleted without deleting it from the socia…
PATCH
ayrshare_update_post
Update mutable Ayrshare post metadata such as scheduleDate, approval status, notes, pause state, comments, or YouTube visibility.

/post

7 parameters
ParamTypeRequiredDescription
idstringrequiredThe top-level Ayrshare post ID returned by publish_post.
approvedbooleanoptionalWhether to approve a post awaiting approval.
disableCommentsbooleanoptionalWhether to disable comments on supported social platforms.
notesstringoptionalReference notes stored with the Ayrshare post.
scheduleDatestringoptionalThe UTC datetime when Ayrshare should publish the scheduled post.
scheduledPausebooleanoptionalWhether to pause or unpause a scheduled Ayrshare post.
youTubeOptionsobjectoptionalYouTube metadata to update on a posted video.
PUT
ayrshare_retry_post
Retry an Ayrshare post whose previous publish attempt failed, returning the new pending post status.

/post/retry

1 parameter
ParamTypeRequiredDescription
idstringoptionalThe top-level Ayrshare post ID returned by publish_post.
POST
ayrshare_check_post_length
Check weighted social post length and platform validity using Ayrshare's post length validator.

/post/checkPostWeight

1 parameter
ParamTypeRequiredDescription
poststringoptionalThe post text to measure.
POST
ayrshare_validate_post
Validate an Ayrshare post payload before publishing, including platform and media URL checks.

/validate/post

4 parameters
ParamTypeRequiredDescription
poststringrequiredThe post text to validate.
platformsarrayrequiredThe social platforms to validate the post against.
mediaUrlsarrayoptionalHTTPS image or video URLs to validate with the post.
isVideobooleanoptionalWhether the media URLs should be treated as video media.
POST
ayrshare_verify_media_url
Verify that a media URL exists and is accessible to Ayrshare.

/media/urlExists

1 parameter
ParamTypeRequiredDescription
mediaUrlstringoptionalThe media URL Ayrshare should verify.
POST
ayrshare_get_post_analytics
Get real-time analytics for an Ayrshare post, optionally limited to selected social platforms.

/analytics/post

2 parameters
ParamTypeRequiredDescription
idstringrequiredThe top-level Ayrshare post ID returned by publish_post.
platformsarrayoptionalOptional social platforms to include in the Ayrshare request.