Static clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic clearStatic createCreate a new destination for a title update.
The ID of the promotion schedule.
The ID of the title update.
The data for the new destination.
Optional params: Record<string, any>promise
Static createStatic createCreate a new title update for a promotion schedule.
The ID of the promotion schedule.
The data for the new update.
Optional params: Record<string, any>promise
Static crossFind potential cross-promote partners for a scheduler (with optional filters). GET /schedulers/{scheduler_id}/crosspromote/find
Optional params: Record<string, any>Static crossRespond to a normalized cross-promote invitation. POST /schedulers/cross-promote/invitations/{invitation_id}/respond
Optional params: Record<string, any>Static crossStatic crossAccept an invite to cross-promote. POST /schedulers/{scheduler_id}/crosspromote/invites/{invite_id}/accept
Optional params: Record<string, any>Static crossReject an invite to cross-promote. POST /schedulers/{scheduler_id}/crosspromote/invites/{invite_id}/reject
Optional params: Record<string, any>Static crossSend an invite to cross-promote (from scheduler_id to partner_scheduler_id). POST /schedulers/{scheduler_id}/crosspromote/invites
{ partner_scheduler_id, optional_message }
Optional params: Record<string, any>Static crossList cross-promote invites for a scheduler (incoming + outgoing). GET /schedulers/{scheduler_id}/crosspromote/invites
Optional params: Record<string, any>Static crossList cross-promote relationships for a scheduler (with optional pagination). GET /schedulers/{scheduler_id}/crosspromote/relationships
Optional params: Record<string, any>Static crossEnd a cross-promote relationship (delete). DELETE /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}
Optional params: Record<string, any>Static crossEnd a normalized cross-promote relationship. POST /schedulers/cross-promote/relationships/{relationship_id}/end
Optional params: Record<string, any>Static crossGet which platforms are cross-promoted in an existing relationship. GET /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}/platforms
Optional params: Record<string, any>Static crossList normalized cross-promote relationship logs. GET /schedulers/cross-promote/relationships/{relationship_id}/logs
Optional params: Record<string, any>Static crossGet recently cross-promoted logs under a relationship. GET /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}/posts
Optional params: Record<string, any>Static crossSet which platforms are cross-promoted in an existing relationship. PUT /schedulers/{scheduler_id}/crosspromote/relationships/{relationship_id}/platforms data = { platforms: ['twitter','facebook',...]}
Optional params: Record<string, any>Static crossStatic crossStatic deleteDelete a title update destination.
The ID of the promotion schedule.
The ID of the title update.
The ID of the destination.
Optional params: Record<string, any>promise
Static deleteStatic deleteStatic generateGenerate hashtags for content based on scheduler settings.
The ID of the promotion schedule.
{ content: string, platform?: string }
Optional params: Record<string, any>promise
Static generateGenerate tailored content for a specific subreddit.
The ID of the promotion schedule.
The target subreddit and post context.
Optional params: Record<string, any>promise
Static generateRewrite / generate content for a promotion schedule.
UUID of the promotion schedule.
Body payload. At minimum you must supply
{ platform: 'twitter' } plus either content
or a media array containing at least one
{ id: '<media-uuid>' }.
Optional params: Record<string, any>Axios promise with { content, title? }
Static getGet ad conversion actions for a specific platform linked to the scheduler.
The ID of the promotion schedule.
Query parameters, including 'platform' (required) and 'account_id' (optional).
Optional account_promise
Static getGet a specific title update destination.
The ID of the promotion schedule.
The ID of the title update.
The ID of the destination.
Optional params: Record<string, any>promise
Static getStatic getStatic getGet Instagram accounts associated with the scheduler's Instagram account.
The ID of the promotion schedule.
Optional params: Record<string, any>promise
Static getGet subreddit recommendations for a scheduler.
The ID of the promotion schedule.
The context for the post (title, content, media type).
Optional params: Record<string, any>promise
Static getGet flairs for a specific Reddit subreddit.
The ID of the promotion schedule.
The name of the subreddit.
Optional params: Record<string, any>promise
Static getMatch the scheduler title to indexed Reddit communities.
The ID of the promotion schedule.
Optional post context and filters.
Optional params: Record<string, any>promise
Static getPosition a registered game for a subreddit and optionally prepare Reddit draft content.
The ID of the promotion schedule.
The target subreddit and optional post context.
Optional params: Record<string, any>promise
Static getGet posting rules for a specific Reddit subreddit.
The ID of the promotion schedule.
The name of the subreddit.
Optional params: Record<string, any>promise
Static getStatic getStatic getStatic getGet all posts and comments for a scheduler.
The ID of the promotion schedule.
Optional params: Record<string, any>Optional query parameters for filtering and sorting.
promise
Static getGet progression data for social media posts over time.
The ID of the promotion schedule.
Optional params: Record<string, any>Query parameters (e.g., social_platform, start_date, end_date)
promise
Static getGet aggregated reports for a promotion schedule.
The ID of the promotion schedule.
Optional params: Record<string, any>Query parameters (e.g., social_platform, start_date, end_date)
promise
Static getGet TikTok hashtag suggestions based on a keyword.
The ID of the promotion schedule.
{ keyword: string }
Static getStatic getGet TikTok Music List with advanced filtering (Keyword, Recommendations, Liked).
Optional params: Record<string, any>{ music_scene: 'CREATIVE_ASSET'|'CAROUSEL_ADS', search_type: string, filtering: object }
Static getStatic getGet the top 200 trending hashtags on TikTok.
Optional params: Record<string, any>{ country_code: string, category_name: string, date_range: string }
Static getStatic getGet a specific title update.
The ID of the promotion schedule.
The ID of the title update.
Optional params: Record<string, any>promise
Static listList Ad Accounts for the given campaign ID, as defined by /schedulers/{scheduler_id}/ad_accounts on the backend.
E.g. for Reddit, you can pass ?business_id= to get business-level ad accounts, or for Twitter, it might just return a user’s ad accounts, etc.
The UUID of the Ad Campaign
Optional params: Record<string, any>Optional query parameters, e.g. business_id, page.size, etc.
A response object with data (ad account list)
Static listList platform-level businesses for the given campaign ID, as defined by /schedulers/{scheduler_id}/businesses on the backend.
Typically relevant for Reddit (list businesses), or might return a "not supported" message for Meta/TikTok.
The UUID of the Ad Campaign
Optional params: Record<string, any>Optional query parameters, e.g. page.size, etc.
A response object with data (business list or messages)
Static listList funding instruments for the given campaign ID, as defined by /schedulers/{scheduler_id}/funding_instruments on the backend.
For Twitter, pass ?account_id=... For Reddit, pass ?ad_account_id=... or ?business_id=...
The UUID of the Ad Campaign
Optional params: Record<string, any>Optional query parameters
A response object with data (funding instruments)
Static listList Google Ads conversion actions available to a scheduler account. GET /schedulers/{scheduler_id}/conversion-actions
Optional params: Record<string, any>Static listList all destinations for a title update.
The ID of the promotion schedule.
The ID of the title update.
Optional params: Record<string, any>promise
Static listStatic listStatic scheduleSchedule title update.
The ID of the promotion schedule.
The ID of the title update.
The data to update.
Optional params: Record<string, any>promise
Static searchStatic sendSend a platform test conversion event through the backend scheduler route.
The ID of the promotion schedule.
Platform key, e.g. reddit, tiktok, facebook, google.
Optional params: Record<string, any>Query parameters such as Reddit test_id or Meta test_event_code.
Static syncSync all comments for all posts in a scheduler.
The ID of the promotion schedule.
Optional params: Record<string, any>Optional query parameters (e.g., limit_per_post).
promise
Static syncTrigger a historical sync for a specific platform on a scheduler.
The ID of the promotion schedule.
The platform to sync (e.g., 'twitter', 'youtube', 'bluesky').
Optional params: Record<string, any>promise
Static testStatic updateUpdate a title update destination.
The ID of the promotion schedule.
The ID of the title update.
The ID of the destination.
The data to update.
Optional params: Record<string, any>promise
Static updateStatic updateUpdate a title update.
The ID of the promotion schedule.
The ID of the title update.
The data to update.
Optional params: Record<string, any>promise
Generated using TypeDoc
Clear Bluesky OAuth credentials from a promotion schedule.