### Install Zernio Node.js SDK Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Install the SDK using npm. This is the first step to integrate Zernio into your Node.js application. ```bash npm install @zernio/node ``` -------------------------------- ### Quick Start: Publish to Multiple Platforms Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Initialize the SDK and publish a post to several platforms simultaneously. Assumes ZERNIO_API_KEY environment variable is set. ```typescript 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!`); ``` -------------------------------- ### Get Media Presigned URL Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Retrieves a presigned URL for uploading media files. This is the first step in uploading media to be used in posts. ```APIDOC ## media.getMediaPresignedUrl() ### Description Gets a presigned URL for uploading media. This allows direct uploads to cloud storage before associating the media with a post. ### Method `getMediaPresignedUrl(options)` ### Parameters #### Request Body - **body** (object) - Required - Media details for presigned URL generation. - **filename** (string) - Required - The name of the file to be uploaded. - **contentType** (string) - Required - The MIME type of the file (e.g., 'video/mp4'). ### Request Example ```typescript await zernio.media.getMediaPresignedUrl({ body: { filename: 'video.mp4', contentType: 'video/mp4' }, }); ``` ### Response #### Success Response (200) - **data** (object) - Contains presigned URL information. - **uploadUrl** (string) - The URL to upload the media to. - **publicUrl** (string) - The public URL of the uploaded media. ``` -------------------------------- ### Get Post Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Retrieves details for a specific post. ```APIDOC ## posts.getPost() ### Description Retrieves the details of a specific post using its ID. ### Method `getPost(options)` ### Parameters #### Request Body - **body** (object) - Required - Post identifier. - **postId** (string) - Required - The ID of the post to retrieve. ### Response #### Success Response (200) - **data** (object) - Contains the details of the requested post. ``` -------------------------------- ### OAuth Connection Management Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing OAuth connections, including getting URLs, handling callbacks, and retrieving pending data. ```APIDOC ## OAuth Connection Management ### Description Methods for initiating and managing OAuth connections, including obtaining connection URLs, handling callbacks, and retrieving pending OAuth data. ### Methods - `connect.getConnectUrl()` - `connect.handleOAuthCallback()` - `connect.getPendingOAuthData()` ``` -------------------------------- ### Get Analytics Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Retrieves analytics data for a specific post. ```APIDOC ## analytics.getAnalytics() ### Description Retrieves analytics data for a given post, including views, likes, and engagement rate. ### Method `getAnalytics(options)` ### Parameters #### Query Parameters - **query** (object) - Required - Parameters for fetching analytics. - **postId** (string) - Required - The ID of the post to retrieve analytics for. ### Request Example ```typescript await zernio.analytics.getAnalytics({ query: { postId: 'post_xxx' }, }); ``` ### Response #### Success Response (200) - **data** (object) - Contains the analytics data. - **analytics** (object) - An object containing various analytics metrics. - **views** (number) - The number of views. - **likes** (number) - The number of likes. - **engagementRate** (number) - The engagement rate. ``` -------------------------------- ### Account Settings Management Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing account settings related to Instagram, Messenger, and Telegram, including getting and setting ice breakers, menus, and commands. ```APIDOC ## Account Settings Management ### Description Manages account-specific settings for various platforms, including Instagram ice breakers, Facebook Messenger menus, and Telegram bot commands. Supports getting, setting, and deleting these configurations. ### Methods - `accountSettings.getInstagramIceBreakers()` - `accountSettings.setInstagramIceBreakers()` - `accountSettings.deleteInstagramIceBreakers()` - `accountSettings.getMessengerMenu()` - `accountSettings.setMessengerMenu()` - `accountSettings.deleteMessengerMenu()` - `accountSettings.getTelegramCommands()` - `accountSettings.setTelegramCommands()` - `accountSettings.deleteTelegramCommands()` ``` -------------------------------- ### Configure Zernio SDK with Options Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Initialize the Zernio SDK with custom configuration options like API key, base URL, and timeout. Useful for overriding environment variables or setting specific API endpoints. ```typescript const zernio = new Zernio({ apiKey: 'your-api-key', // Defaults to process.env['ZERNIO_API_KEY'] baseURL: 'https://zernio.com/api', timeout: 60000, }); ``` -------------------------------- ### Upload Media for Posts Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Upload media files by first obtaining a presigned URL, uploading the file, and then referencing the media URL in the post creation. Supports various media types like videos and images. ```typescript // 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, }, }); ``` -------------------------------- ### GMB Place Actions API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing action links on a Google Business Profile. ```APIDOC ## gmbPlaceActions.listGoogleBusinessPlaceActions() ### Description List action links for a Google Business Profile. ### Method APICALL ### Endpoint gmbPlaceActions/listGoogleBusinessPlaceActions ``` ```APIDOC ## gmbPlaceActions.createGoogleBusinessPlaceAction() ### Description Create an action link for a Google Business Profile. ### Method APICALL ### Endpoint gmbPlaceActions/createGoogleBusinessPlaceAction ``` ```APIDOC ## gmbPlaceActions.updateGoogleBusinessPlaceAction() ### Description Update an action link for a Google Business Profile. ### Method APICALL ### Endpoint gmbPlaceActions/updateGoogleBusinessPlaceAction ``` ```APIDOC ## gmbPlaceActions.deleteGoogleBusinessPlaceAction() ### Description Delete an action link from a Google Business Profile. ### Method APICALL ### Endpoint gmbPlaceActions/deleteGoogleBusinessPlaceAction ``` -------------------------------- ### Connect Pinterest Boards Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Provides methods to list, select, and update Pinterest boards. ```APIDOC ## Connect Pinterest Boards ### Description Methods for managing Pinterest board connections, including listing, selecting, and updating boards. ### Methods - `connect.listPinterestBoardsForSelection()` - `connect.selectPinterestBoard()` - `connect.updatePinterestBoards()` - `connect.getPinterestBoards()` ``` -------------------------------- ### Usage API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for retrieving usage statistics and pricing information. ```APIDOC ## Usage ### `usage.getUsageStats()` #### Description Get plan and usage stats. ### `usage.getXApiPricing()` #### Description Get X/Twitter API pricing table. ``` -------------------------------- ### Invites Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Create invite tokens for the Zernio platform. ```APIDOC ## invites.createInviteToken() ### Description Create invite token. ### Method APIDOC ### Endpoint APIDOC ``` -------------------------------- ### Schedule a Post for Future Publication Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Create a post that will be published at a specific future date and time. Ensure the `scheduledFor` timestamp is in ISO 8601 format. ```typescript 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', }, }); ``` -------------------------------- ### Queue API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing scheduled queue slots. ```APIDOC ## Queue ### `queue.listQueueSlots()` #### Description List schedules. ### `queue.createQueueSlot()` #### Description Create schedule. ### `queue.getNextQueueSlot()` #### Description Get next available slot. ### `queue.updateQueueSlot()` #### Description Update schedule. ### `queue.deleteQueueSlot()` #### Description Delete schedule. ### `queue.previewQueue()` #### Description Preview upcoming slots. ``` -------------------------------- ### Logs API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for retrieving activity logs. ```APIDOC ## Logs ### `logs.listLogs()` #### Description List activity logs. ``` -------------------------------- ### WhatsApp Templates Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Retrieve information about library templates for WhatsApp. ```APIDOC ## whatsappTemplates.getWhatsAppLibraryTemplate() ### Description Look up a library template. ### Method APIDOC ### Endpoint APIDOC ``` -------------------------------- ### Customize Content Per Platform Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Publish a single post to multiple platforms while providing unique content for each. This allows tailoring messages to specific platform audiences. ```typescript 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, }, }); ``` -------------------------------- ### List Posts Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Lists all posts associated with the account. ```APIDOC ## posts.listPosts() ### Description Lists all posts created through the Zernio SDK. ### Method `listPosts()` ### Response #### Success Response (200) - **data** (object) - Contains a list of posts. ``` -------------------------------- ### WhatsApp Sandbox Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Manage WhatsApp sandbox sessions for testing and activation. ```APIDOC ## whatsappSandbox.listWhatsAppSandboxSessions() ### Description List your sandbox sessions. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## whatsappSandbox.createWhatsAppSandboxSession() ### Description Start a sandbox activation for a phone. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## whatsappSandbox.deleteWhatsAppSandboxSession() ### Description Revoke a sandbox session. ### Method APIDOC ### Endpoint APIDOC ``` -------------------------------- ### Users API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing and retrieving user information. ```APIDOC ## Users ### `users.listUsers()` #### Description List users. ### `users.getUser()` #### Description Get user. ``` -------------------------------- ### GMB Media API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing media (photos) associated with a Google Business Profile. ```APIDOC ## gmbMedia.listGoogleBusinessMedia() ### Description List media associated with a Google Business Profile. ### Method APICALL ### Endpoint gmbMedia/listGoogleBusinessMedia ``` ```APIDOC ## gmbMedia.createGoogleBusinessMedia() ### Description Upload a photo to a Google Business Profile. ### Method APICALL ### Endpoint gmbMedia/createGoogleBusinessMedia ``` ```APIDOC ## gmbMedia.deleteGoogleBusinessMedia() ### Description Delete a photo from a Google Business Profile. ### Method APICALL ### Endpoint gmbMedia/deleteGoogleBusinessMedia ``` -------------------------------- ### Webhooks API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for configuring and managing webhooks. ```APIDOC ## Webhooks ### `webhooks.createWebhookSettings()` #### Description Create webhook. ### `webhooks.getWebhookSettings()` #### Description List webhooks. ### `webhooks.updateWebhookSettings()` #### Description Update webhook. ### `webhooks.deleteWebhookSettings()` #### Description Delete webhook. ### `webhooks.testWebhook()` #### Description Send test webhook. ``` -------------------------------- ### GMB Food Menus API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing Google Business Profile food menus. ```APIDOC ## gmbFoodMenus.getGoogleBusinessFoodMenus() ### Description Get food menus for a Google Business Profile. ### Method APICALL ### Endpoint gmbFoodMenus/getGoogleBusinessFoodMenus ``` ```APIDOC ## gmbFoodMenus.updateGoogleBusinessFoodMenus() ### Description Update food menus for a Google Business Profile. ### Method APICALL ### Endpoint gmbFoodMenus/updateGoogleBusinessFoodMenus ``` -------------------------------- ### Profiles API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing and retrieving information about profiles. ```APIDOC ## Profiles ### `profiles.listProfiles()` #### Description List profiles. ### `profiles.createProfile()` #### Description Create profile. ### `profiles.getProfile()` #### Description Get profile. ### `profiles.updateProfile()` #### Description Update profile. ### `profiles.deleteProfile()` #### Description Delete profile. ``` -------------------------------- ### Bulk Upload Posts Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Allows for bulk uploading of posts from a CSV file. ```APIDOC ## posts.bulkUploadPosts() ### Description Enables bulk uploading of posts by providing data in a CSV format. ### Method `bulkUploadPosts()` ### Response #### Success Response (200) - **data** (object) - Confirmation of bulk upload. ``` -------------------------------- ### API Keys API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing API keys. ```APIDOC ## API Keys ### `apiKeys.listApiKeys()` #### Description List keys. ### `apiKeys.createApiKey()` #### Description Create key. ### `apiKeys.deleteApiKey()` #### Description Delete key. ``` -------------------------------- ### Workflows Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Manage workflows, including listing executions, events, and versions, as well as creating, retrieving, updating, deleting, activating, pausing, and triggering workflows. ```APIDOC ## workflows.listWorkflowExecutionEvents() ### Description Get an execution's timeline. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.listWorkflowExecutions() ### Description List workflow runs. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.listWorkflows() ### Description List workflows. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.listWorkflowVersions() ### Description List a workflow's version history. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.createWorkflow() ### Description Create workflow. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.getWorkflow() ### Description Get workflow with graph. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.getWorkflowVersion() ### Description Get a specific workflow version. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.updateWorkflow() ### Description Update workflow. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.deleteWorkflow() ### Description Delete workflow. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.activateWorkflow() ### Description Activate workflow. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.duplicateWorkflow() ### Description Duplicate a workflow. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.pauseWorkflow() ### Description Pause workflow. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.restoreWorkflowVersion() ### Description Restore a previous workflow version. ### Method APIDOC ### Endpoint APIDOC ``` ```APIDOC ## workflows.triggerWorkflow() ### Description Manually start a workflow run. ### Method APIDOC ### Endpoint APIDOC ``` -------------------------------- ### GMB Services API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for retrieving and updating services offered on a Google Business Profile. ```APIDOC ## gmbServices.getGoogleBusinessServices() ### Description Get services offered on a Google Business Profile. ### Method APICALL ### Endpoint gmbServices/getGoogleBusinessServices ``` ```APIDOC ## gmbServices.updateGoogleBusinessServices() ### Description Replace services offered on a Google Business Profile. ### Method APICALL ### Endpoint gmbServices/updateGoogleBusinessServices ``` -------------------------------- ### Media API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for media-related operations. ```APIDOC ## Media ### `media.getMediaPresignedUrl()` #### Description Get upload URL. ``` -------------------------------- ### GMB Verifications API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing the verification state and options for a Google Business Profile. ```APIDOC ## gmbVerifications.getGoogleBusinessVerifications() ### Description Get the verification state for a Google Business Profile. ### Method APICALL ### Endpoint gmbVerifications/getGoogleBusinessVerifications ``` ```APIDOC ## gmbVerifications.completeGoogleBusinessVerification() ### Description Complete a verification process for a Google Business Profile. ### Method APICALL ### Endpoint gmbVerifications/completeGoogleBusinessVerification ``` ```APIDOC ## gmbVerifications.fetchGoogleBusinessVerificationOptions() ### Description Fetch available verification options for a Google Business Profile. ### Method APICALL ### Endpoint gmbVerifications/fetchGoogleBusinessVerificationOptions ``` ```APIDOC ## gmbVerifications.startGoogleBusinessVerification() ### Description Start a verification process for a Google Business Profile. ### Method APICALL ### Endpoint gmbVerifications/startGoogleBusinessVerification ``` -------------------------------- ### Sequences Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing sequences, including enrollments, creation, retrieval, updates, deletion, activation, pausing, and unenrollment. ```APIDOC ## sequences.listSequenceEnrollments() ### Description List enrollments for a sequence. ### Method APICALL ### Endpoint sequences.listSequenceEnrollments ### Parameters None ### Request Example None ### Response #### Success Response (200) - **enrollments** (array) - List of enrollments ``` ```APIDOC ## sequences.listSequences() ### Description List sequences. ### Method APICALL ### Endpoint sequences.listSequences ### Parameters None ### Request Example None ### Response #### Success Response (200) - **sequences** (array) - List of sequences ``` ```APIDOC ## sequences.createSequence() ### Description Create sequence. ### Method APICALL ### Endpoint sequences.createSequence ### Parameters None ### Request Example None ### Response #### Success Response (200) - **sequence** (object) - Details of the created sequence ``` ```APIDOC ## sequences.getSequence() ### Description Get sequence with steps. ### Method APICALL ### Endpoint sequences.getSequence ### Parameters None ### Request Example None ### Response #### Success Response (200) - **sequence** (object) - Details of the sequence with its steps ``` ```APIDOC ## sequences.updateSequence() ### Description Update sequence. ### Method APICALL ### Endpoint sequences.updateSequence ### Parameters None ### Request Example None ### Response #### Success Response (200) - **sequence** (object) - Updated sequence details ``` ```APIDOC ## sequences.deleteSequence() ### Description Delete sequence. ### Method APICALL ### Endpoint sequences.deleteSequence ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the deletion was successful ``` ```APIDOC ## sequences.activateSequence() ### Description Activate sequence. ### Method APICALL ### Endpoint sequences.activateSequence ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the activation was successful ``` ```APIDOC ## sequences.enrollContacts() ### Description Enroll contacts in a sequence. ### Method APICALL ### Endpoint sequences.enrollContacts ### Parameters None ### Request Example None ### Response #### Success Response (200) - **enrollment_results** (array) - Results of the enrollment process ``` ```APIDOC ## sequences.pauseSequence() ### Description Pause sequence. ### Method APICALL ### Endpoint sequences.pauseSequence ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the sequence was paused ``` ```APIDOC ## sequences.unenrollContact() ### Description Unenroll contact. ### Method APICALL ### Endpoint sequences.unenrollContact ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the contact was unenrolled ``` -------------------------------- ### Accounts API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing and retrieving information about accounts. ```APIDOC ## Accounts ### `accounts.getAllAccountsHealth()` #### Description Check accounts health. ### `accounts.listAccounts()` #### Description List accounts. ### `accounts.getAccountHealth()` #### Description Check account health. ### `accounts.getFollowerStats()` #### Description Get follower stats. ### `accounts.getGoogleBusinessReviews()` #### Description Get reviews. ### `accounts.getLinkedInMentions()` #### Description Resolve LinkedIn mention. ### `accounts.getTikTokCreatorInfo()` #### Description Get TikTok creator info. ### `accounts.updateAccount()` #### Description Update account. ### `accounts.deleteAccount()` #### Description Disconnect account. ### `accounts.deleteGoogleBusinessReviewReply()` #### Description Delete a review reply. ### `accounts.batchGetGoogleBusinessReviews()` #### Description Batch get reviews. ### `accounts.moveAccountToProfile()` #### Description Move account to a different profile. ### `accounts.replyToGoogleBusinessReview()` #### Description Reply to a review. ``` -------------------------------- ### Ads Connection Management Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for connecting ads for a platform and connecting specific ad credentials. ```APIDOC ## Ads Connection Management ### Description Methods for connecting ads across different platforms and managing specific ad credentials. ### Methods - `connect.connectAds()` - `connect.connectBlueskyCredentials()` - `connect.connectWhatsAppCredentials()` ``` -------------------------------- ### Telegram Connection Management Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for initiating, completing, and checking the status of Telegram connections. ```APIDOC ## Telegram Connection Management ### Description Methods for managing Telegram connections, including initiating the connection process, completing it, and checking its status. ### Methods - `connect.initiateTelegramConnect()` - `connect.completeTelegramConnect()` - `connect.getTelegramConnectStatus()` ``` -------------------------------- ### WhatsApp Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing WhatsApp features, including conversions, group chats, join requests, datasets, templates, business profiles, display names, and sending conversion events. ```APIDOC ## whatsapp.listWhatsAppConversions() ### Description List recent WhatsApp conversion events. ### Method APICALL ### Endpoint whatsapp.listWhatsAppConversions ### Parameters None ### Request Example None ### Response #### Success Response (200) - **conversions** (array) - List of conversion events ``` ```APIDOC ## whatsapp.listWhatsAppGroupChats() ### Description List active groups. ### Method APICALL ### Endpoint whatsapp.listWhatsAppGroupChats ### Parameters None ### Request Example None ### Response #### Success Response (200) - **group_chats** (array) - List of active group chats ``` ```APIDOC ## whatsapp.listWhatsAppGroupJoinRequests() ### Description List join requests. ### Method APICALL ### Endpoint whatsapp.listWhatsAppGroupJoinRequests ### Parameters None ### Request Example None ### Response #### Success Response (200) - **join_requests** (array) - List of join requests ``` ```APIDOC ## whatsapp.createWhatsAppDataset() ### Description Provision CTWA conversions dataset. ### Method APICALL ### Endpoint whatsapp.createWhatsAppDataset ### Parameters None ### Request Example None ### Response #### Success Response (200) - **dataset** (object) - Details of the created dataset ``` ```APIDOC ## whatsapp.createWhatsAppGroupChat() ### Description Create group. ### Method APICALL ### Endpoint whatsapp.createWhatsAppGroupChat ### Parameters None ### Request Example None ### Response #### Success Response (200) - **group_chat** (object) - Details of the created group chat ``` ```APIDOC ## whatsapp.createWhatsAppGroupInviteLink() ### Description Create invite link. ### Method APICALL ### Endpoint whatsapp.createWhatsAppGroupInviteLink ### Parameters None ### Request Example None ### Response #### Success Response (200) - **invite_link** (string) - The generated invite link ``` ```APIDOC ## whatsapp.createWhatsAppTemplate() ### Description Create template. ### Method APICALL ### Endpoint whatsapp.createWhatsAppTemplate ### Parameters None ### Request Example None ### Response #### Success Response (200) - **template** (object) - Details of the created template ``` ```APIDOC ## whatsapp.getWhatsAppBusinessProfile() ### Description Get business profile. ### Method APICALL ### Endpoint whatsapp.getWhatsAppBusinessProfile ### Parameters None ### Request Example None ### Response #### Success Response (200) - **profile** (object) - Business profile details ``` ```APIDOC ## whatsapp.getWhatsAppDataset() ### Description Get CTWA conversions dataset. ### Method APICALL ### Endpoint whatsapp.getWhatsAppDataset ### Parameters None ### Request Example None ### Response #### Success Response (200) - **dataset** (object) - Dataset details ``` ```APIDOC ## whatsapp.getWhatsAppDisplayName() ### Description Get display name status. ### Method APICALL ### Endpoint whatsapp.getWhatsAppDisplayName ### Parameters None ### Request Example None ### Response #### Success Response (200) - **status** (string) - Status of the display name ``` ```APIDOC ## whatsapp.getWhatsAppGroupChat() ### Description Get group info. ### Method APICALL ### Endpoint whatsapp.getWhatsAppGroupChat ### Parameters None ### Request Example None ### Response #### Success Response (200) - **group_chat** (object) - Group chat information ``` ```APIDOC ## whatsapp.getWhatsAppTemplate() ### Description Get template. ### Method APICALL ### Endpoint whatsapp.getWhatsAppTemplate ### Parameters None ### Request Example None ### Response #### Success Response (200) - **template** (object) - Template details ``` ```APIDOC ## whatsapp.getWhatsAppTemplates() ### Description List templates. ### Method APICALL ### Endpoint whatsapp.getWhatsAppTemplates ### Parameters None ### Request Example None ### Response #### Success Response (200) - **templates** (array) - List of templates ``` ```APIDOC ## whatsapp.updateWhatsAppBusinessProfile() ### Description Update business profile. ### Method APICALL ### Endpoint whatsapp.updateWhatsAppBusinessProfile ### Parameters None ### Request Example None ### Response #### Success Response (200) - **profile** (object) - Updated business profile details ``` ```APIDOC ## whatsapp.updateWhatsAppDisplayName() ### Description Request display name change. ### Method APICALL ### Endpoint whatsapp.updateWhatsAppDisplayName ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the request was successful ``` ```APIDOC ## whatsapp.updateWhatsAppGroupChat() ### Description Update group settings. ### Method APICALL ### Endpoint whatsapp.updateWhatsAppGroupChat ### Parameters None ### Request Example None ### Response #### Success Response (200) - **group_chat** (object) - Updated group chat details ``` ```APIDOC ## whatsapp.updateWhatsAppTemplate() ### Description Update template. ### Method APICALL ### Endpoint whatsapp.updateWhatsAppTemplate ### Parameters None ### Request Example None ### Response #### Success Response (200) - **template** (object) - Updated template details ``` ```APIDOC ## whatsapp.deleteWhatsAppGroupChat() ### Description Delete group. ### Method APICALL ### Endpoint whatsapp.deleteWhatsAppGroupChat ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the group was deleted ``` ```APIDOC ## whatsapp.deleteWhatsAppTemplate() ### Description Delete template. ### Method APICALL ### Endpoint whatsapp.deleteWhatsAppTemplate ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the template was deleted ``` ```APIDOC ## whatsapp.addWhatsAppGroupParticipants() ### Description Add participants. ### Method APICALL ### Endpoint whatsapp.addWhatsAppGroupParticipants ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if participants were added ``` ```APIDOC ## whatsapp.approveWhatsAppGroupJoinRequests() ### Description Approve join requests. ### Method APICALL ### Endpoint whatsapp.approveWhatsAppGroupJoinRequests ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if join requests were approved ``` ```APIDOC ## whatsapp.rejectWhatsAppGroupJoinRequests() ### Description Reject join requests. ### Method APICALL ### Endpoint whatsapp.rejectWhatsAppGroupJoinRequests ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if join requests were rejected ``` ```APIDOC ## whatsapp.removeWhatsAppGroupParticipants() ### Description Remove participants. ### Method APICALL ### Endpoint whatsapp.removeWhatsAppGroupParticipants ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if participants were removed ``` ```APIDOC ## whatsapp.sendWhatsAppConversion() ### Description Send WhatsApp conversion event. ### Method APICALL ### Endpoint whatsapp.sendWhatsAppConversion ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the conversion event was sent ``` ```APIDOC ## whatsapp.uploadWhatsAppProfilePhoto() ### Description Upload profile picture. ### Method APICALL ### Endpoint whatsapp.uploadWhatsAppProfilePhoto ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the profile photo was uploaded ``` -------------------------------- ### Reviews (Inbox) Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing inbox reviews and replies. ```APIDOC ## reviews.listInboxReviews() ### Description List reviews. ### Method APICALL ### Endpoint reviews.listInboxReviews ### Parameters None ### Request Example None ### Response #### Success Response (200) - **reviews** (array) - List of reviews ``` ```APIDOC ## reviews.deleteInboxReviewReply() ### Description Delete review reply. ### Method APICALL ### Endpoint reviews.deleteInboxReviewReply ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the deletion was successful ``` ```APIDOC ## reviews.replyToInboxReview() ### Description Reply to review. ### Method APICALL ### Endpoint reviews.replyToInboxReview ### Parameters None ### Request Example None ### Response #### Success Response (200) - **reply** (object) - Details of the reply ``` -------------------------------- ### Connect Snapchat Profiles Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Provides methods to list and select Snapchat profiles. ```APIDOC ## Connect Snapchat Profiles ### Description Methods for managing Snapchat profile connections, including listing and selecting profiles. ### Methods - `connect.listSnapchatProfiles()` - `connect.selectSnapchatProfile()` ``` -------------------------------- ### Validate Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for validating various inputs such as media URLs, post content, post length, and subreddit existence. ```APIDOC ## validate.validateMedia() ### Description Validate media URL. ### Method APICALL ### Endpoint validate.validateMedia ### Parameters None ### Request Example None ### Response #### Success Response (200) - **is_valid** (boolean) - Indicates if the media URL is valid ``` ```APIDOC ## validate.validatePost() ### Description Validate post content. ### Method APICALL ### Endpoint validate.validatePost ### Parameters None ### Request Example None ### Response #### Success Response (200) - **is_valid** (boolean) - Indicates if the post content is valid ``` ```APIDOC ## validate.validatePostLength() ### Description Validate character count. ### Method APICALL ### Endpoint validate.validatePostLength ### Parameters None ### Request Example None ### Response #### Success Response (200) - **is_valid** (boolean) - Indicates if the post length is valid ``` ```APIDOC ## validate.validateSubreddit() ### Description Check subreddit existence. ### Method APICALL ### Endpoint validate.validateSubreddit ### Parameters None ### Request Example None ### Response #### Success Response (200) - **exists** (boolean) - Indicates if the subreddit exists ``` -------------------------------- ### Create Post Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Creates a new social media post. This method can be used to publish immediately, schedule for a future time, or include platform-specific content. ```APIDOC ## posts.createPost() ### Description Creates a new social media post, with options for immediate publishing, scheduling, and platform-specific content. ### Method `createPost(options)` ### Parameters #### Request Body - **body** (object) - Required - The post details. - **content** (string) - Required - The main content of the post. - **platforms** (array) - Required - An array of platform objects specifying where to post. - **platform** (string) - Required - The platform name (e.g., 'twitter', 'instagram'). - **accountId** (string) - Required - The ID of the account on the platform. - **platformSpecificContent** (string) - Optional - Content tailored for a specific platform. - **youtubeTitle** (string) - Optional - Title for YouTube posts. - **publishNow** (boolean) - Optional - If true, publishes the post immediately. - **scheduledFor** (string) - Optional - The date and time to schedule the post for, in ISO 8601 format. - **mediaUrls** (array) - Optional - An array of URLs for media to include in the post. ### Request Example ```typescript await zernio.posts.createPost({ body: { content: 'Hello world!', platforms: [ { platform: 'twitter', accountId: 'acc_xxx' }, { platform: 'instagram', accountId: 'acc_zzz' }, ], publishNow: true, }, }); ``` ### Response #### Success Response (200) - **data** (object) - Contains the created post details. - **platforms** (array) - Details of the platforms the post was published to. ``` -------------------------------- ### Account Groups API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing account groups. ```APIDOC ## Account Groups ### `accountGroups.listAccountGroups()` #### Description List groups. ### `accountGroups.createAccountGroup()` #### Description Create group. ### `accountGroups.updateAccountGroup()` #### Description Update group. ### `accountGroups.deleteAccountGroup()` #### Description Delete group. ``` -------------------------------- ### Connect Google Business Locations Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Provides methods to list and select Google Business Profile locations. ```APIDOC ## Connect Google Business Locations ### Description Methods for managing Google Business Profile location connections, including listing and selecting locations. ### Methods - `connect.listGoogleBusinessLocations()` - `connect.selectGoogleBusinessLocation()` - `connect.getGmbLocations()` ``` -------------------------------- ### Connect WhatsApp Phone Numbers Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Provides methods to list and complete WhatsApp phone number selection. ```APIDOC ## Connect WhatsApp Phone Numbers ### Description Methods for managing WhatsApp phone number connections, including listing and completing selection. ### Methods - `connect.listWhatsAppPhoneNumbers()` - `connect.completeWhatsAppPhoneSelection()` ``` -------------------------------- ### GMB Attributes API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing Google Business Profile attributes. ```APIDOC ## gmbAttributes.getGoogleBusinessAttributes() ### Description Get attributes for a Google Business Profile. ### Method APICALL ### Endpoint gmbAttributes/getGoogleBusinessAttributes ``` ```APIDOC ## gmbAttributes.updateGoogleBusinessAttributes() ### Description Update attributes for a Google Business Profile. ### Method APICALL ### Endpoint gmbAttributes/updateGoogleBusinessAttributes ``` -------------------------------- ### Connect Facebook Pages Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Provides methods to list, select, and update Facebook pages for integration. ```APIDOC ## Connect Facebook Pages ### Description Methods for managing Facebook page connections, including listing, selecting, and updating pages. ### Methods - `connect.listFacebookPages()` - `connect.selectFacebookPage()` - `connect.updateFacebookPage()` - `connect.getFacebookPages()` ``` -------------------------------- ### GMB Location Details API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for retrieving and updating Google Business Profile location details. ```APIDOC ## gmbLocationDetails.getGoogleBusinessLocationDetails() ### Description Get location details for a Google Business Profile. ### Method APICALL ### Endpoint gmbLocationDetails/getGoogleBusinessLocationDetails ``` ```APIDOC ## gmbLocationDetails.updateGoogleBusinessLocationDetails() ### Description Update location details for a Google Business Profile. ### Method APICALL ### Endpoint gmbLocationDetails/updateGoogleBusinessLocationDetails ``` -------------------------------- ### Discord API Methods Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for interacting with Discord functionalities, including managing guild members, roles, messages, and scheduled events. ```APIDOC ## discord.listDiscordGuildMembers() ### Description List Discord guild members. ### Method APICALL ### Endpoint discord/listDiscordGuildMembers ``` ```APIDOC ## discord.listDiscordGuildRoles() ### Description List Discord guild roles. ### Method APICALL ### Endpoint discord/listDiscordGuildRoles ``` ```APIDOC ## discord.listDiscordPinnedMessages() ### Description List pinned messages in a Discord channel. ### Method APICALL ### Endpoint discord/listDiscordPinnedMessages ``` ```APIDOC ## discord.listDiscordScheduledEvents() ### Description List Discord scheduled events. ### Method APICALL ### Endpoint discord/listDiscordScheduledEvents ``` ```APIDOC ## discord.createDiscordScheduledEvent() ### Description Create a Discord scheduled event. ### Method APICALL ### Endpoint discord/createDiscordScheduledEvent ``` ```APIDOC ## discord.getDiscordChannels() ### Description List Discord guild channels. ### Method APICALL ### Endpoint discord/getDiscordChannels ``` ```APIDOC ## discord.getDiscordScheduledEvent() ### Description Get a Discord scheduled event. ### Method APICALL ### Endpoint discord/getDiscordScheduledEvent ``` ```APIDOC ## discord.getDiscordSettings() ### Description Get Discord account settings. ### Method APICALL ### Endpoint discord/getDiscordSettings ``` ```APIDOC ## discord.updateDiscordScheduledEvent() ### Description Update a Discord scheduled event. ### Method APICALL ### Endpoint discord/updateDiscordScheduledEvent ``` ```APIDOC ## discord.updateDiscordSettings() ### Description Update Discord settings. ### Method APICALL ### Endpoint discord/updateDiscordSettings ``` ```APIDOC ## discord.deleteDiscordScheduledEvent() ### Description Delete a Discord scheduled event. ### Method APICALL ### Endpoint discord/deleteDiscordScheduledEvent ``` ```APIDOC ## discord.addDiscordMemberRole() ### Description Assign a role to a guild member. ### Method APICALL ### Endpoint discord/addDiscordMemberRole ``` ```APIDOC ## discord.pinDiscordMessage() ### Description Pin a Discord message. ### Method APICALL ### Endpoint discord/pinDiscordMessage ``` ```APIDOC ## discord.removeDiscordMemberRole() ### Description Remove a role from a guild member. ### Method APICALL ### Endpoint discord/removeDiscordMemberRole ``` ```APIDOC ## discord.sendDiscordDirectMessage() ### Description Send a Discord Direct Message. ### Method APICALL ### Endpoint discord/sendDiscordDirectMessage ``` ```APIDOC ## discord.unpinDiscordMessage() ### Description Unpin a Discord message. ### Method APICALL ### Endpoint discord/unpinDiscordMessage ``` -------------------------------- ### Tracking Tags Source: https://github.com/zernio-dev/zernio-node/blob/main/README.md Methods for managing tracking tags (Meta Pixels), including listing, creating, retrieving, updating, and managing shared ad accounts. ```APIDOC ## trackingTags.listTrackingTags() ### Description List tracking tags (Meta Pixels). ### Method APICALL ### Endpoint trackingTags.listTrackingTags ### Parameters None ### Request Example None ### Response #### Success Response (200) - **tracking_tags** (array) - List of tracking tags ``` ```APIDOC ## trackingTags.listTrackingTagSharedAccounts() ### Description List ad accounts a tracking tag is shared with. ### Method APICALL ### Endpoint trackingTags.listTrackingTagSharedAccounts ### Parameters None ### Request Example None ### Response #### Success Response (200) - **shared_accounts** (array) - List of ad accounts ``` ```APIDOC ## trackingTags.createTrackingTag() ### Description Create a tracking tag (Meta Pixel). ### Method APICALL ### Endpoint trackingTags.createTrackingTag ### Parameters None ### Request Example None ### Response #### Success Response (200) - **tracking_tag** (object) - Details of the created tracking tag ``` ```APIDOC ## trackingTags.getTrackingTag() ### Description Fetch a single tracking tag (Meta Pixel). ### Method APICALL ### Endpoint trackingTags.getTrackingTag ### Parameters None ### Request Example None ### Response #### Success Response (200) - **tracking_tag** (object) - Details of the tracking tag ``` ```APIDOC ## trackingTags.getTrackingTagStats() ### Description Aggregated event stats for a tracking tag (Meta Pixel). ### Method APICALL ### Endpoint trackingTags.getTrackingTagStats ### Parameters None ### Request Example None ### Response #### Success Response (200) - **stats** (object) - Aggregated statistics for the tracking tag ``` ```APIDOC ## trackingTags.updateTrackingTag() ### Description Update a tracking tag (Meta Pixel). ### Method APICALL ### Endpoint trackingTags.updateTrackingTag ### Parameters None ### Request Example None ### Response #### Success Response (200) - **tracking_tag** (object) - Updated tracking tag details ``` ```APIDOC ## trackingTags.addTrackingTagSharedAccount() ### Description Share a tracking tag with an ad account. ### Method APICALL ### Endpoint trackingTags.addTrackingTagSharedAccount ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the sharing was successful ``` ```APIDOC ## trackingTags.removeTrackingTagSharedAccount() ### Description Stop sharing a tracking tag with an ad account. ### Method APICALL ### Endpoint trackingTags.removeTrackingTagSharedAccount ### Parameters None ### Request Example None ### Response #### Success Response (200) - **success** (boolean) - Indicates if the sharing was stopped ```