@zernio/node
v0.2.1728
Published
The official Node.js library for the Zernio API
Readme
The official Node.js SDK for the Zernio API — schedule and publish social media posts across Instagram, TikTok, YouTube, LinkedIn, X/Twitter, Facebook, Pinterest, Threads, Bluesky, Reddit, Snapchat, Telegram, WhatsApp, and Google Business Profile with a single integration.
Installation
npm install @zernio/nodeQuick Start
import Zernio from '@zernio/node';
const zernio = new Zernio(); // Uses ZERNIO_API_KEY env var
// Publish to multiple platforms with one call
const { data: post } = await zernio.posts.createPost({
body: {
content: 'Hello world from Zernio!',
platforms: [
{ platform: 'twitter', accountId: 'acc_xxx' },
{ platform: 'linkedin', accountId: 'acc_yyy' },
{ platform: 'instagram', accountId: 'acc_zzz' },
],
publishNow: true,
},
});
console.log(`Published to ${post.platforms.length} platforms!`);Configuration
const zernio = new Zernio({
apiKey: 'your-api-key', // Defaults to process.env['ZERNIO_API_KEY']
baseURL: 'https://zernio.com/api',
timeout: 300000,
fetch: myFetch, // optional, wraps every request
});A per-call signal overrides timeout, and a timed-out call rejects with a TimeoutError.
Examples
Schedule a Post
const { data: post } = await zernio.posts.createPost({
body: {
content: 'This post will go live tomorrow at 10am',
platforms: [{ platform: 'instagram', accountId: 'acc_xxx' }],
scheduledFor: '2025-02-01T10:00:00Z',
},
});Platform-Specific Content
Customize content per platform while posting to all at once:
const { data: post } = await zernio.posts.createPost({
body: {
content: 'Default content',
platforms: [
{
platform: 'twitter',
accountId: 'acc_twitter',
platformSpecificContent: 'Short & punchy for X',
},
{
platform: 'linkedin',
accountId: 'acc_linkedin',
platformSpecificContent: 'Professional tone for LinkedIn with more detail.',
},
],
publishNow: true,
},
});Upload Media
// 1. Get presigned upload URL
const { data: presign } = await zernio.media.getMediaPresignedUrl({
body: { filename: 'video.mp4', contentType: 'video/mp4' },
});
// 2. Upload your file
await fetch(presign.uploadUrl, {
method: 'PUT',
body: videoBuffer,
headers: { 'Content-Type': 'video/mp4' },
});
// 3. Create post with media
const { data: post } = await zernio.posts.createPost({
body: {
content: 'Check out this video!',
mediaUrls: [presign.publicUrl],
platforms: [
{ platform: 'tiktok', accountId: 'acc_xxx' },
{ platform: 'youtube', accountId: 'acc_yyy', youtubeTitle: 'My Video' },
],
publishNow: true,
},
});Get Analytics
const { data } = await zernio.analytics.getAnalytics({
query: { postId: 'post_xxx' },
});
console.log('Views:', data.analytics.views);
console.log('Likes:', data.analytics.likes);
console.log('Engagement Rate:', data.analytics.engagementRate);List Connected Accounts
const { data } = await zernio.accounts.listAccounts();
for (const account of data.accounts) {
console.log(`${account.platform}: @${account.username}`);
}Error Handling
import Zernio, { ZernioApiError, RateLimitError, ValidationError } from '@zernio/node';
try {
await zernio.posts.createPost({ body: { /* ... */ } });
} catch (error) {
if (error instanceof RateLimitError) {
console.log(`Rate limited. Retry in ${error.getSecondsUntilReset()}s`);
} else if (error instanceof ValidationError) {
console.log('Invalid request:', error.fields);
} else if (error instanceof ZernioApiError) {
console.log(`Error ${error.statusCode}: ${error.message}`);
}
}SDK Reference
Posts
| Method | Description |
|--------|-------------|
| posts.listPosts() | List posts |
| posts.bulkUploadPosts() | Bulk upload from CSV |
| posts.createPost() | Create post |
| posts.getPost() | Get post |
| posts.updatePost() | Update post |
| posts.updatePostMetadata() | Update post metadata |
| posts.deletePost() | Delete post |
| posts.editPost() | Edit published post |
| posts.pinPost() | Pin post |
| posts.retryPost() | Retry failed post |
| posts.reviewPost() | Approve or reject a post |
| posts.unpinPost() | Unpin post |
| posts.unpublishPost() | Unpublish post |
Accounts
| Method | Description |
|--------|-------------|
| accounts.getAllAccountsHealth() | Check accounts health |
| accounts.listAccounts() | List accounts |
| accounts.listBusinessPartners() | List partner businesses of the Page |
| accounts.listTikTokCommercialMusic() | List trending commercial music |
| accounts.getAccountHealth() | Check account health |
| accounts.getAccountPosts() | List posts published on the platform |
| accounts.getBlueskySettings() | Get Bluesky account settings |
| accounts.getFollowerStats() | Get follower stats |
| accounts.getGoogleBusinessReview() | Get a review |
| accounts.getGoogleBusinessReviews() | Get reviews |
| accounts.getHubSpotSettings() | Get HubSpot account settings |
| accounts.getInstagramFollowStatus() | Check whether an Instagram user follows the account |
| accounts.getLinkedInMentions() | Resolve LinkedIn mention |
| accounts.getSalesforceSettings() | Get Salesforce account settings |
| accounts.getSlackSettings() | Get Slack account settings |
| accounts.getStripeSettings() | Get Stripe account settings |
| accounts.getTikTokCreatorInfo() | Get TikTok creator info |
| accounts.updateAccount() | Update account |
| accounts.updateBlueskySettings() | Update Bluesky account settings |
| accounts.updateHubSpotSettings() | Update HubSpot account settings |
| accounts.updateSalesforceSettings() | Update Salesforce account settings |
| accounts.updateSlackSettings() | Update Slack account settings |
| accounts.updateStripeSettings() | Update Stripe account settings |
| accounts.deleteAccount() | Disconnect account |
| accounts.deleteGoogleBusinessReviewReply() | Delete a review reply |
| accounts.batchGetGoogleBusinessReviews() | Batch get reviews |
| accounts.grantBusinessPartner() | Share the Page with a partner business |
| accounts.moveAccountToProfile() | Move account to another profile |
| accounts.replyToGoogleBusinessReview() | Reply to a review |
| accounts.revokeBusinessPartner() | Revoke a partner business from the Page |
| accounts.searchTikTokLocations() | Search TikTok location tags |
Profiles
| Method | Description |
|--------|-------------|
| profiles.listProfiles() | List profiles |
| profiles.createProfile() | Create profile |
| profiles.getProfile() | Get profile |
| profiles.getProfileLimits() | Get profile call limits |
| profiles.updateProfile() | Update profile |
| profiles.deleteProfile() | Delete profile |
Analytics
| Method | Description |
|--------|-------------|
| analytics.listFacebookTaggedPosts() | List the posts a Facebook Page is tagged in |
| analytics.listFacebookVisitorPosts() | List visitor posts on a Facebook Page |
| analytics.listGoogleSearchConsoleSitemaps() | List Google Search Console sitemaps |
| analytics.listPostAuthenticity() | List authenticity scores |
| analytics.listTrackingWindows() | List tracking windows |
| analytics.getAnalytics() | Get post analytics |
| analytics.getAnalyticsDashboard() | Get an analytics dashboard |
| analytics.getAnalyticsDelta() | Analytics changed since a cursor |
| analytics.getBestTimeToPost() | Get best times to post |
| analytics.getContentDecay() | Get content performance decay |
| analytics.getDailyMetrics() | Get daily aggregated metrics |
| analytics.getFacebookDemographics() | Get Facebook Page demographics |
| analytics.getFacebookPageInsights() | Get Facebook Page insights |
| analytics.getFacebookPostEarnings() | Get Facebook post monetization earnings |
| analytics.getFacebookPostReactions() | Get Facebook post reactions |
| analytics.getGoogleAnalyticsMetadata() | List Google Analytics (GA4) dimensions and metrics |
| analytics.getGoogleBusinessPerformance() | Get Google Business Profile performance metrics |
| analytics.getGoogleBusinessSearchKeywords() | Get Google Business Profile search keywords |
| analytics.getInstagramAccountInsights() | Get Instagram insights |
| analytics.getInstagramDemographics() | Get Instagram demographics |
| analytics.getInstagramFollowerHistory() | Get Instagram follower history |
| analytics.getInstagramOnlineFollowers() | Get Instagram online followers |
| analytics.getLinkedInAggregateAnalytics() | Get LinkedIn aggregate stats |
| analytics.getLinkedInDemographics() | Get LinkedIn organization follower demographics |
| analytics.getLinkedInOrgAggregateAnalytics() | Get LinkedIn org analytics |
| analytics.getLinkedInPostAnalytics() | Get LinkedIn post stats |
| analytics.getLinkedInPostReactions() | Get LinkedIn post reactions |
| analytics.getPinterestAccountInsights() | Get Pinterest account-level insights |
| analytics.getPostAuthenticity() | Get a post's authenticity score |
| analytics.getPostingFrequency() | Get frequency vs engagement |
| analytics.getPostSamples() | Get post samples |
| analytics.getPostTimeline() | Get post analytics timeline |
| analytics.getTikTokAccountInsights() | Get TikTok account-level insights |
| analytics.getTikTokDemographics() | Get TikTok follower demographics |
| analytics.getTrackingWindow() | Get a tracking window |
| analytics.getYouTubeChannelInsights() | Get YouTube channel insights |
| analytics.getYouTubeDailyViews() | Get YouTube daily views |
| analytics.getYouTubeDemographics() | Get YouTube demographics |
| analytics.getYouTubeVideoRetention() | Get YouTube video retention curve |
| analytics.cancelTrackingWindow() | Cancel a tracking window |
| analytics.inspectGoogleSearchConsoleUrl() | Inspect a URL in Google Search Console |
| analytics.openTrackingWindow() | Open a tracking window |
| analytics.queryGoogleSearchConsoleSearchAnalytics() | Query Google Search Console search analytics |
| analytics.runGoogleAnalyticsRealtimeReport() | Run a Google Analytics (GA4) realtime report |
| analytics.runGoogleAnalyticsReport() | Run a Google Analytics (GA4) report |
| analytics.syncExternalPosts() | Sync an external post |
Account Groups
| Method | Description |
|--------|-------------|
| accountGroups.listAccountGroups() | List groups |
| accountGroups.createAccountGroup() | Create group |
| accountGroups.updateAccountGroup() | Update group |
| accountGroups.deleteAccountGroup() | Delete group |
Queue
| Method | Description |
|--------|-------------|
| queue.listQueueSlots() | List schedules |
| queue.createQueueSlot() | Create schedule |
| queue.getNextQueueSlot() | Get next available slot |
| queue.updateQueueSlot() | Update schedule |
| queue.deleteQueueSlot() | Delete schedule |
| queue.previewQueue() | Preview upcoming slots |
Webhooks
| Method | Description |
|--------|-------------|
| webhooks.createWebhookSettings() | Create webhook |
| webhooks.getWebhookLogs() | List webhook delivery logs |
| webhooks.getWebhookSettings() | List webhooks |
| webhooks.updateWebhookSettings() | Update webhook |
| webhooks.deleteWebhookSettings() | Delete webhook |
| webhooks.redeliverWebhookEvent() | Redeliver a webhook event |
| webhooks.testWebhook() | Send test webhook |
API Keys
| Method | Description |
|--------|-------------|
| apiKeys.listApiKeys() | List keys |
| apiKeys.createApiKey() | Create key |
| apiKeys.deleteApiKey() | Delete key |
| apiKeys.verifyCredential() | Verify credential |
Media
| Method | Description |
|--------|-------------|
| media.getMediaPresignedUrl() | Get upload URL |
| media.prepareMedia() | Prepare media for a platform |
Users
| Method | Description |
|--------|-------------|
| users.listUsers() | List users |
| users.getUser() | Get user |
Usage
| Method | Description |
|--------|-------------|
| usage.getBilling() | Account billing snapshot (plan, cycle, balance, caps, status) |
| usage.getCallsUsage() | Calling usage and cost |
| usage.getSmsUsage() | SMS usage (volumes) |
| usage.getUsage() | Usage snapshot (default) or billed-spend metering (with params) |
| usage.getUsageStats() | Get plan and usage snapshot (plan, limits, payment status) |
| usage.getXApiPricing() | Get X API pricing table |
Logs
| Method | Description |
|--------|-------------|
| logs.listLogs() | List activity logs |
Connect (OAuth)
| Method | Description |
|--------|-------------|
| connect.listFacebookPages() | List Facebook pages |
| connect.listGoogleAnalyticsProperties() | List Google Analytics properties for a pending connect |
| connect.listGoogleBusinessCategories() | List Google Business Profile categories |
| connect.listGoogleBusinessLocations() | List Google Business Profile locations |
| connect.listGoogleSearchConsoleSites() | List Search Console sites for a pending connect |
| connect.listInstagramPages() | List Pages with a linked Instagram account |
| connect.listLinkedInOrganizations() | List LinkedIn orgs |
| connect.listOAuthApps() | List your OAuth apps |
| connect.listOrgConnections() | List organization connections |
| connect.listOrgConnectionUsers() | List an organization's users |
| connect.listPinterestBoardsForSelection() | List Pinterest boards |
| connect.listSlackChannels() | List Slack channels for the channel picker |
| connect.listSnapchatProfiles() | List Snapchat profiles |
| connect.listWhatsAppPhoneNumbers() | List numbers for selection |
| connect.createGoogleBusinessLocation() | Create Google Business Profile location |
| connect.createGoogleOrgConnection() | Start a Google Workspace organization connection |
| connect.createMicrosoftOrgConnection() | Start a Microsoft 365 organization connection |
| connect.createOAuthApp() | Add an OAuth app |
| connect.createPinterestBoard() | Create Pinterest board |
| connect.createPlatformInvite() | Create a connect link |
| connect.createYoutubePlaylist() | Create YouTube playlist |
| connect.getConnectHandoff() | Get a phone handoff |
| connect.getConnectUrl() | Get OAuth connect URL |
| connect.getConnectWelcomeScreen() | Get the saved welcome screen |
| connect.getEmailConnectUrl() | Get a hosted link to connect any mailbox |
| connect.getFacebookPages() | List Facebook pages |
| connect.getGmbLocations() | List Google Business Profile locations |
| connect.getGoogleAnalyticsConnectUrl() | Get Google Analytics OAuth connect URL |
| connect.getGoogleSearchConsoleConnectUrl() | Get Google Search Console OAuth connect URL |
| connect.getHubSpotConnectUrl() | Get HubSpot OAuth connect URL |
| connect.getLinkedInOrganizations() | List LinkedIn orgs |
| connect.getOAuthApp() | Get an OAuth app |
| connect.getOrgConnection() | Get an organization connection |
| connect.getPageWebhookSubscription() | Read an account's webhook subscription |
| connect.getPendingOAuthData() | Get pending OAuth data |
| connect.getPinterestBoards() | List Pinterest boards |
| connect.getRedditFlairs() | List subreddit flairs |
| connect.getRedditSubreddits() | List Reddit subreddits |
| connect.getSalesforceConnectUrl() | Get Salesforce OAuth connect URL |
| connect.getShopifyConnectUrl() | Get Shopify OAuth connect URL |
| connect.getStripeConnectUrl() | Get Stripe connect URL |
| connect.getSubredditRules() | Get subreddit rules |
| connect.getTelegramConnectStatus() | Generate Telegram code |
| connect.getWebflowConnectUrl() | Get Webflow OAuth URL |
| connect.getWechatIpWhitelist() | Get WeChat IP whitelist |
| connect.getWhatsAppSdkConfig() | Get Embedded Signup SDK config |
| connect.getWixConnectUrl() | Get Wix site install URL |
| connect.getWordPressAuthUrl() | Get WordPress.com OAuth connect URL |
| connect.getYoutubeCaptions() | Get a YouTube video transcript |
| connect.getYoutubePlaylists() | List YouTube playlists |
| connect.updateConnectWelcomeScreen() | Save the welcome screen |
| connect.updateFacebookPage() | Update Facebook page |
| connect.updateGmbLocation() | Update Google Business Profile location |
| connect.updateLinkedInOrganization() | Switch LinkedIn account type |
| connect.updateOAuthApp() | Update an OAuth app |
| connect.updateOrgConnection() | Update an organization connection |
| connect.updatePinterestBoards() | Set default Pinterest board |
| connect.updateRedditSubreddits() | Set default subreddit |
| connect.updateYoutubeDefaultPlaylist() | Set default YouTube playlist |
| connect.deleteOAuthApp() | Remove an OAuth app |
| connect.deleteOrgConnection() | Delete an organization connection |
| connect.addOrgConnectionMailbox() | Add a mailbox from an organization connection |
| connect.assignGoogleBusinessLocation() | Assign Google Business Profile location to another profile |
| connect.completeMetaAdsBusinessLogin() | Complete Meta business login |
| connect.completeTelegramConnect() | Check Telegram status |
| connect.completeWhatsAppPhoneSelection() | Complete number selection |
| connect.configureTikTokAdsBrandIdentity() | Set TikTok brand identity |
| connect.connectAds() | Connect ads for a platform |
| connect.connectAppLovinAdsCredentials() | Connect an AppLovin Axon account |
| connect.connectBlueskyCredentials() | Connect Bluesky account |
| connect.connectDiscordChannel() | Connect a Discord channel |
| connect.connectLineCredentials() | Connect LINE Official Account |
| connect.connectOpenAIAdsCredentials() | Connect an OpenAI Ads account |
| connect.connectShopifyWithToken() | Connect a Shopify store with a custom-app Admin token |
| connect.connectSlackChannel() | Connect a Slack channel |
| connect.connectWebflowWithSiteToken() | Connect Webflow with a site API token |
| connect.connectWechatCredentials() | Connect WeChat Official Account |
| connect.connectWhatsAppCredentials() | Connect WhatsApp via credentials |
| connect.connectWhatsAppEmbeddedSignup() | Connect WhatsApp from Embedded Signup |
| connect.connectWhopAdsCredentials() | Connect a Whop account |
| connect.connectWordPressWithApplicationPassword() | Connect self-hosted WordPress with an application password |
| connect.handleOAuthCallback() | Complete OAuth callback |
| connect.initiateTelegramConnect() | Connect Telegram directly |
| connect.resyncPageWebhookSubscription() | Re-subscribe an account to Zernio's webhooks |
| connect.searchGoogleBusinessLocations() | Search existing Google listings |
| connect.selectFacebookPage() | Select Facebook page |
| connect.selectGoogleAnalyticsProperty() | Connect the chosen Google Analytics property |
| connect.selectGoogleBusinessLocation() | Select Google Business Profile location |
| connect.selectGoogleSearchConsoleSite() | Connect the chosen Search Console site |
| connect.selectInstagramAccount() | Select the Page whose Instagram account to connect |
| connect.selectLinkedInOrganization() | Select LinkedIn org |
| connect.selectPinterestBoard() | Select Pinterest board |
| connect.selectSnapchatProfile() | Select Snapchat profile |
| connect.setRedditPostFlair() | Set Reddit post flair |
| connect.startMicrosoftAdminConsent() | Admin-consent link for a Microsoft tenant |
| connect.testOAuthApp() | Check an OAuth app's keys |
| connect.verifyOrgConnection() | Verify an organization connection |
| connect.voteRedditThing() | Vote on a Reddit post or comment |
| Method | Description |
|--------|-------------|
| reddit.getRedditFeed() | Get subreddit feed |
| reddit.getRedditPostComments() | Get the comments of a Reddit post |
| reddit.searchReddit() | Search posts |
Account Settings
| Method | Description |
|--------|-------------|
| accountSettings.getFacebookPageInfo() | Get a Facebook Page's public info |
| accountSettings.getInstagramIceBreakers() | Get IG ice breakers |
| accountSettings.getMessengerGetStarted() | Get FB Get Started button |
| accountSettings.getMessengerGreeting() | Get FB greeting text |
| accountSettings.getMessengerIceBreakers() | Get FB ice breakers |
| accountSettings.getMessengerMenu() | Get persistent menu |
| accountSettings.getTelegramCommands() | Get TG bot commands |
| accountSettings.getWechatServerConfig() | Get WeChat server config |
| accountSettings.updateFacebookPageInfo() | Update a Facebook Page's public info |
| accountSettings.deleteInstagramIceBreakers() | Delete IG ice breakers |
| accountSettings.deleteMessengerGetStarted() | Delete FB Get Started button |
| accountSettings.deleteMessengerGreeting() | Delete FB greeting text |
| accountSettings.deleteMessengerIceBreakers() | Delete FB ice breakers |
| accountSettings.deleteMessengerMenu() | Delete persistent menu |
| accountSettings.deleteTelegramCommands() | Delete TG bot commands |
| accountSettings.setInstagramIceBreakers() | Set IG ice breakers |
| accountSettings.setMessengerGetStarted() | Set FB Get Started button |
| accountSettings.setMessengerGreeting() | Set FB greeting text |
| accountSettings.setMessengerIceBreakers() | Set FB ice breakers |
| accountSettings.setMessengerMenu() | Set persistent menu |
| accountSettings.setTelegramCommands() | Set TG bot commands |
Ad Accounts
| Method | Description |
|--------|-------------|
| adAccounts.listAccountCallouts() | List account callouts |
| adAccounts.listAccountSitelinks() | List account sitelinks |
| adAccounts.listAccountStructuredSnippets() | List account snippets |
| adAccounts.listAdAccounts() | List ad accounts |
| adAccounts.listAdAccountUserInvitationApprovals() | List invitations awaiting multi-party approval |
| adAccounts.listAdAccountUserInvitations() | List user access invitations |
| adAccounts.listAdAccountUsers() | Ad account users |
| adAccounts.listAdLabels() | List ad labels |
| adAccounts.listAdNegativeKeywordLists() | List negative keyword lists |
| adAccounts.listAdsBusinessCenters() | List TikTok Business Centers |
| adAccounts.listAdsInstagramAccounts() | List Instagram ad identities |
| adAccounts.listAdsInstagramPosts() | List Instagram posts to boost |
| adAccounts.listAdStudies() | A/B tests and lift studies |
| adAccounts.listAdvertisableApplications() | List advertisable apps |
| adAccounts.listCustomConversions() | List custom conversions |
| adAccounts.listHighDemandPeriods() | List high-demand periods |
| adAccounts.listMetaBusinesses() | Businesses list |
| adAccounts.listMetaBusinessUsers() | Business users |
| adAccounts.listPageUsers() | Page users of a business |
| adAccounts.listTikTokAdPixels() | List TikTok ad pixels |
| adAccounts.listValueRuleSets() | List value rule sets |
| adAccounts.createAdAccount() | Create ad account |
| adAccounts.createAdLabel() | Create a Google Ads label |
| adAccounts.createAdNegativeKeywordList() | Create a negative keyword list |
| adAccounts.createCustomConversion() | Create custom conversion |
| adAccounts.createHighDemandPeriod() | Schedule a budget increase |
| adAccounts.createValueRuleSet() | Create a value rule set |
| adAccounts.getAdAccountBilling() | Get ad account billing |
| adAccounts.getAdAccountFinance() | Ad account finances |
| adAccounts.getAdAccountHealth() | Check an ad account before creating ads |
| adAccounts.getAdAccountHierarchy() | Get manager account hierarchy |
| adAccounts.getAdAccountLiveEntities() | Read an ad account's campaigns and ad sets live |
| adAccounts.getAdComments() | List comments on an ad |
| adAccounts.getAdNegativeKeywordList() | Get a negative keyword list |
| adAccounts.getAdsActivityLog() | Ad account change / audit log |
| adAccounts.getDsaDefaults() | Get ad account DSA defaults |
| adAccounts.getDsaRecommendations() | Get DSA recommendations |
| adAccounts.getIosFourteenCampaignLimits() | Get iOS 14 campaign limits |
| adAccounts.getValueRuleSet() | Read a value rule set |
| adAccounts.updateAccountCallouts() | Update account callouts |
| adAccounts.updateAccountSitelinks() | Update account sitelinks |
| adAccounts.updateAccountStructuredSnippets() | Update account snippets |
| adAccounts.updateAdAccount() | Update ad account settings |
| adAccounts.updateAdAccountManagerLink() | Accept, decline, cancel or end a manager link |
| adAccounts.updateAdLabel() | Update a Google Ads label |
| adAccounts.updateAdNegativeKeywordList() | Rename a negative keyword list |
| adAccounts.updateValueRuleSet() | Replace a value rule set |
| adAccounts.deleteAdComment() | Delete an ad comment |
| adAccounts.deleteAdNegativeKeywordList() | Delete a negative keyword list |
| adAccounts.deleteValueRuleSet() | Delete a value rule set |
| adAccounts.addAccountCallouts() | Add account callouts |
| adAccounts.addAccountSitelinks() | Add account sitelinks |
| adAccounts.addAccountStructuredSnippets() | Add account snippets |
| adAccounts.assignAdAccountUser() | Assign a user to an ad account |
| adAccounts.assignPageUser() | Assign a user to a Page |
| adAccounts.attachAdLabel() | Attach a Google Ads label |
| adAccounts.detachAdLabel() | Detach a Google Ads label |
| adAccounts.hideAdComment() | Hide or unhide an ad comment |
| adAccounts.inviteAdAccountToManager() | Invite a client account to a manager |
| adAccounts.inviteAdAccountUser() | Invite a user to an ad account by email |
| adAccounts.removeAccountCallout() | Remove account callout |
| adAccounts.removeAccountSitelink() | Remove account sitelink |
| adAccounts.removeAccountStructuredSnippet() | Remove account snippet |
| adAccounts.removeAdAccountUser() | Remove a user from an ad account |
| adAccounts.removeAdLabel() | Remove a Google Ads label |
| adAccounts.removePageUser() | Remove a user from a Page |
| adAccounts.replaceAdNegativeKeywordListKeywords() | Replace negative list keywords |
| adAccounts.replyToAdComment() | Reply to an ad comment |
| adAccounts.revokeAdAccountUserInvitation() | Revoke a user access invitation |
| adAccounts.setUpAdAccountBilling() | Set up ad account billing (monthly invoicing) |
| adAccounts.withdrawAdAccountUserInvitationApproval() | Withdraw an invitation awaiting multi-party approval |
Ad Audiences
| Method | Description |
|--------|-------------|
| adAudiences.listAdAudiences() | List custom audiences |
| adAudiences.createAdAudience() | Create custom audience |
| adAudiences.getAdAudience() | Get audience details |
| adAudiences.updateAdAudience() | Update an audience |
| adAudiences.deleteAdAudience() | Delete custom audience |
| adAudiences.addUsersToAdAudience() | Add users to audience |
| adAudiences.removeUsersFromAdAudience() | Remove users from audience |
| adAudiences.replaceAdAudienceCompanies() | Replace audience companies |
Ad Campaign Results
| Method | Description |
|--------|-------------|
| adCampaignResults.listCampaignResultMetrics() | List your result metrics |
| adCampaignResults.listCampaignResults() | List your results per campaign |
| adCampaignResults.getCampaignResultEvents() | List the events that count as campaign results |
| adCampaignResults.getCampaignResultsTotals() | Get your results totals |
| adCampaignResults.getCampaignResultsUpload() | Check a results upload |
| adCampaignResults.setCampaignResultEvents() | Choose the events that count as campaign results |
| adCampaignResults.setCampaignResultMetric() | Name a result metric or define a formula |
| adCampaignResults.uploadCampaignResults() | Upload your results per campaign |
Ad Campaigns
| Method | Description |
|--------|-------------|
| adCampaigns.listAdCampaigns() | List campaigns |
| adCampaigns.listAdGroupAssets() | List ad-group assets |
| adCampaigns.listAdKeywords() | List Search keywords |
| adCampaigns.listAds() | List ads |
| adCampaigns.listAdsAlerts() | List ads that need attention |
| adCampaigns.listAdsByPerformance() | Rank ads by performance |
| adCampaigns.listAdSets() | List ad sets |
| adCampaigns.listBidStrategies() | List portfolio bid strategies |
| adCampaigns.listCampaignAssets() | List campaign assets |
| adCampaigns.listCampaignNegativeKeywordLists() | List campaign negative lists |
| adCampaigns.listCampaignNegativeKeywords() | List campaign-level negative keywords |
| adCampaigns.listGoogleAssetGroups() | List Performance Max asset groups |
| adCampaigns.listGoogleRecommendations() | List Google Ads recommendations |
| adCampaigns.listSharedBudgets() | List shared budgets |
| adCampaigns.listTikTokSmartPlusReviews() | Review status of every TikTok Smart+ ad of an advertiser |
| adCampaigns.bulkUpdateAdCampaignStatus() | Pause or resume many campaigns |
| adCampaigns.createAdCampaign() | Create a standalone campaign |
| adCampaigns.createAdSet() | Create a standalone ad group |
| adCampaigns.createBidStrategy() | Create portfolio bid strategy |
| adCampaigns.createGoogleAssetGroup() | Create a Performance Max asset group |
| adCampaigns.createSharedBudget() | Create a shared budget |
| adCampaigns.createStandaloneAd() | Create standalone ad |
| adCampaigns.getAd() | Get ad details |
| adCampaigns.getAdCampaignDetails() | Get live campaign details |
| adCampaigns.getAdReview() | Read the platform's review verdict for an ad |
| adCampaigns.getAdSetDetails() | Get live ad-set details |
| adCampaigns.getAdSetTargeting() | Read a Reddit ad group's targeting and schedule |
| adCampaigns.getAdsTimeline() | Get daily account metrics |
| adCampaigns.getAdTree() | Get campaign tree |
| adCampaigns.getCampaignAdSchedule() | Read a campaign's ad schedule (dayparting) |
| adCampaigns.getCampaignBidding() | Read a campaign's current bidding |
| adCampaigns.getCampaignConversionGoals() | Get campaign conversion goals |
| adCampaigns.getCampaignTargeting() | Read a Google campaign's device, location, excluded location, and language targeting |
| adCampaigns.getGoogleAssetGroup() | Get a Performance Max asset group |
| adCampaigns.getTikTokSmartPlusAdReview() | Review status of each creative in a TikTok Smart+ ad |
| adCampaigns.updateAd() | Update ad |
| adCampaigns.updateAdCampaign() | Update a campaign |
| adCampaigns.updateAdCampaignStatus() | Pause or resume a campaign |
| adCampaigns.updateAdGroupAssets() | Update ad-group assets |
| adCampaigns.updateAdKeyword() | Update a Search keyword |
| adCampaigns.updateAdSet() | Update an ad set |
| adCampaigns.updateAdSetStatus() | Pause or resume a single ad set |
| adCampaigns.updateAdStatus() | Pause or resume a single ad |
| adCampaigns.updateBidStrategy() | Update portfolio bid strategy |
| adCampaigns.updateCampaignAdSchedule() | Replace a campaign's ad schedule (dayparting) |
| adCampaigns.updateCampaignAssets() | Update campaign assets |
| adCampaigns.updateCampaignConversionGoals() | Update campaign conversion goals |
| adCampaigns.updateCampaignTargeting() | Edit a Google campaign's device, location, excluded location, or language targeting |
| adCampaigns.updateGoogleAssetGroup() | Update a Performance Max asset group |
| adCampaigns.deleteAd() | Cancel an ad |
| adCampaigns.deleteAdCampaign() | Delete a campaign |
| adCampaigns.deleteAdSet() | Delete an ad set |
| adCampaigns.addAdKeywords() | Add Search ad-group keywords |
| adCampaigns.applyGoogleRecommendations() | Apply Google Ads recommendations |
| adCampaigns.attachAdGroupAssets() | Attach ad-group assets |
| adCampaigns.attachCampaignAssets() | Attach campaign assets |
| adCampaigns.boostPost() | Boost post as ad |
| adCampaigns.dismissAdsAlert() | Dismiss an ads alert |
| adCampaigns.dismissGoogleRecommendations() | Dismiss Google Ads recommendations |
| adCampaigns.duplicateAd() | Duplicate an ad |
| adCampaigns.duplicateAdCampaign() | Duplicate a campaign |
| adCampaigns.duplicateAdSet() | Duplicate an ad set |
| adCampaigns.editGoogleAssetGroupAssets() | Link or unlink asset group assets |
| adCampaigns.removeAdGroupAssets() | Remove ad-group assets |
| adCampaigns.removeAdKeyword() | Remove a Search keyword |
| adCampaigns.removeCampaignAssets() | Remove campaign assets |
| adCampaigns.removeGoogleAssetGroup() | Remove a Performance Max asset group |
| adCampaigns.replaceCampaignNegativeKeywordLists() | Replace campaign negative lists |
| adCampaigns.replaceCampaignNegativeKeywords() | Replace campaign-level negative keywords |
| adCampaigns.replaceGoogleListingGroupFilters() | Replace an asset group's listing-group tree |
Ad Creatives
| Method | Description |
|--------|-------------|
| adCreatives.listAdCreatives() | Creative library |
| adCreatives.listAdImages() | Ad image library |
| adCreatives.listAdsTikTokIdentities() | List TikTok ad identities |
| adCreatives.listAdVideos() | Ad video library |
| adCreatives.listPartnershipAdContent() | List partnership ad content |
| adCreatives.listPartnershipAdPermissions() | List partnership permissions |
| adCreatives.createAdCreative() | Create a standalone creative |
| adCreatives.getAdCreative() | Creative details |
| adCreatives.getAdMedia() | Direct video and image URLs for an ad |
| adCreatives.getAdPreviews() | Render previews of an existing ad |
| adCreatives.getAdVideoStatus() | Get ad video processing status |
| adCreatives.updateAdCreative() | Rename a creative |
| adCreatives.deleteAdCreative() | Delete a creative |
| adCreatives.deleteAdVideo() | Delete an ad video |
| adCreatives.generateAdPreviews() | Render pre-create ad previews |
| adCreatives.setPartnershipAdPermission() | Set partnership permission |
| adCreatives.uploadAdImage() | Upload an ad image from base64 |
| adCreatives.uploadAdVideo() | Upload an ad video |
Ad Insights
| Method | Description |
|--------|-------------|
| adInsights.listLocalServicesLeadConversations() | List lead conversations |
| adInsights.listLocalServicesLeads() | Google Local Services Ads leads |
| adInsights.createAdInsightsReport() | Submit async insights report |
| adInsights.getAdAnalytics() | Get ad analytics |
| adInsights.getAdInsightsReport() | Poll an async insights report run |
| adInsights.getAdsSearchTerms() | Google Ads search terms report |
| adInsights.getCampaignAnalytics() | Get campaign analytics |
| adInsights.getTikTokSmartPlusMaterialReport() | Per-creative performance inside TikTok Smart+ ads |
| adInsights.generateKeywordHistoricalMetrics() | Get historical keyword metrics |
| adInsights.generateKeywordIdeas() | Generate keyword ideas |
| adInsights.queryAdInsights() | Flexible live insights query |
Ad Library
| Method | Description |
|--------|-------------|
| adLibrary.searchAdLibrary() | Search the public Ad Library |
Ad Rules
| Method | Description |
|--------|-------------|
| adRules.listAdAccountRuleAlerts() | List an ad account's open alerts |
| adRules.listAdRuleActivity() | List every change ad rules made |
| adRules.listAdRuleAlerts() | List a rule's alerts |
| adRules.listAdRuleRuns() | List an ad rule's runs |
| adRules.listAdRules() | List ad rules |
| adRules.listAdRuleTemplates() | List ready-made ad rules |
| adRules.createAdRule() | Create an ad rule |
| adRules.getAdRule() | Get an ad rule |
| adRules.getAdRuleHourlyWindows() | Check whether an ad account has hourly windows |
| adRules.updateAdRule() | Update an ad rule |
| adRules.deleteAdRule() | Delete an ad rule |
| adRules.previewAdRule() | Preview an ad rule |
| adRules.undoAdRuleActivity() | Undo a change an ad rule made |
Ad Targeting
| Method | Description |
|--------|-------------|
| adTargeting.getLinkedInBidPricing() | Suggested bid and budget bounds |
| adTargeting.getLinkedInSupplyForecast() | Forecast ad delivery |
| adTargeting.browseAdTargeting() | Browse targeting categories |
| adTargeting.estimateAdReach() | Estimate audience reach |
| adTargeting.searchAdInterests() | Search targeting interests |
| adTargeting.searchAdTargeting() | Search targeting options |
Automations
| Method | Description |
|--------|-------------|
| automations.listAutomationActions() | List automation actions |
| automations.listAutomationApprovals() | List an automation's approval requests |
| automations.listAutomationChecks() | List an automation's checks |
| automations.listAutomations() | List automations |
| automations.listAutomationTemplates() | List automation templates |
| automations.createAutomation() | Create an automation |
| automations.createAutomationTemplate() | Create an automation template |
| automations.getAutomation() | Get an automation |
| automations.getAutomationApproval() | Get an approval request |
| automations.getAutomationCatalog() | Get the automations catalog |
| automations.getAutomationControls() | Get automation controls |
| automations.getAutomationTemplate() | Get an automation template |
| automations.getSharedAutomationTemplate() | Get a shared automation template |
| automations.getZernioAutomationTemplate() | Get a Zernio automation template |
| automations.updateAutomation() | Edit an automation |
| automations.updateAutomationAdAccountControls() | Update one ad account's controls |
| automations.updateAutomationControls() | Turn every ad automation off or on |
| automations.updateAutomationTemplate() | Update an automation template |
| automations.deleteAutomation() | Delete an automation |
| automations.deleteAutomationTemplate() | Delete an automation template |
| automations.activateAutomation() | Turn an automation on |
| automations.approveAutomationApproval() | Approve an approval request |
| automations.backtestAutomation() | Backtest a saved automation |
| automations.backtestAutomationDraft() | Backtest an unsaved automation |
| automations.installAutomationTemplate() | Install an automation template |
| automations.installSharedAutomationTemplate() | Install a shared automation template |
| automations.installZernioAutomationTemplate() | Install a Zernio automation template |
| automations.pauseAutomation() | Turn an automation off |
| automations.previewAutomation() | Preview a saved automation |
| automations.previewAutomationDraft() | Preview an unsaved automation |
| automations.rejectAutomationApproval() | Reject an approval request |
Blogs
| Method | Description |
|--------|-------------|
| blogs.listBlogArticles() | List blog articles |
| blogs.listBlogs() | List blogs |
| blogs.createBlog() | Create a blog |
| blogs.createBlogArticle() | Create a blog article |
| blogs.getBlog() | Get a blog |
| blogs.getBlogArticle() | Get a blog article |
| blogs.updateBlog() | Update a blog |
| blogs.updateBlogArticle() | Update a blog article |
| blogs.deleteBlog() | Delete a blog |
| blogs.deleteBlogArticle() | Delete a blog article |
Branded Calling
| Method | Description |
|--------|-------------|
| brandedCalling.listBrandedCallingCallReasons() | List pre-approved call reasons |
| brandedCalling.listBrandedCallingEnterprises() | List registered businesses |
| brandedCalling.listBrandedCallingIdentities() | List caller identities |
| brandedCalling.listBrandedCallingIdentityNumbers() | List the numbers on a caller identity |
| brandedCalling.createBrandedCallingEnterprise() | Register a business for Branded Calling |
| brandedCalling.createBrandedCallingIdentity() | Create a caller identity |
| brandedCalling.getBrandedCallingEnterprise() | Get a registered business |
| brandedCalling.getBrandedCallingIdentity() | Get a caller identity |
| brandedCalling.updateBrandedCallingIdentity() | Edit or resubmit a caller identity |
| brandedCalling.deleteBrandedCallingEnterprise() | Delete a registered business |
| brandedCalling.deleteBrandedCallingIdentity() | Delete a caller identity |
| brandedCalling.attachBrandedCallingNumbers() | Attach numbers to a verified identity |
| brandedCalling.confirmBrandedCallingAuthorizerEmail() | Confirm the authorizer's code |
| brandedCalling.detachBrandedCallingNumbers() | Detach numbers from an identity |
| brandedCalling.preflightBrandedCallingIdentity() | Dry-run a caller identity before creating it |
| brandedCalling.resendBrandedCallingAuthorizerCode() | Resend the authorizer's code |
| brandedCalling.shareBrandedCallingIdentityForm() | Create a caller identity share link |
Broadcasts
| Method | Description |
|--------|-------------|
| broadcasts.listBroadcastRecipients() | List broadcast recipients |
| broadcasts.listBroadcasts() | List broadcasts |
| broadcasts.createBroadcast() | Create broadcast draft |
| broadcasts.getBroadcast() | Get broadcast details |
| broadcasts.updateBroadcast() | Update broadcast |
| broadcasts.deleteBroadcast() | Delete broadcast |
| broadcasts.addBroadcastRecipients() | Add recipients to a broadcast |
| broadcasts.cancelBroadcast() | Cancel broadcast |
| broadcasts.scheduleBroadcast() | Schedule broadcast for later |
| broadcasts.sendBroadcast() | Send broadcast now |
Business Agent
| Method | Description |
|--------|-------------|
| businessAgent.listBusinessAgentAllowlist() | List allowlisted consumers |
| businessAgent.listBusinessAgentConnectors() | List connectors |
| businessAgent.listBusinessAgentConnectorTools() | List connector tools |
| businessAgent.listBusinessAgentFaqs() | List FAQs |
| businessAgent.listBusinessAgentFiles() | List knowledge files |
| businessAgent.listBusinessAgentSettings() | List agent settings |
| businessAgent.listBusinessAgentSkills() | List skills |
| businessAgent.listBusinessAgentUiSkills() | List UI skills |
| businessAgent.listBusinessAgentWebsites() | List crawled websites |
| businessAgent.createBusinessAgentConnector() | Create a connector |
| businessAgent.createBusinessAgentConnectorTool() | Create a connector tool |
| businessAgent.createBusinessAgentFaq() | Create a FAQ |
| businessAgent.createBusinessAgentSkill() | Create a skill |
| businessAgent.createBusinessAgentUiSkill() | Create a UI skill |
| businessAgent.getBusinessAgentBudget() | Get usage budgets |
| businessAgent.getBusinessAgentBusinessInformation() | Get business information |
| businessAgent.getBusinessAgentConnector() | Get a connector |
| businessAgent.getBusinessAgentConnectorLogs() | Get connector failure logs |
| businessAgent.getBusinessAgentConnectorTool() | Get a connector tool |
| businessAgent.getBusinessAgentEvent() | Get a business event status |
| businessAgent.getBusinessAgentFaq() | Get a FAQ |
| businessAgent.getBusinessAgentFile() | Get a knowledge file |
| businessAgent.getBusinessAgentSkill() | Get a skill |
| businessAgent.getBusinessAgentStatus() | Get agent setup status |
| businessAgent.getBusinessAgentUiSkill() | Get a UI skill |
| businessAgent.getBusinessAgentWebsite() | Get a crawled website |
| businessAgent.updateBusinessAgentConnector() | Update a connector |
| businessAgent.updateBusinessAgentConnectorTool() | Update a connector tool |
| businessAgent.updateBusinessAgentFaq() | Update a FAQ |
| businessAgent.updateBusinessAgentSettings() | Update agent settings |
| businessAgent.updateBusinessAgentSkill() | Update a skill |
| businessAgent.updateBusinessAgentUiSkill() | Update a UI skill |
| businessAgent.updateBusinessAgentWebsite() | Update a crawled website |
| businessAgent.deleteBusinessAgentConnector() | Delete a connector |
| businessAgent.deleteBusinessAgentConnectorTool() | Delete a connector tool |
| businessAgent.deleteBusinessAgentFaq() | Delete a FAQ |
| businessAgent.deleteBusinessAgentFile() | Delete a knowledge file |
| businessAgent.deleteBusinessAgentSkill() | Delete a skill |
| businessAgent.deleteBusinessAgentUiSkill() | Delete a UI skill |
| businessAgent.deleteBusinessAgentWebsite() | Remove a crawled website |
| businessAgent.addBusinessAgentAllowlistEntry() | Allowlist a consumer |
| businessAgent.addBusinessAgentWebsite() | Add a website to crawl |
| businessAgent.onboardBusinessAgent() | Create the agent |
| businessAgent.readBusinessAgentEvals() | Read evaluation data |
| businessAgent.refreshBusinessAgentConnectorTools() | Refresh MCP connector tools |
| businessAgent.removeBusinessAgentAllowlistEntry() | Remove an allowlisted consumer |
| businessAgent.replaceBusinessAgentBudget() | Replace usage budgets |
| businessAgent.replaceBusinessAgentBusinessInformation() | Replace business information |
| businessAgent.resetBusinessAgentBusinessInformation() | Reset business information |
| businessAgent.runBusinessAgentConnectorTool() | Run a connector tool once |
| businessAgent.sendBusinessAgentEvent() | Send a business event |
| businessAgent.sendBusinessAgentTestMessage() | Send a test message |
| businessAgent.setBusinessAgentConnectorCredentials() | Set connector credentials |
| businessAgent.startBusinessAgentEvalRun() | Start an evaluation run |
| businessAgent.uploadBusinessAgentFile() | Upload a knowledge file |
Calendar
| Method | Description |
|--------|-------------|
| calendar.listCalendarEventInstances() | List the occurrences of a recurring event |
| calendar.listCalendarEvents() | List events in a window |
| calendar.listCalendars() | List calendars |
| calendar.createCalendarEvent() | Create an event |
| calendar.getCalendarEvent() | Get an event |
| calendar.updateCalendarEvent() | Update an event |
| calendar.deleteCalendarEvent() | Delete an event |
| calendar.calendarAvailability() | Find meeting slots across accounts |
| calendar.calendarFreeBusy() | Busy blocks for one or more accounts |
| calendar.rsvpCalendarEvent() | Respond to an invitation |
Calls
| Method | Description |
|--------|-------------|
| calls.listCalls() | List all calls (unified history) |
| calls.getCall() | Get a call (any channel) |
| calls.getCallRecording() | Get a call recording |
Changelog
| Method | Description |
|--------|-------------|
| changelog.listChangelog() | List API changelog entries |
Comment Automations
| Method | Description |
|--------|-------------|
| commentAutomations.listCommentAutomationLogs() | List automation logs |
| commentAutomations.listCommentAutomations() | List comment-to-DM automations |
| commentAutomations.createCommentAutomation() | Create comment-to-DM automation |
| commentAutomations.getCommentAutomation() | Get automation details |
| commentAutomations.updateCommentAutomation() | Update automation settings |
| commentAutomations.deleteCommentAutomation() | Delete automation |
Comments (Inbox)
| Method | Description |
|--------|-------------|
| comments.listInboxComments() | List commented posts |
| comments.getInboxPostComments() | Get post comments |
| comments.deleteInboxComment() | Delete comment |
| comments.editInboxComment() | Edit comment |
| comments.hideInboxComment() | Hide comment |
| comments.likeInboxComment() | Like comment |
| comments.likePost() | Like post |
| comments.pinInboxComment() | Pin comment |
| comments.replyToInboxPost() | Reply to comment |
| comments.sendPrivateReplyToComment() | Send private reply |
| comments.setCommentModeration() | Set comment moderation status |
| comments.unhideInboxComment() | Unhide comment |
| comments.unlikeInboxComment() | Unlike comment |
| comments.unlikePost() | Unlike post |
| comments.unpinInboxComment() | Unpin comment |
Commerce
| Method | Description |
|--------|-------------|
| commerce.listCommerceCatalogSyncs() | List catalog syncs |
| commerce.listCommerceChannels() | List sales channels |
| commerce.listCommerceCollectionMetafields() | List collection metafields |
| commerce.listCommerceCollections() | List collections |
| commerce.listCommerceCustomers() | List customers |
| commerce.listCommerceDiscounts() | List discounts |
| commerce.listCommerceInventory() | Get a product's stock |
| commerce.listCommerceLocations() | List locations |
| commerce.listCommerceMarkets() | List markets |
| commerce.listCommerceMenus() | List navigation menus |
| commerce.listCommerceMetaobjectDefinitions() | List metaobject definitions |
| commerce.listCommerceMetaobjects() | List metaobjects of a type |
| commerce.listCommerceOrders() | List orders |
| commerce.listCommercePages() | List pages |
| commerce.listCommercePriceLists() | List price lists |
| commerce.listCommerceProductMetafields() | List product metafields |
| commerce.listCommerceProducts() | List products |
| commerce.listCommerceRedirects() | List URL redirects |
| commerce.createCommerceCatalogSync() | Sync a store into a Meta catalog |
| commerce.createCommerceCollection() | Create a collection |
| commerce.createCommerceDiscount() | Create a discount |
| commerce.createCommerceDraftOrder() | Create a draft order |
| commerce.createCommerceMenu() | Create a navigation menu |
| commerce.createCommerceMetaobject() | Create a metaobject |
| commerce.createCommerceOrderEdit() | Edit an order |
| commerce.createCommercePage() | Create a page |
| commerce.createCommerceProduct() | Create a product |
| commerce.createCommerceProductOptions() | Add options |
| commerce.createCommerceProductVariants() | Add variants |
| commerce.createCommerceRedirect() | Create a URL redirect |
| commerce.createCommerceRefund() | Refund an order |
| commerce.getCommerceCatalogSync() | Get a catalog sync |
| commerce.getCommerceCollection() | Get a collection |
| commerce.getCommerceCustomer() | Get a customer |
| commerce.getCommerceDiscount() | Get a discount |
| commerce.getCommerceDraftOrder() | Get a draft order |
| commerce.getCommerceMenu() | Get a navigation menu |
| commerce.getCommerceMetaobject() | Get a metaobject |
| commerce.getCommerceOrder() | Get an order |
| commerce.getCommercePage() | Get a page |
| commerce.getCommerceProduct() | Get a product |
| commerce.getCommerceStore() | Get a store |
| commerce.updateCommerceCollection() | Update a collection |
| commerce.updateCommerceDiscount() | Update a discount |
| commerce.updateCommerceMenu() | Replace a navigation menu |
| commerce.updateCommerceMetaobject() | Update a metaobject |
| commerce.updateCommerceOrder() | Update an order's shipping address |
| commerce.updateCommercePage() | Update a page |
| commerce.updateCommerceProduct() | Update a product |
| commerce.updateCommerceProductPrices() | Update variant prices |
| commerce.updateCommerceRedirect() | Update a URL redirect |
| commerce.deleteCommerceCatalogSync() | Stop a catalog sync |
| commerce.deleteCommerceCollection() | Delete a collection |
| commerce.deleteCommerceCollectionMetafields() | Delete collection metafields |
| commerce.deleteCommerceDiscount() | Delete a discount |
| commerce.deleteCommerceMarketingActivity() | Delete a marketing activity |
| commerce.deleteCommerceMenu() | Delete a navigation menu |
| commerce.deleteCommerceMetaobject() | Delete a metaobject |
| commerce.deleteCommercePage() | Delete a page |
| commerce.deleteCommercePriceListPrices() | Remove fixed prices |
| commerce.deleteCommerceProductMetafields() | Delete product metafields |
| commerce.deleteCommerceProductOptions() | Delete options |
| commerce.deleteCommerceProductVariants() | Delete variants |
| commerce.deleteCommerceRedirect() | Delete a URL redirect |
| commerce.addCommerceDiscountCodes() | Add codes to a discount |
| commerce.addCommerceMarketingEngagement() | Report daily engagement |
| commerce.addCommerceProductImages() | Add images |
| commerce.cancelCommerceOrder() | Cancel an order |
| commerce.changeCommerceCollectionChannels() | Publish or unpublish a collection |
| commerce.changeCommerceCollectionProducts() | Add or remove products in a collection |
| commerce.changeCommerceInventory() | Set or adjust stock |
| commerce.changeCommerceProductChannels() | Publish or unpublish a product |
| commerce.changeCommerceProductState() | Activate, deactivate, archive or delete products |
| commerce.changeCommerceProductTags() | Add or remove tags in bulk |
| commerce.duplicateCommerceProduct() | Duplicate a product |
| commerce.removeCommerceProductImages() | Remove images |
| commerce.reorderCommerceCollectionProducts() | Reorder products in a collection |
| commerce.reorderCommerceProductImages() | Reorder images |
| commerce.runCommerceCatalogSync() | Run a catalog sync now |
| commerce.sendCommerceDraftOrderInvoice() | Send a draft order invoice |
| commerce.setCommerceCollectionMetafields() | Set collection metafields |
| commerce.setCommerceDiscountActive() | Activate or deactivate a discount |
| commerce.setCommercePriceListPrices() | Set fixed prices |
| commerce.setCommerceProductMetafields() | Set product metafields |
| commerce.upsertCommerceMarketingActivity() | Record a marketing activity |
Connected Apps
| Method | Description |
|--------|-------------|
| connectedApps.listConnectedApps() | List connected apps |
| connectedApps.revokeConnectedApp() | Revoke connected app |
Contacts
| Method | Description |
|--------|-------------|
| contacts.listContactGroups() | List contact groups |
| contacts.listContacts() | List contacts |
| contacts.bulkCreateContacts() | Bulk create contacts |
| contacts.createContact() | Create contact |
| contacts.getContact() | Get contact |
| contacts.getContactChannels() | List channels for a contact |
| contacts.updateContact() | Update contact |
| contacts.deleteContact() | Delete contact |
| contacts.autocompleteContacts() | Search people |
Content Retention
| Method | Description |
|--------|-------------|
| contentRetention.getContentRetention() | Get content retention mode |
| contentRetention.updateContentRetention() | Turn zero content retention on or off |
Conversions
| Method | Description |
|--------|-------------|
| conversions.listAdConversionAssociations() | List associated campaigns |
| conversions.listAdConversionDestinations() | List conversion destinations |
| conversions.listAdConversionGoals() | List account conversion goals |
| conversions.listAdCustomConversions() | List custom conversions |
| conversions.listConversionActions() | List conversion actions |
| conversions.listConversionAssociations() | List associated campaigns |
| conversions.listConversionDestinations() | List conversion destinations |
| conversions.listCustomConversionGoals() | List custom conversion goals |
| conversions.listEventDestinations() | List event destinations |
| conversions.listEventNames() | List stored event names |
| conversions.listEvents() | List stored events |
| conversions.listForwardingRules() | List forwarding rules |
| conversions.listTrackingSites() | List tracking sites |
| conversions.createAdConversionDestination() | Create a conversion destination |
| conversions.createAdCustomConversion() | Create custom conversion |
| conversions.createConversionAction() | Create conversion action |
| conversions.createConversionDestination() | Create a conversion destination |
| conversions.createCustomConversionGoal() | Create a custom conversion goal |
| conversions.createEventDestination() | Add an event destination |
| conversions.createForwardingRule() | Add a forwarding rule |
| conversions.createTrackingSite() | Turn on server-side tracking for a website |
| conversions.getAdConversionDestination() | Get a conversion destination |
| conversions.getAdConversionMetrics() | Get attribution metrics |
| conversions.getConversionDestination() | Get a conversion destination |
| conversions.getConversionMetrics() | Get attribution metrics |
| conversions.getConversionPaths() | List the touch paths that lead to conversions |
| conversions.getConversionsQuality() | Get Event Match Quality |
| conversions.getEvent() | Get one stored event and its deliveries |
| conversions.getEventsOverview() | Get today's tracking overview |
| conversions.getEventsOverviewDaily() | Get daily tracking figures |
| conversions.getLtvCohorts() | Get buyer cohorts by first purchase month and first channel |
| conversions.getTrackingSite() | Get a tracking site |
| conversions.updateAdConversionDestination() | Update a conversion destination |
| conversions.updateAdConversionGoals() | Update account conversion goals |
| conversions.updateConversionAction() | Update a conversion action's settings |
| conversions.updateConversionDestination() | Update a conversion destination |
| conversions.updateCustomConversionGoal() | Update a custom conversion goal |
| conversions.updateForwardingRule() | Change a forwarding rule's API secret |
| conversions.updateTrackingSite() | Update a tracking site |
| conversions.deleteAdConversionDestination() | Delete a conversion destination |
| conversions.deleteConversionDestination() | Delete a conversion destination |
| conversions.deleteEventDestination() | Remove an event destination |
| conversions.deleteForwardingRule() | Remove a forwarding rule |
| conversions.deleteTrackingSite() | Delete a tracking site |
| conversions.addAdConversionAssociations() | Associate campaigns |
| conversions.addConversionAssociations() | Associate campaigns |
| conversions.adjustConversions() | Adjust uploaded conversions |
| conversions.removeAdConversionAssociations() | Remove associated campaigns |
| conversions.removeConversionAssociations() | Remove associated campaigns |
| conversions.removeCustomConversionGoal() | Remove a custom conversion goal |
| conversions.restateEvent() | Change a stored event's value |
| conversions.retractEvent() | Retract a stored event |
| conversions.rotateTrackingSiteKey() | Rotate a tracking site's key |
| conversions.sendConversions() | Send conversion events to one destination (legacy) |
| conversions.sendEvents() | Send events to every destination |
Creator Campaigns
| Method | Description |
|--------|-------------|
| creatorCampaigns.listCampaignDrafts() | List campaign drafts |
| creatorCampaigns.listCampaignLedger() | List campaign ledger |
| creatorCampaigns.listCampaignOrders() | List campaign orders |
| creatorCampaigns.listCampaignParticipants() | List campaign participants |
| creatorCampaigns.listCampaignPayables() | List campaign payables |
| creatorCampaigns.listCampaignPayoutBatches() | List payout batches |
| creatorCampaigns.listCampaignSamples() | List campaign sample requests |
| creatorCampaigns.listCampaignSubmissions() | List campaign submissions |
| creatorCampaigns.listCreatorCampaigns() | List creator campaigns |
| creatorCampaigns.createCampaignAdjustment() | Create campaign adjustment |
| creatorCampaigns.createCampaignInviteLink() | Create campaign invite link |
| creatorCampaigns.createCampaignParticipant() | Invite campaign participant |
| creatorCampaigns.createCampaignPayoutBatch() | Pay creators with one card payment |
| creatorCampaigns.createCreatorCampaign() | Create creator campaign |
| creatorCampaigns.getCampaignAdResults() | Get campaign ad results |
| creatorCampaigns.getCampaignDraft() | Get campaign draft |
| creatorCampaigns.getCampaignParticipant() | Get campaign participant |
| creatorCampaigns.getCampaignReport() | Get campaign report |
| creatorCampaigns.getCampaignSubmission() | Get campaign submission |
| creatorCampaigns.getCreatorCampaign() | Get creator campaign |
| creatorCampaigns.updateCreatorCampaign() | Update creator campaign |
| creatorCampaigns.activateCreatorCampaign() | Activate creator campaign |
| creatorCampaigns.approveCampaignDraft() | Approve campaign draft |
| creatorCampaigns.approveCampaignParticipant() | Approve pending campaign participant |
| creatorCampaigns.approveCampaignSample() | Approve campaign sample request |
| creatorCampaigns.approveCampaignSubmission() | Approve campaign submission |
| creatorCampaigns.closeCreatorCampaign() | Close creator campaign |
| creatorCampaigns.declineCampaignSample() | Decline campaign sample request |
| creatorCampaigns.denyCampaignParticipant() | Deny pending campaign participant |
| creatorCampaigns.launchCampaignAds() | Launch campaign posts as ads |
| creatorCampaigns.moveCampaignParticipant() | Move participant to another campaign |
| creatorCampaigns.pauseCreatorCampaign() | Pause creator campaign |
| creatorCampaigns.previewCampaignPayoutBatch() | Preview a payout batch |
| creatorCampaigns.raiseCreatorCampaignBudget() | Raise creator campaign budget |
| creatorCampaigns.reinstateCampaignParticipant() | Reinstate campaign participant |
| creatorCampaigns.rejectCampaignDraft() | Reject campaign draft |
| creatorCampaigns.rejectCampaignSubmission() | Reject campaign submission |
| creatorCampaigns.removeCampaignParticipant() | Remove campaign participant |
| creatorCampaigns.reopenCampaignSubmission() | Reopen campaign submission |
| creatorCampaigns.requestCampaignDraftRevision() | Request changes on a campaign draft |
| creatorCampaigns.resendCampaignParticipantInvite() | Resend campaign participant invite |
| creatorCampaigns.settleCampaignParticipant() | Settle campaign participant |
| creatorCampaigns.shipCampaignSample() | Mark campaign sample shipped |
| creatorCampaigns.suspendCampaignParticipant() | Suspend campaign participant |
Creator Portal
| Method | Description |
|--------|-------------|
| creatorPortal.createCreatorPayoutLogin() | Open the creator's Stripe dashboard |
| creatorPortal.getCreatorPayouts() | List a creator's earnings history |
| creatorPortal.getCreatorPayoutStatement() | Download a payout statement |
| creatorPortal.getCreatorPortal() | Read a creator invite or participant page |
| creatorPortal.joinCreatorCampaign() | Join a campaign |
| creatorPortal.presignCreatorDraftUpload() | Get an upload URL for a draft |
| creatorPortal.recoverCreatorPortalLinks() | Email a creator their campaign links |
| creatorPortal.removeCreatorAccount() | Remove a connected account |
| creatorPortal.requestCreatorSample() | Request a product sample |
| creatorPortal.setCreatorSparkCode() | Set a post's Spark code |
| creatorPortal.startCreatorConnect() | Start connecting a creator account |
| creatorPortal.startCreatorPayouts() | Start payout onboarding |
| creatorPortal.submitCreatorDraft() | Submit a draft for review |
| creatorPortal.submitCreatorPost() | Submit a post |
CRM
| Method | Description |
|--------|-------------|
| crm.listCrmDeals() | List CRM deals |
| crm.listCrmOwners() | List CRM owners |
| crm.createCrmActivity() | Log a CRM activity |
| crm.createCrmContact() | Create a CRM contact |
| crm.getCrmContact() | Get a CRM contact |
| crm.getCrmDeal() | Get a CRM deal |
| crm.updateCrmContact() | Update a CRM contact |
| crm.updateCrmDeal() | Update a CRM deal |
| crm.searchCrmContacts() | Search CRM contacts |
Custom Fields
| Method | Description |
|--------|-------------|
| customFields.listCustomFields() | List custom field definitions |
| customFields.createCustomField() | Create custom field |
| customFields.updateCustomField() | Update custom field |
| customFields.deleteCustomField() | Delete custom field |
| customFields.clearContactFieldValue() | Clear custom field value |
| customFields.setContactFieldValue() | Set custom field value |
Discord
| Method | Description |
|--------|-------------|
| discord.listDiscordGuildMembers() | List Discord guild members |
| discord.listDiscordGuildRoles() | List Discord guild roles |
| discord.listDiscordPinnedMessages() | List pinned messages |
| discord.listDiscordScheduledEvents() | List Discord scheduled events |
| discord.createDiscordGuildRole() | Create a Discord guild role |
| discord.createDiscordScheduledEvent() | Create a Discord scheduled event |
| discord.createDiscordThread() | Create a Discord public thread |
| discord.getDiscordChannels() | List Discord guild channels |
| discord.getDiscordGuildMember() | Get a Discord guild member |
| discord.getDiscordScheduledEvent() | Get a Discord scheduled event |
| discord.getDiscordSettings() | G
