The Ayrshare connector lets your AI agent act in each user's Ayrshare account. Each user connects their own Ayrshare access token once, and Scalekit sends it with every call, so your agent never handles credentials. It comes with 58 tools.
- Tools
- 58
- What they doRead · write · destructive
- 36 · 15 · 736 read15 write7 destructive
- Users sign in with
- Access token
Setup
Install the SDK
Terminal window npm install @scalekit-sdk/node dotenvTerminal window pip install scalekit-sdk-python python-dotenvSet your credentials
Add your Scalekit credentials to your
.envfile. Find values in app.scalekit.com > Developers > API Credentials..env SCALEKIT_ENVIRONMENT_URL=<your-environment-url>SCALEKIT_CLIENT_ID=<your-client-id>SCALEKIT_CLIENT_SECRET=<your-client-secret>Create the Ayrshare connection
In AgentKit > Connections, create an Ayrshare connection. The name you give it is the
connection_nameyour code passes. See Configure connections.Authorize a user and make your first call
quickstart.mts 1import { ScalekitClient } from '@scalekit-sdk/node'2import 'dotenv/config'3import { createInterface } from 'node:readline/promises'45const scalekit = new ScalekitClient(6process.env.SCALEKIT_ENVIRONMENT_URL,7process.env.SCALEKIT_CLIENT_ID,8process.env.SCALEKIT_CLIENT_SECRET,9)10const actions = scalekit.actions1112const connector = 'ayrshare'13const identifier = 'user_123'1415// Generate an authorization link for the user16const { link } = await actions.getAuthorizationLink({ connectionName: connector, identifier })17console.log('Authorize Ayrshare:', link)18const rl = createInterface({ input: process.stdin, output: process.stdout })19await rl.question('Press Enter after authorizing...')20rl.close()2122// Make your first call23const result = await actions.executeTool({24connector,25identifier,26toolName: 'ayrshare_auto_schedule_list',27toolInput: {},28})29console.log(result)Terminal window npx tsx quickstart.mtsquickstart.py 1import os2from scalekit import ScalekitClient3from dotenv import load_dotenv4load_dotenv()56scalekit_client = ScalekitClient(7env_url=os.getenv("SCALEKIT_ENVIRONMENT_URL"),8client_id=os.getenv("SCALEKIT_CLIENT_ID"),9client_secret=os.getenv("SCALEKIT_CLIENT_SECRET"),10)11actions = scalekit_client.actions1213connection_name = "ayrshare"14identifier = "user_123"1516# Generate an authorization link for the user17link_response = actions.get_authorization_link(18connection_name=connection_name,19identifier=identifier,20)21print("Authorize Ayrshare:", link_response.link)22input("Press Enter after authorizing...")2324# Make your first call25result = actions.execute_tool(26tool_input={},27tool_name="ayrshare_auto_schedule_list",28connection_name=connection_name,29identifier=identifier,30)31print(result)Terminal window python quickstart.pyEach user opens the link once and enters their Ayrshare credentials there. See Authorize a user for the full flow and statuses.
Tools
Pass the exact name toexecute_toolayrshare_auto_schedule_listList active auto schedules.Read-onlyList Auto Schedules
List active auto schedules. Returns each schedule's title, times, days and last scheduled date. Use ayrshare_auto_schedule_set to change one.
Inputs
This tool takes no inputs.
ayrshare_auto_schedule_pending_listList auto-scheduled posts that are still pending.Read-onlyList Pending Auto-Scheduled Posts
List auto-scheduled posts that are still pending. Returns each pending post's id, text and scheduled time. Use ayrshare_post_delete to remove one.
Inputs
This tool takes no inputs.
ayrshare_comments_getGet comments on a post by Ayrshare post ID, network post ID or comment ID.Read-onlyGet Comments
Get comments on a post by Ayrshare post ID, network post ID or comment ID. Returns comments per network with id, text, author, created time and replies. Set search_platform_id or comment_id with platform when using network IDs.
Inputs
idstringrequired- Ayrshare post ID, network post ID (with search_platform_id true) or network comment ID (with comment_id true). Example: TBEAAqAMMJoweA9wKHUl.
comment_idboolean- true when id is a network comment ID. Requires search_platform_id true and platform. Example: true.
platformstring- Required if searchPlatformId or commentId is true. When to use: ; If using the Social Post ID and "searchPlatformId": true field. Supported platforms: bluesky, facebook, instagram, linkedin, reddit, threads, tiktok, twitter, youtube. ; If using the Social Comment ID and "searchPlatformId": true and "commentId": true fields. Supported platforms: facebook, instagram, l. Example: facebook.one of
blueskyfacebookinstagramlinkedinredditthreadstiktoktwitteryoutube search_platform_idboolean- If getting comments on a post published via Ayrshare and using the Ayrshare Post ID, do not include this field - it defaults to false. If getting comments using the Social Post ID or Social Comment ID, which is the ID generated by the social networks, set to true. Example: true.
ayrshare_content_moderateCheck text, and optionally an image, for harmful content categories with AI moderation.Read-onlyModerate Content
Check text, and optionally an image, for harmful content categories with AI moderation. Returns whether it was flagged and the category scores. Use before publishing user-generated content.
Inputs
textstringrequired- The text to analyze for moderation. Example: Check out our new sneakers!.
image_urlstring- The URL of the image. Must begin with https://. Example: https://img.ayrshare.com/012/gb.jpg.
ayrshare_feeds_listList the RSS feeds registered to the account.Read-onlyList RSS Feeds
List the RSS feeds registered to the account. Returns each feed's id, URL, title, autoHashtag and useFirstImage settings. Use ayrshare_feed_update or ayrshare_feed_delete with the id.
Inputs
This tool takes no inputs.
ayrshare_hashtag_banned_checkCheck whether a hashtag is banned on Instagram or other networks.Read-onlyCheck Banned Hashtag
Check whether a hashtag is banned on Instagram or other networks. Returns whether the hashtag is banned. Use before adding hashtags to a post.
Inputs
hashtagstringrequired- The hashtag to check, with or without #. Example: #bikinibody.
ayrshare_hashtags_auto_addAdd relevant AI-chosen hashtags to post text.Read-onlyAdd Hashtags to Post
Add relevant AI-chosen hashtags to post text. Returns the post text with hashtags added. Use ayrshare_hashtags_recommend for TikTok suggestions.
Inputs
poststringrequired- Post text to add the hashtags. Max length 1,000 characters. Example: Big news: our spring collection is live! Shop now at https://example.com/spring.
languagestring- Specify the language code of the language of the post to assist the hashtag algorithm. Example: en.
maxinteger- Integer of max number of Hashtags to add. Max value range 1 to 10. Note: Instagram allows a maximum of 5 hashtags per post. Example: 3.
positionstring- Where to put the hashtags: auto (inside the text where relevant) or end. Example: auto.one of
autoend
ayrshare_hashtags_recommendGet hashtag suggestions from TikTok for a keyword, with view counts.Read-onlyRecommend Hashtags
Get hashtag suggestions from TikTok for a keyword, with view counts. Returns recommended hashtags and their data. Use ayrshare_hashtags_auto_add to insert hashtags into text.
Inputs
keywordstringrequired- A single keyword; spaces are removed. Example: apple.
ayrshare_history_getGet the history record of one post by its Ayrshare post ID.Read-onlyGet Post History
Get the history record of one post by its Ayrshare post ID. Returns the post's status, platforms and per-network results. Use ayrshare_history_list to browse.
Inputs
idstringrequired- Ayrshare post ID. Example: TBEAAqAMMJoweA9wKHUl.
search_all_postsboolean- Search all posts across all User Profiles for the post ID. Default: false. Example: true.
ayrshare_history_listList posts sent through Ayrshare, newest first, filtered by date range, days, status, type, platforms or auto-repost series.Read-onlyList Post History
List posts sent through Ayrshare, newest first, filtered by date range, days, status, type, platforms or auto-repost series. Returns posts with id, text, platforms, status, schedule date and per-network post IDs and URLs. Use ayrshare_platform_history_list for posts made outside Ayrshare.
Inputs
auto_repost_idstring- When creating an auto repost an ID is assigned to track that series of posts. Retrieve posts by auto repost ID or use the value of all to get all auto reposts. Example: a1b2c3d4e5.
end_datestring- Return posts up to and including this end date. End date for the history in ISO 8601 format. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-31.
last_daysinteger- Returns the last n days of posts by the publish date, i.e. scheduleDate. Default 30 days. ; The lastDays will be ignored if startDate and endDate are provided. ; If the value is zero 0 will return the entire history of posts. ; If the value is greater than 0, it will return the last n days of posts. ; For example, lastDays=5 returns the last 5 days of posts and lastDays=0 returns all posts determined by the limit. Example: 30.
limitinteger- Returns the last *nnumber of posts. For example, if you only want the most recent post, set limit=1. Default: 25 posts. Max value: 1000. Example: 20.
start_datestring- Return posts from and including this start date. Start date for the history in ISO 8601 format. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-01.
statusstring- Filter by current status of post. Valid values: success, error, processing, pending, paused, deleted, and awaiting approval. Processing indicates the post is currently being sent. Pending indicates the post is scheduled to be posted at a future date. Deleted posts are not returned by default. They are only returned with the status query filter set to status=deleted. Example: success.one of
successerrorprocessingpendingpauseddeletedawaiting approval typestring- The type of post to retrieve, either post that were sent immediately or scheduled post using the scheduleDate field. Values: immediate or scheduled. Example: scheduled.one of
immediatescheduled
ayrshare_image_alt_text_generateGenerate alt text for an image URL with AI.Read-onlyGenerate Image Alt Text
Generate alt text for an image URL with AI. Returns the alt text. Pass it in the network options when posting images.
Inputs
urlstringrequired- Image URL of the image to create the alt text. Must start with https://. Supports JPEG, PNG, GIF, WEBP, and BMP. Example: https://img.ayrshare.com/012/gb.jpg.
keywordsarray- String array of keywords or phrases to be considered when generating the alt text. Typically only one or two of the keywords from the array will be used in the alt text. Example: ["sneakers", "sale"]
langstring- Language to output the alt text. Use one of the available language codes. Example: es.
ayrshare_link_analytics_getGet click analytics for one short link.Read-onlyGet Short Link Analytics
Get click analytics for one short link. Returns the link's URLs and click history. Use ayrshare_links_list for all links.
Inputs
idstringrequired- ID of the short link, returned by ayrshare_link_create. Example: yC0fTl.
from_click_datestring- Get history of links clicked after this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-01T00:00:00Z.
from_created_datestring- Get history of links shortened after this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-01T00:00:00Z.
to_click_datestring- Get history of links clicked before this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-31T23:59:59Z.
to_created_datestring- Get history of links shortened before this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-31T23:59:59Z.
ayrshare_links_listList analytics for every short link, optionally by creation or click date.Read-onlyList Short Links
List analytics for every short link, optionally by creation or click date. Returns each link's id, short and long URL, and click counts. Use ayrshare_link_analytics_get for one link.
Inputs
from_click_datestring- Get history of links clicked after this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-01T00:00:00Z.
from_created_datestring- Get history of links shortened after this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-01T00:00:00Z.
to_click_datestring- Get history of links clicked before this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-31T23:59:59Z.
to_created_datestring- Get history of links shortened before this date. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Example: 2026-10-31T23:59:59Z.
ayrshare_media_listList the images and videos uploaded to the account's media gallery.Read-onlyList Media
List the images and videos uploaded to the account's media gallery. Returns each file's URL, name, type and size. Use the URLs as media_urls when posting.
Inputs
This tool takes no inputs.
ayrshare_media_metadata_getGet metadata of a public media file URL, such as format, dimensions, size and duration.Read-onlyGet Media Metadata
Get metadata of a public media file URL, such as format, dimensions, size and duration. Returns the file's metadata. Use this to check a file against a network's media requirements.
Inputs
urlstringrequired- Encoded URI of the externally accessible media file URL. Example: https://img.ayrshare.com/012/gb.jpg.
ayrshare_media_url_verifyCheck that a media file URL exists and is reachable.Read-onlyVerify Media URL
Check that a media file URL exists and is reachable. Returns whether it exists and its content type. Use before posting external media.
Inputs
media_urlstringrequired- URL of the media to verify exists. Example: https://img.ayrshare.com/012/gb.jpg.
ayrshare_messages_listList direct messages or conversations on Facebook, Instagram, X or WhatsApp.Read-onlyList Direct Messages
List direct messages or conversations on Facebook, Instagram, X or WhatsApp. Returns messages with sender, recipient, text, media and time, or conversations, plus a next cursor. Use ayrshare_message_send to reply.
Inputs
platformstringrequired- The platform to get the message: facebook, instagram, twitter, whatsapp. Example: facebook.one of
facebookinstagramtwitterwhatsapp statusstringrequired- Return active conversations or archived conversations. Values: active or archived. Example: active.one of
activearchived actionstring- Only return messages in one direction. Values: sent or received. Omit to return both. Example: received.one of
sentreceived conversation_idstring- Only return the specific conversation. Example: t_10161234567890123.
conversations_onlyboolean- Return conversations instead of messages. Returns one page of conversations — follow meta.pagination.next for the rest. If true, conversationId is ignored. When conversationsOnly=true, conversation details are returned in converstationsDetails. This spelling is part of the current API response. Example: true.
limitinteger- Page size for messages and for conversation lists: an integer from 1 to 100, with a default and maximum of 100. On X/Twitter limit also chooses which set of messages you read. Omit it to page your stored messages, which is what every other platform does and what applies status, action and conversationsOnly. Supply it to page X's live timeline through X's own cursor instead, which applies none of those three filters. Example: 20.
nextstring- Opaque cursor from meta.pagination.next. Pass it as next with the same profile, platform and filters. Continue while meta.pagination.hasMore is true, even if a filtered page comes back short or empty. Example: QVFIUmF4b0Y5dE5tY2FqVEFCa0x4aVpBcXlR.
ayrshare_pinterest_boards_listList the linked Pinterest account's boards.Read-onlyList Pinterest Boards
List the linked Pinterest account's boards. Returns each board's id, name and description. Use a board id as boardId in pinterestOptions when posting.
Inputs
This tool takes no inputs.
ayrshare_platform_history_listList posts on one linked social network, including posts not made through Ayrshare, with their analytics.Read-onlyList Network Post History
List posts on one linked social network, including posts not made through Ayrshare, with their analytics. Returns each post's network ID, text, URL, created time, media and engagement counts, plus a next cursor. Use ayrshare_history_list for posts sent through Ayrshare.
Inputs
platformstringrequired- The platform of the posts to retrieve. Values: bluesky, facebook, instagram, linkedin, pinterest, snapchat, threads, tiktok, twitter, youtube. Example: facebook.one of
blueskyfacebookinstagramlinkedinpinterestsnapchatthreadstiktoktwitteryoutube data_typestring- Facebook and Instagram. Filter the type of content returned. By default, both regular posts and active Stories are returned. Values: posts — regular posts only (no Stories) stories — Stories only Omit this parameter to return both posts and Stories (default behavior). Note: For Facebook, expired/archived Stories (older than 24 hours) are automatically filtered out. Example: posts.one of
postsstories limitinteger- Number of history records to return. Max limit: 500 \ High limits may result in slower response times, so we recommend using a limit of no more than 100. \Higher limits are available on Enterprise plans. Please contact your account manager for details. Example: 20.
mediaboolean- Snapchat only. When true (default), Story and Saved Story history items include a mediaUrls array with each Snap's downloadable media URL. Fetching that media requires an extra request per Story, so set media=false to skip it for faster responses when you only need the Story metadata. Example: true.
nextstring- Cursor-based pagination for retrieving the next page of results. Pass the next value from the previous response's meta.pagination object to fetch the next set of posts. Example: QVFIUmF4b0Y5dE5tY2FqVEFCa0x4aVpBcXlR.
page_publishedboolean- Facebook only. By default the posts returned are from the Facebook Page feed. You may also choose to only return posts published by the page. Use feed (default) when you want a more comprehensive view of all content associated with the page, including interactions from other users. Use pagePublished when you only want to retrieve posts made by the page itself. Example: true.
sincestring- Facebook only. ISO UTC date string to filter posts created on or after this date. Use with until for a specific date range. Example: since=2026-03-17.
skip_analyticsboolean- Skip gathering full analytics for Facebook Pages and Instagram. Returns only the Social Post ID. Should be used if analytics aren't needed (only need the Social Post ID), for a faster return, or errors occur when limit 100. Example: true.
untilstring- Facebook only. ISO UTC date string to filter posts created on or before this date. Use with since for a specific date range. Example: until=2026-03-20.
user_idstring- X/Twitter only. This parameter allows you to retrieve posts from a specific X/Twitter user by their numeric ID, rather than from your linked account. For example, to get all posts from the handle @Google, you would use their numeric userId 20536157. You can find any X/Twitter user's numeric userId by using the Brands Get User endpoint. Note: Use only the API KEY in the header to make this request. Example: 1234567890.
user_namestring- X/Twitter only. This parameter allows you to retrieve posts from a specific X/Twitter user by their handle, rather than from your linked account. For example, to get all posts from the handle @Google. Note: Use only the API KEY in the header to make this request. Do not include the Profile Key. Example: ayrshare.
ayrshare_post_analytics_getGet likes, impressions, views, reactions and other metrics for a post, by Ayrshare post ID, optionally day by day.Read-onlyGet Post Analytics
Get likes, impressions, views, reactions and other metrics for a post, by Ayrshare post ID, optionally day by day. Returns per-network analytics for the post. Use ayrshare_social_analytics_get for account-level metrics.
Inputs
idstringrequired- Ayrshare post ID of the post. Example: TBEAAqAMMJoweA9wKHUl.
dailyboolean- When set to true, returns the post's analytics day by day, from the analytics Ayrshare has already collected for it, instead of fetching them from the social network. Requires startDate and endDate. Also works with searchPlatformId and postIds for Social Post IDs. See Daily Post Analytics. Example: true.
end_datestring- Required when daily is true. End of the period, in the same format as startDate, for example 2026-10-08T00:00:00Z. Includes analytics collected before this time. The period can be at most 31 days. Example: 2026-10-31.
platformsarray- String array of platforms to retrieve analytics. Accepts an array of strings with values:. Example: ["facebook", "linkedin"]
start_datestring- Required when daily is true. Start of the period, in ISO 8601 format: a date such as 2026-10-01 (read as midnight UTC), or a date-time with Z or an offset, such as 2026-10-01T00:00:00Z. A date-time without Z or an offset returns error 101. Includes analytics collected from this time. Example: 2026-10-01.
ayrshare_post_getGet a post sent through Ayrshare by its Ayrshare post ID.Read-onlyGet Post
Get a post sent through Ayrshare by its Ayrshare post ID. Returns the post text, platforms, status (pending, success, error and others), schedule date and per-network results. Use ayrshare_history_list to browse posts.
Inputs
idstringrequired- Ayrshare post ID returned by ayrshare_post_create. Example: TBEAAqAMMJoweA9wKHUl.
ayrshare_post_length_checkCalculate a post's weighted length (as X counts it) and whether it is within limits.Read-onlyCheck Post Length
Calculate a post's weighted length (as X counts it) and whether it is within limits. Returns the weighted length and validity. Use before posting long text to X.
Inputs
poststringrequired- Post string to calculate the length. Example: Big news: our spring collection is live! Shop now at https://example.com/spring.
ayrshare_post_rewriteGenerate up to five AI rewrites of a post.Read-onlyRewrite Post
Generate up to five AI rewrites of a post. Returns the rewritten versions. Use ayrshare_post_text_generate to write from a description.
Inputs
poststringrequired- The post text to be rewritten. Example: Big news: our spring collection is live! Shop now at https://example.com/spring.
emojisstring- Add emojis to the post. Example: true.
hashtagsstring- Add hashtags to the post. Example: true.
rewritesstring- Number of rewrites. Min: 1 and Max: 5. Example: 3.
twitterstring- Construct a post 280 or fewer characters. Example: false.
ayrshare_post_text_generateWrite a new social post with AI from a description or image URLs, optionally with hashtags and emojis.Read-onlyGenerate Post Text
Write a new social post with AI from a description or image URLs, optionally with hashtags and emojis. Returns the generated post text. Use ayrshare_post_rewrite to vary existing text.
Inputs
textstringrequired- Description of what the post should be about. For example: "A shoe sale happening Monday with specials on red, blue, and yellow shoes". Not required if mediaUrls parameter is included. Example: A shoe sale happening Monday with specials on red sneakers.
emojisboolean- Add emojis to the post. Example: true.
hashtagsboolean- Add hashtags to the post. Example: true.
media_urlsarray- An array of image URLs to base the post text on. Required if text parameter not included. Example: ["https://img.ayrshare.com/012/gb.jpg"]
twitterboolean- Construct a post with 280 or few characters. Example: false.
ayrshare_post_translateTranslate post text into another language with AI; the source language is detected.Read-onlyTranslate Post
Translate post text into another language with AI; the source language is detected. Returns the translated text. Use an ISO language code such as es, fr or de.
Inputs
langstringrequired- Language code to translate the text. Example: es.
textstringrequired- Text to be translated. Example: A shoe sale happening Monday with specials on red sneakers.
ayrshare_post_validateCheck a post for problems (text length, media requirements, missing options) without publishing it; takes the same fields as ayrshare_post_create.Read-onlyValidate Post
Check a post for problems (text length, media requirements, missing options) without publishing it; takes the same fields as ayrshare_post_create. Returns whether the post is valid and any errors per network. Use before ayrshare_post_create.
Inputs
platformsarrayrequired- Social media platforms to post. Accepts an array of Strings with values: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, or youtube. Please note: use facebook for Facebook Pages, and gmb for Google Business Profile. Use all to post to all linked social networks. Also include the required fields for all social networks. E.g. Example: ["facebook", "linkedin"]
poststringrequired- The post text sent to the social networks specified in the platforms parameter. See here for advanced options, including how to include URLs and rich text. You may send an empty string "" to publish with no text. Example: Big news: our spring collection is live! Shop now at https://example.com/spring.
auto_hashtagobject- See auto hashtags for details. Example: {"max": 3}
bluesky_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
disable_commentsboolean- Disable comments for the post. Only available for Instagram, LinkedIn, and TikTok. Example: true.
facebook_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
first_commentobject- Add in a first comment automatically after posting. See first comment for details. Example: {"comment": "Link in bio"}
gmb_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
instagram_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"reels": true}
is_videoboolean- Ayrshare will try to determine the media type based on the file extension in the URL (.mp4). You can explicitly set the media as a video if the URL does not end in a known video extension, such as animated GIFs. Please see video extension for details. Example: true.
linkedin_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
media_urlsarray- An array of image or video URLs to include in the post. Please see /media endpoint to learn more. URLs must be secure and begin with https://. If the URL has special characters, e.g. ñ, please encode the special characters before sending. Videos require a paid plan. Please see here for Image and Video Requirements and other advanced options. Example: ["https://img.ayrshare.com/012/gb.jpg"]
pinterest_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"boardId": "123456789012345678"}
reddit_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"title": "Spring sale", "subreddit": "marketing"}
schedule_datestring- The datetime to schedule a future post. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Also see schedule posts for details. Example: 2026-12-01T15:00:00Z.
shorten_linksboolean- Shorten links in the post for all platforms using Ayrshare's link shortener. Only URLs starting with https will be shortened. Max Pack required for link shortening. Please see here for using 3rd party link shorteners. Example: true.
snapchat_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
telegram_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
threads_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
tiktok_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
twitter_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
youtube_optionsobject- This network's settings, as in ayrshare_post_create. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"title": "Spring collection"}
ayrshare_profiles_listList the User Profiles under the primary profile, filtered by title, refId or linked networks (Business plan).Read-onlyList User Profiles
List the User Profiles under the primary profile, filtered by title, refId or linked networks (Business plan). Returns each profile's title, refId, activeSocialAccounts, tags and created date, plus a cursor. User profiles let you post for your own customers' social accounts.
Inputs
cursorstring- If there are additional profiles to return and the hasMore flag is true, the nextCursor will be returned in the response. Pass this cursor to the cursor query parameter to return the next set of profiles. Example: eyJpZCI6IjEyMyJ9.
has_active_social_accountsboolean- If true return only profiles that have at least one connected social account (activeSocialAccounts length greater than zero). If false return only profiles with zero connected social accounts (activeSocialAccounts length is zero). Example: true.
includestring- Extra data for one profile (needs ref_id), comma-separated: suspension, socialHealth, activity, quota. Example: suspension,socialHealth.
includes_active_social_accountsarray- Filter profiles to include those whose activeSocialAccounts contain all of the social media platforms specified in the includesActiveSocialAccounts list. Profiles can have additional platforms in their activeSocialAccounts beyond those listed in includesActiveSocialAccounts and still be included in the filtered results. Example: ["facebook", "instagram"]
is_byok_linkedboolean- Filter profiles by BYOK (Bring Your Own Key) migration status. If true, return only profiles that have completed BYOK migration. If false, return only profiles that have a BYOK-eligible platform connected but have not yet migrated. Profiles without a BYOK-eligible platform are excluded when this filter is set. When omitted, all profiles are returned regardless of BYOK status. Currently applies to X/Twitter BYOK. Example: true.
limitinteger- Limit the number of profiles returned. The default and maximum is 5000. Example: 20.
ref_idstring- Return only the profile associated with the given refId. The refId was returned during the profile creation or from the /user endpoint. Example: 160c8700bd6ade.
titlestring- Return only the profile associated with the URL encoded title. Example: Acme Store.
ayrshare_reddit_flair_listGet the post flairs of a subreddit.Read-onlyList Subreddit Flair
Get the post flairs of a subreddit. Returns each flair's id and text. Pass a flair id in redditOptions when a subreddit requires flair.
Inputs
subredditstringrequired- A valid subreddit name. Example: marketing.
ayrshare_review_getGet one Google Business Profile review by ID.Read-onlyGet Review
Get one Google Business Profile review by ID. Returns the rating, text, reviewer and reply. Use ayrshare_reviews_list for IDs.
Inputs
platformstringrequired- Review source; only gmb is supported. Example: gmb.one of
gmb review_idstringrequired- ID of the review, from ayrshare_reviews_list. Example: AbFvOqmQJ4xMTl2mjZl0h83TcOj.
ayrshare_reviews_listList reviews on the linked Facebook Page or Google Business Profile.Read-onlyList Reviews
List reviews on the linked Facebook Page or Google Business Profile. Returns reviews with id, rating, text, reviewer and any reply. Use ayrshare_review_reply to respond.
Inputs
platformstringrequired- Review source: facebook or gmb (Google Business Profile). Example: facebook.one of
facebookgmb
ayrshare_sentiment_analyzeAnalyze whether a post or comment's text is positive, negative or neutral.Read-onlyAnalyze Sentiment
Analyze whether a post or comment's text is positive, negative or neutral. Returns the sentiment and score. Use this to triage comments.
Inputs
textstringrequired- The string of text to generate the sentiment analysis on. ### Request Examples. Example: I love these sneakers, best purchase this year!.
ayrshare_social_analytics_getGet account-level analytics and demographics for linked social networks, such as followers, impressions, views and reach.Read-onlyGet Account Analytics
Get account-level analytics and demographics for linked social networks, such as followers, impressions, views and reach. Returns per-network account metrics. Use ayrshare_post_analytics_get for one post.
Inputs
platformsarrayrequired- Social media platforms to get analytics. Accepts an array of strings with values:. Example: ["facebook", "instagram"]
dailyboolean- When set to true, returns analytics data as daily time-series values instead of aggregated totals. This option is only available for Facebook, Google Business Profile, Instagram, Snapchat, TikTok, and YouTube platforms. Due to the larger data size, using compression is recommended. Example: true.
period60_daysboolean- For TikTok analytics, when set to true, this returns only the 60-day aggregate totals for comments, shares, and views (commentCountTotal, shareCountTotal, viewCountTotal). This provides faster response times compared to retrieving the full analytics history. Set to false to get the full analytics history. Note: Do not use this parameter together with daily=true as they are incompatible. Example: true.
quartersinteger- Specifies how many quarters of historical data to return. A quarter is: 85 days for Facebook 90 days for Google Business Profile, Instagram, TikTok, and YouTube 90 days for Snapchat (capped at 1 quarter / 90 days max due to Snapchat API limitations) Available for Facebook, Google Business Profile, Instagram, Snapchat, TikTok, and YouTube platforms. Valid values: 1–4. Example: 1.
user_idstring- X/Twitter only. This parameter allows you to retrieve posts from a specific X/Twitter user by their numeric ID, rather than from your linked account. For example, to get all posts from the handle @Google, you would use their numeric userId 20536157. You can find any X/Twitter user's numeric userId by using the Brands Get User endpoint. Note: Use only the API KEY in the header to make this request. Example: 1234567890.
user_namestring- X/Twitter only. This parameter allows you to retrieve posts from a specific X/Twitter user by their handle, rather than from your linked account. For example, to get all posts from the handle @Google. Note: Use only the API KEY in the header to make this request. Do not include the Profile Key. Example: ayrshare.
youtubeobject- Platform-specific options for YouTube analytics. lifetime (boolean, default: false): When set to true, includes lifetimeLikes in the response - the sum of likes across all public videos on the channel. This is computed by fetching all videos and summing their like counts, so it may take longer for channels with many videos. Example: {"lifetime": true}
ayrshare_user_getGet the account's linked social networks, usernames, account status and usage.Read-onlyGet Account Details
Get the account's linked social networks, usernames, account status and usage. Returns activeSocialAccounts, displayNames with each network's username and profile URL, and monthly post counts. Use this first to see which networks are linked.
Inputs
instagram_detailsboolean- Returns additional Instagram details such as account type (business or creator) and used quota. Not recommended unless you need the additional data since it will slow down the response time. Example: false.
ayrshare_video_transcribeTranscribe a video hosted by Ayrshare and suggest a title with AI.Read-onlyTranscribe Video
Transcribe a video hosted by Ayrshare and suggest a title with AI. Returns the transcription and a title. The video must be uploaded to Ayrshare's media library.
Inputs
video_urlstringrequired- URL encoded video URL. The video must be hosted by Ayrshare. Example: https://img.ayrshare.com/012/video.mp4.
ayrshare_webhooks_listList the webhook URLs registered for the account.Read-onlyList Webhooks
List the webhook URLs registered for the account. Returns each action and its URL. Set all_webhooks true to include every user profile's webhooks.
Inputs
all_webhooksboolean- Return all registered webhooks for every User Profile associated with your account, including the Primary Profile. You only need to provide the Primary Profile's API Key in the request header. Example: true.
ayrshare_youtube_categories_listList YouTube video category IDs for a region.Read-onlyList YouTube Categories
List YouTube video category IDs for a region. Returns each category's id and title. Use an assignable id as categoryId in youTubeOptions.
Inputs
regionstringrequired- Two letter country code of the region. Example: US.
ayrshare_auto_schedule_setCreate or replace a named posting schedule of UTC times on chosen days.WriteSet Auto Schedule
Create or replace a named posting schedule of UTC times on chosen days. Returns the schedule status. Queue posts into it with autoSchedule in ayrshare_post_create.
- Idempotent
Inputs
schedulearrayrequired- UTC times of day to post, as HH:MMZ strings. Example: ["13:05Z", "20:14Z"]
days_of_weekarray- Days to post on, 0 (Sunday) to 6 (Saturday). Omit for every day. Example: [1, 3, 5]
exclude_datesarray- Exclude certain dates from auto scheduling occurring. For example ["2026-01-01"] to exclude New Years. Note, only posts auto scheduled after the excludeDates has been set will be excluded. Example: ["2026-12-25"]
set_start_datestring- Set a specific beginning date to start the auto schedule, provide a ISO-8601 UTC date time. E.g. 2021-07-08T12:30:00Z. The start time will be applied to the provided "title" or will use the default title if one isn't provided. New posts will go out from the start date onwards. Previously scheduled posts are not affected. Example: 2026-12-01T00:00:00Z.
titlestring- You can create multiple different posting schedules by assigning a unique title to each one. The title must contain only alphanumeric characters - special characters like *, ~, /, [, or ] are not allowed. If you specify the title in /post with autoScheduleTitle, that schedule will be used. Example: Acme Store.
ayrshare_comment_createAdd a comment to a post, by Ayrshare post ID or a network's post ID.WriteAdd Comment
Add a comment to a post, by Ayrshare post ID or a network's post ID. Returns the comment IDs per network. Use ayrshare_comment_reply to reply to an existing comment.
Inputs
commentstringrequired- Text of the new comment to add to the post. Example: Thanks for the support!.
idstringrequired- Ayrshare post ID, or the network's post ID with search_platform_id true. Example: TBEAAqAMMJoweA9wKHUl.
platformsarrayrequired- Specify the platforms to add comments. If using an Ayrshare Post ID the supported platforms are: bluesky, facebook, instagram, linkedin, reddit, tiktok, twitter, youtube. If no platforms are specified, the comment will be published to all connected platforms that support comments. Example: ["facebook", "linkedin"]
media_urlsarray- Attach an image by providing the image URL for Facebook or X/Twitter. Only one image is supported in the mediaUrls field. Supported platforms are Facebook, LinkedIn, and X/Twitter. Example: ["https://img.ayrshare.com/012/gb.jpg"]
search_platform_idboolean- Set to true if posting a comment using the Social Post ID, which is the post id from the social networks. Example: true.
ayrshare_comment_replyReply to a comment by Ayrshare comment ID or network comment ID.WriteReply to Comment
Reply to a comment by Ayrshare comment ID or network comment ID. Returns the reply IDs per network. Use ayrshare_comments_get to find comment IDs.
Inputs
commentstringrequired- The reply to add to the comment. Example: Thanks for the support!.
comment_idstringrequired- Ayrshare comment ID, or the network's comment ID with search_platform_id true. Example: true.
platformsarrayrequired- If replying to a comment made through Ayrshare using the Ayrshare Comment ID, specify the platforms to post the reply. Supported platforms: bluesky, facebook, instagram, linkedin, tiktok, twitter, youtube. If replying to a comment made outside of Ayrshare using the Social Comment ID, specify the one platform to post the reply. Supported platforms: facebook, instagram, linkedin, tiktok, twit. Example: ["facebook", "linkedin"]
comment_urnstring- If replying to a LinkedIn comment with a Social Comment ID, you must also provide the full LinkedIn comment URN, which you get from the POST /comment endpoint or GET /comment endpoint as commentUrn — not the bare commentId. The URN has the form urn:li:comment:(urn:li:activity: , ). Only required for LinkedIn and "searchPlatformId": true. Example: urn:li:comment:(urn:li:activity:7123456789012345678,7123456789012345679)
media_urlsarray- Attach an image by providing the image URL. Only one image is supported. Facebook and LinkedIn only. Example: ["https://img.ayrshare.com/012/gb.jpg"]
obj_responseboolean- Response as Object, otherwise as an Array. Default to true. Example: true.
search_platform_idboolean- Set to true if replying to a comment using the Social Comment ID, which is the post commentId from the social networks. Example: true.
video_idstring- If replying to a TikTok comment with a Social Comment ID, you must also provide the TikTok video ID, which you get from the POST /comment endpoint or GET /comment endpoint. Only required for TikTok and "searchPlatformId": true. Example: 7298765432109876543.
ayrshare_feed_addAdd an RSS, Substack or YouTube feed whose new items Ayrshare posts automatically.WriteAdd RSS Feed
Add an RSS, Substack or YouTube feed whose new items Ayrshare posts automatically. Returns the feed id. Use ayrshare_feeds_list to see feeds.
Inputs
urlstringrequired- URL of the RSS feed to add. Example: https://example.com/blog/feed.xml.
auto_hashtagboolean- Automatically add up to 3 hashtags to the post text based on the most relevant keywords. Example: true.
platformsarray- Social network platforms to publish the article. If not provided, defaults to all connected platforms that are available for feeds. Available platforms:. Example: ["facebook", "linkedin"]
typestring- Value: rss, substack, or youtube. Example: rss.one of
rsssubstackyoutube use_first_imageboolean- Attempt to get the first or top image in the article and add it to the post. Example: true.
ayrshare_feed_updateChange an RSS feed's settings by its id.WriteUpdate RSS Feed
Change an RSS feed's settings by its id. Returns the update status. Use ayrshare_feeds_list for the id.
- Idempotent
Inputs
idstringrequired- The RSS feed id returned from the RSS feed POST endpoint. Example: kL5cR9aZ2qWx.
auto_hashtagboolean- Automatically add up to 3 hashtags to the post text based on the most relevant keywords. Example: true.
use_first_imageboolean- Attempt to get the first or top image in the article and add it to the post. Example: true.
ayrshare_link_createShorten a URL for use in posts, with optional UTM parameters.WriteCreate Short Link
Shorten a URL for use in posts, with optional UTM parameters. Returns the short link and its id. Requires Ayrshare's link shortening add-on. Use ayrshare_link_analytics_get for clicks.
Inputs
urlstringrequired- URL to be shortened. Must be a valid URL starting with https\://. Example: https://example.com/spring-sale.
utm_campaignstring- Used for keyword analysis. Used to identify a specific product promotion or strategic campaign. Example: spring_sale.
utm_contentstring- Used for A/B testing and content-targeted ads. Used to differentiate ads or links that point to the same URL. Example: header-link.
utm_idstring- Used to identify which Google Analytics ads campaign this referral references. Example: spring-2026.
utm_mediumstring- Used to identify a medium such as email or cost-per-click. Example: email.
utm_sourcestring- Used to identify a search engine, newsletter name, or other source. Example: newsletter.
utm_termstring- Used for paid search. Used to note the keywords for this ad. Example: sneakers.
ayrshare_link_updateChange the destination URL of a short link.WriteUpdate Short Link
Change the destination URL of a short link. Returns the updated link. Use ayrshare_links_list for link IDs.
- Idempotent
Inputs
idstringrequired- The short link ID returned from POST /links (e.g., "TkuWEy"). Example: yC0fTl.
urlstringrequired- The new destination URL. Must be a valid URL starting with https\://. Example: https://example.com/spring-sale-v2.
ayrshare_message_sendSend a direct message with text or media on Facebook, Instagram, X or WhatsApp, or react to a WhatsApp message.WriteSend Direct Message
Send a direct message with text or media on Facebook, Instagram, X or WhatsApp, or react to a WhatsApp message. Returns the message ID and status. Requires messaging enabled on the account. Use ayrshare_messages_list to find conversations and recipient IDs.
Inputs
platformstringrequired- The platform to send the message: facebook, instagram, twitter, whatsapp. Example: facebook.one of
facebookinstagramtwitterwhatsapp conversation_idstring- X/Twitter only. Send the message into an existing conversation instead of to a recipientId. Get the ID from Get Messages. Example: t_10161234567890123.
media_urlsarray- Array of media URLs for attaching images, video, audio (including voice messages), or documents. ; URLs of media items should end in the file extension without additional parameters appended. ; Facebook and Instagram support multiple media URLs. ; X only accepts a single media URL. ; Voice messages are supported on Facebook and Instagram as an aac or wav file. ; WhatsApp accepts multiple media URLs. Example: ["https://img.ayrshare.com/012/gb.jpg"]
messagestring- The message to send to the recipient. Required unless mediaUrls or reaction is sent. Must be left out when sending a reaction. ; Facebook, Instagram, and WhatsApp message may be an empty string or omitted entirely when mediaUrls is provided. ; X requires a message of at least one character even if a mediaUrls is provided. Example: Hi! Thanks for reaching out, how can we help?.
reactionobject- WhatsApp only. React to a message instead of sending one. Do not send message or mediaUrls with a reaction. ; messageId: Required. The ID of the WhatsApp message to react to. ; emoji: Required. A single emoji. Send an empty string "" to remove your reaction. Example: {"messageId": "wamid.HBgLMTU1NTEyMzQ1NjcVAgARGBI", "emoji": "❤️"}
recipient_idstring- The ID of the message recipient. Required for Facebook, Instagram, and WhatsApp. For X/Twitter, send recipientId or conversationId. ; For Facebook, Instagram, and X/Twitter this is the platform-specific user ID (PSID, IGSID, or user ID). ; For WhatsApp this is the recipient's phone number in E.164 digits-only format (for example 14155551234, not +1 (415) 555-1234). Example: 7101234567890123.
ayrshare_post_copyCopy an existing post to other networks, optionally scheduled and with per-network overrides.WriteCopy Post
Copy an existing post to other networks, optionally scheduled and with per-network overrides. Returns the new post's id and per-network results. Use ayrshare_post_create for new content.
Inputs
platformsarrayrequired- Social media platforms to post the copied content to. Accepts an array of Strings with values: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, or youtube. Please note: use facebook for Facebook Pages, and gmb for Google Business Profile. Example: ["linkedin", "threads"]
post_idstringrequired- The ID of the existing post to copy. This is the Ayrshare Post ID returned from the original /post endpoint. Example: TBEAAqAMMJoweA9wKHUl.
auto_hashtagobject- Override the original post's auto hashtag settings. See auto hashtags for details. Example: {"max": 3}
bluesky_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
disable_commentsboolean- Override the original post's comment settings. Only available for Instagram, LinkedIn, and TikTok. Example: true.
facebook_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
first_commentobject- Override the original post's first comment settings. See first comment for details. Example: {"comment": "Link in bio"}
gmb_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
instagram_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
linkedin_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
notesstring- Add new notes to the copied post. These will replace any notes from the original post. Notes are for reference only and do not affect the post content. Example: Approved by marketing.
pinterest_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
reddit_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
schedule_datestring- The datetime to schedule the copied post. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. If not provided, the post will be published immediately. Example: 2026-12-01T15:00:00Z.
shorten_linksboolean- Override the original post's link shortening setting. Max Pack required for link shortening. Example: true.
snapchat_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
telegram_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
threads_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
tiktok_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
twitter_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {}
youtube_optionsobject- Override this network's settings for the copy. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"title": "Spring collection"}
ayrshare_post_createPublish or schedule a post with text and optional images or video to one or more linked social networks: Bluesky, Facebook, Google Business Profile, Instagram, LinkedIn, Pinterest, Reddit, Snapchat, Telegram, Threads, TikTok, X and YouTube.WritePublish Post
Publish or schedule a post with text and optional images or video to one or more linked social networks: Bluesky, Facebook, Google Business Profile, Instagram, LinkedIn, Pinterest, Reddit, Snapchat, Telegram, Threads, TikTok, X and YouTube. Returns status, the Ayrshare post id, and per-network postIds with each network's post URL or error. Set schedule_date to schedule. Use ayrshare_post_validate to check a post first. Posting to X needs your own X API keys, which this connector does not send.
Inputs
platformsarrayrequired- Networks to post to: bluesky, facebook (Pages), gmb (Google Business Profile), instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter or youtube. Each must be linked in Ayrshare. Example: ["facebook", "linkedin"]
poststringrequired- The post text sent to the social networks specified in the platforms parameter. See here for advanced options, including how to include URLs and rich text. You may send an empty string "" to publish with no text. Example: Big news: our spring collection is live! Shop now at https://example.com/spring.
auto_hashtagobject- Add AI hashtags, for example {"max": 3, "position": "auto"}. Example: {"max": 3, "position": "auto"}
auto_repostobject- Repost the content repeatedly, for example {"repeat": 3, "days": 5}. Example: {"repeat": 3, "days": 5}
auto_scheduleobject- Queue the post in an auto-schedule instead of a fixed time, for example {"schedule": true, "title": "default"}. Example: {"schedule": true, "title": "default"}
bluesky_optionsobject- Bluesky-specific settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"altText": ["A red sneaker"]}
disable_commentsboolean- Disable comments for the post. Only available for Instagram, LinkedIn, and TikTok. Example: true.
facebook_optionsobject- Facebook-specific settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"reels": true}
first_commentobject- A first comment to add after publishing, for example {"comment": "Link in bio"}. Example: {"comment": "Link in bio"}
gmb_optionsobject- Google Business Profile settings (event or offer posts). Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"isPhotoVideo": true}
idempotency_keystring- An optional unique ID associated with the post. Duplicate IDs will be rejected. Please see idempotency for details. Example: spring-launch-001.
instagram_optionsobject- Instagram settings (Reels, Stories, carousels, collaborators). Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"reels": true}
is_videoboolean- Ayrshare will try to determine the media type based on the file extension in the URL (.mp4). You can explicitly set the media as a video if the URL does not end in a known video extension, such as animated GIFs. Please see video extension for details. Example: true.
linkedin_optionsobject- LinkedIn settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"visibility": "public"}
media_urlsarray- An array of image or video URLs to include in the post. Please see /media endpoint to learn more. URLs must be secure and begin with https://. If the URL has special characters, e.g. ñ, please encode the special characters before sending. Videos require a paid plan. Please see here for Image and Video Requirements and other advanced options. Example: ["https://img.ayrshare.com/012/gb.jpg"]
notesstring- Set notes on a post that can be retrieved via the /history endpoint. Notes are for reference only and do not affect the post. Example: Approved by marketing.
pinterest_optionsobject- Pinterest settings (boardId is required for Pinterest). Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"boardId": "123456789012345678"}
reddit_optionsobject- Reddit settings (subreddit and title are required for Reddit). Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"title": "Spring sale", "subreddit": "marketing"}
requires_approvalboolean- See approval workflow for details. Example: true.
schedule_datestring- The datetime to schedule a future post. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. Also see schedule posts for details. Example: 2026-12-01T15:00:00Z.
shorten_linksboolean- Shorten links in the post for all platforms using Ayrshare's link shortener. Only URLs starting with https will be shortened. Max Pack required for link shortening. Please see here for using 3rd party link shorteners. Example: true.
snapchat_optionsobject- Snapchat settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"spotlight": true}
telegram_optionsobject- Telegram settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"disableNotification": true}
threads_optionsobject- Threads settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"thread": true}
tiktok_optionsobject- TikTok settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"visibility": "public"}
twitter_optionsobject- X/Twitter settings. Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"thread": true}
unsplashstring- Attach an Unsplash image: an Unsplash image ID, or random for a random image matching the post. Example: random.
validate_scheduledboolean- By default, scheduled posts are checked (pre-validated) for issues such as media requirements before they are accepted. If any problems are found by Ayrshare checks, you will receive an immediate error response and the post will not be scheduled. When the scheduled date is reached, the post will be published, at which time the final success or error response will be sent either via webhook or the /history endpoint. Example: true.
youtube_optionsobject- YouTube settings (title is required for YouTube). Pass the object exactly as Ayrshare documents it on the network's page under Supported Social Networks. Example: {"title": "Spring collection", "visibility": "public"}
ayrshare_post_retryRetry publishing a post that failed with an error status.WriteRetry Post
Retry publishing a post that failed with an error status. Returns the retry status; the post is treated as scheduled. Use ayrshare_post_get to see why it failed first.
Inputs
idstringrequired- The top-level Ayrshare Post ID. The original post must have a status of "error". Example: TBEAAqAMMJoweA9wKHUl.
ayrshare_post_updateUpdate a pending post: reschedule it, pause or unpause it, approve it, change notes, or disable comments.WriteUpdate Post
Update a pending post: reschedule it, pause or unpause it, approve it, change notes, or disable comments. Returns the update status. Only pending or awaiting-approval posts can be changed.
- Idempotent
Inputs
idstringrequired- Ayrshare Post ID of the post to update. Ayrshare Post ID returned from /post. Example: TBEAAqAMMJoweA9wKHUl.
approvedboolean- The original post requires approval and has a status of "awaiting approval", set to true to approve and publish the post. Example: true.
disable_commentsboolean- Enable or disable comments on a post. Setting to true will disable comments. Setting to false will enable comments. Supported platforms: Instagram and LinkedIn. ; The post must be published. Otherwise the request returns error 305. ; Disabling comments on a published post will not delete existing comments. ; Disabling LinkedIn comments will delete all existing comments on the thread. Example: true.
notesstring- Set notes on a post that can be retrieved via the /history endpoint. Notes are for reference only and do not affect the post. Example: Approved by marketing.
schedule_datestring- The datetime to schedule a future post. Accepts a UTC date time. For example, use format YYYY-MM-DDThh:mm:ssZ and send as 2026-07-08T12:30:00Z. Please see utctime for more examples. If the datetime is in the past, the post will immediately be sent. Example: 2026-12-01T15:00:00Z.
scheduled_pauseboolean- 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. Example: true.
youtube_optionsobject- 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. Example: {}
ayrshare_profile_createCreate a User Profile under the primary profile (Business plan).WriteCreate User Profile
Create a User Profile under the primary profile (Business plan). Returns the new profile's profileKey and refId. The profile key is needed to act for that profile in Ayrshare; this connector acts on the primary profile.
Inputs
titlestringrequired- Title of the new profile. Must be unique. This title will be displayed on the social account linking page. Example: Acme Store.
disable_socialarray- Array of social networks that are disabled for this user's profile. The primary profile's list of disabled social networks takes precedence. Available networks: bluesky, facebook, gmb, instagram, linkedin, pinterest, reddit, snapchat, telegram, threads, tiktok, twitter, and youtube. See enable or disable social networks for more information. Example: ["reddit"]
emailstring- A valid email address where the team member invite will be sent. Required if team: true. Example: teammate@example.com.
hide_logoboolean- Hide the company logo on the social accounts linkage page for this user profile only. The account-wide logo on other profiles is unaffected. Useful for white-labeling individual partner profiles while keeping branding on the rest. Example: true.
hide_top_headerboolean- Hide the top header on the social accounts linkage page. Example: true.
messaging_activeboolean- Set to true to activate messaging for this user profile. Messaging must first be enabled for your Ayrshare account. Example: true.
sub_headerstring- Change the sub header on the social accounts linkage page. Currently displays "Click an icon to link a social network". Set to an empty string to remove. See how to change the help link. Example: Click an icon to link a social network.
tagsarray- Tag user profiles using an array of strings. These tags serve as an internal organizational tool to categorize and manage your user profiles effectively. Example: ["retail", "vip"]
teamboolean- Create a new user profile as a team member by setting team: true. The email field will be used to send an invite email. See inviting a team member for details on the requirements. Example: true.
top_headerstring- Change the header on the social accounts linkage page. If not set, then displays: "Social Accounts for "title" where "title" is the profile title. Example: Connect your social accounts.
ayrshare_review_replyPost a reply to a Facebook Page or Google Business Profile review.WriteReply to Review
Post a reply to a Facebook Page or Google Business Profile review. Returns the reply status. Use ayrshare_review_reply_delete to remove a Google reply.
Inputs
platformstringrequired- Review source: facebook or gmb. Example: gmb.one of
gmbfacebook replystringrequired- Reply text. Example: Thank you for the kind review!.
review_idstringrequired- ID of the review, from ayrshare_reviews_list. Example: AbFvOqmQJ4xMTl2mjZl0h83TcOj.
ayrshare_webhook_registerRegister a webhook URL for an event type such as scheduled, social, messages, comments or feed.WriteRegister Webhook
Register a webhook URL for an event type such as scheduled, social, messages, comments or feed. Returns the registration status. Use ayrshare_webhooks_list to see registered webhooks.
- Idempotent
Inputs
actionstringrequired- Available actions: feed, social, scheduled, batch, messages, mentions, comments, automations, demo, suspended, ads. Example: scheduled.one of
socialscheduledfeedmessagescommentsbatchautoScheduleauth urlstringrequired- The URL to be called on action. URL must be in a valid format and begin with *https\://The URL must be reachable on the public internet. A URL that points to localhost, a private network address such as 192.168.x.x or 10.x.x.x, or another internal address returns error 101. Example: https://example.com/webhooks/ayrshare.
secretstring- Secret text used for HMAC. Please see overview for more details. Example: my-hmac-secret.
ayrshare_auto_schedule_deleteDelete an auto schedule by title, or the default schedule if no title is given.DestructiveDelete Auto Schedule
Delete an auto schedule by title, or the default schedule if no title is given. Returns the delete status. Posts already scheduled from it keep their times.
- Idempotent
Inputs
delete_last_schedule_dateboolean- Reset the schedule's starting point to the current time. When set to true, this will clear the last used schedule date, causing any new posts to be scheduled starting from the current time. Any posts that were already scheduled will remain unchanged and publish at their original times. Example: true.
titlestring- The title of the schedule to delete. This should match a schedule title that was previously created using the Set Auto Schedule endpoint. If no title is provided, the system will attempt to delete the "default" schedule. Example: default.
ayrshare_comments_deleteDelete one comment, all comments Ayrshare sent on a post, or hide a comment instead of deleting it.DestructiveDelete Comments
Delete one comment, all comments Ayrshare sent on a post, or hide a comment instead of deleting it. Returns the delete status per network. Use hide true to hide on Facebook, Instagram or TikTok.
- Idempotent
Inputs
idstringrequired- Ayrshare post ID (deletes all its Ayrshare comments), Ayrshare comment ID, or a network comment ID with search_platform_id true. Example: TBEAAqAMMJoweA9wKHUl.
hideboolean- Set to true to hide a comment from public view instead of deleting it. Supported on Facebook, Instagram, and TikTok. A hidden comment stays visible to the person who wrote it, and the success response returns action: "hide". Facebook and Instagram don't need videoId. Set to true, together with videoId, to hide a TikTok comment from public viewers instead of deleting it. Example: true.
platformstring- Required if deleting using the Social Comment ID, which is the commentId from the social networks. Supported platforms: bluesky, facebook, instagram, threads, tiktok, twitter, youtube. Only one platform is supported at a time. Example: facebook.
platformsarray- Required if deleting comments sent via Ayrshare. The platforms to delete comments from. Supported platforms: bluesky, facebook, instagram, linkedin, reddit, threads, tiktok, twitter, youtube. Example: ["facebook", "linkedin"]
search_platform_idboolean- Required if deleting using the Social Comment ID, which is the commentId from the social networks, set to true. Example: true.
video_idstring- Required when hiding a TikTok comment (hide=true). The TikTok video ID the comment belongs to. Example: 7298765432109876543.
ayrshare_feed_deleteDelete an RSS feed so its new items are no longer posted.DestructiveDelete RSS Feed
Delete an RSS feed so its new items are no longer posted. Returns the delete status. Use ayrshare_feeds_list for the id.
- Idempotent
Inputs
idstringrequired- ID of the RSS Feed returned when adding. Example: kL5cR9aZ2qWx.
ayrshare_post_deleteDelete a published or scheduled post by ID, several posts with bulk, or every pending scheduled post with delete_all_scheduled.DestructiveDelete Post
Delete a published or scheduled post by ID, several posts with bulk, or every pending scheduled post with delete_all_scheduled. Returns the delete status per network. Instagram and TikTok do not allow deleting published posts through their APIs.
- Idempotent
Inputs
bulkarray- Array of Strings post Ids to bulk delete. Required if id or deleteAllScheduled parameter not sent. Example: ["TBEAAqAMMJoweA9wKHUl", "Ut1fWU6XkqkMayHGnJZ"]
delete_all_scheduledboolean- If true will delete all scheduled posts still in a pending state, i.e. posts that have not yet been published to the networks, for the User Profile. The id parameter is ignored if set to true. If bulk is also sent, bulk is used and deleteAllScheduled is ignored. This will delete all scheduled posts, so be sure to use this with caution. Example: true.
idstring- Ayrshare post ID to delete. Leave empty when using bulk or delete_all_scheduled. Example: TBEAAqAMMJoweA9wKHUl.
mark_manual_deletedboolean- If true, the post will mark as deleted in Ayrshare and Ayrshare will not try to delete the post at the networks. A common use case for this is when the post was manually deleted at the networks and you want to mark it as deleted in Ayrshare. Prior to marking the post as deleted, please ensure that the post was already manually deleted on the social networks. Example: true.
ayrshare_profile_deletePermanently delete a User Profile and all its posts, by title.DestructiveDelete User Profile
Permanently delete a User Profile and all its posts, by title. Returns the delete status. This cannot be undone.
- Idempotent
Inputs
titlestringrequired- Title of the User Profile to delete. Example: Acme Store.
ayrshare_review_reply_deleteDelete your reply on a Google Business Profile review.DestructiveDelete Review Reply
Delete your reply on a Google Business Profile review. Returns the delete status. Only Google Business Profile replies can be deleted.
- Idempotent
Inputs
platformstringrequired- Values: gmb. Example: gmb.one of
gmb review_idstringrequired- ID of the review whose reply to delete. Example: AbFvOqmQJ4xMTl2mjZl0h83TcOj.
ayrshare_webhook_unregisterUnregister the webhook for an event type.DestructiveUnregister Webhook
Unregister the webhook for an event type. Returns the status. Use ayrshare_webhooks_list to see which are registered.
- Idempotent
Inputs
actionstringrequired- Available actions: feed, social, scheduled, batch, messages, mentions, comments, automations, accountActivity, demo, suspended, ads. Example: scheduled.one of
socialscheduledfeedmessagescommentsbatchautoScheduleauth
No tools match.
Related: other Marketing connectors
All 190 in MarketingHubSpotScalekit connectorCRM records, marketing emails and events, blogs and HubDB tables.Scalekit credentials availableOAuth457 tools
MailchimpScalekit connectorCampaigns, audiences and members, segments, automations and reports.Scalekit credentials availableOAuth73 tools
Twitter / XScalekit connectorPosts, users, lists, bookmarks, direct messages and media uploads.Scalekit credentials availableOAuth92 tools