Zernio
APIFor you
Zernio
APIFor you
API Reference

Connect

General

Get OAuth connect URLGETComplete OAuth callbackPOSTGet pending OAuth dataGETConnect ads for a platformGET

Facebook

List Facebook pagesGETSelect Facebook pagePOSTList Facebook pagesGETUpdate Facebook pagePUTComplete Meta business loginGETRead a Facebook Page's webhook subscriptionGETRe-subscribe a Facebook Page to Zernio's webhooksPOST

Google Business

List Google Business Profile locationsGETSelect Google Business Profile locationPOSTAssign Google Business Profile location to another profilePOSTList Google Business Profile locationsGETUpdate Google Business Profile locationPUT

Instagram

List Pages with a linked Instagram accountGETSelect the Page whose Instagram account to connectPOST

LinkedIn

List LinkedIn orgsGETSelect LinkedIn orgPOSTList LinkedIn orgsGETSwitch LinkedIn account typePUT

Pinterest

List Pinterest boardsGETSelect Pinterest boardPOSTList Pinterest boardsGETCreate Pinterest boardPOSTSet default Pinterest boardPUT

Reddit

List Reddit subredditsGETList subreddit flairsGETGet subreddit rulesGETSet Reddit post flairPOSTVote on a Reddit post or commentPOSTSet default subredditPUT

Bluesky

Connect Bluesky accountPOST

Discord

Connect a Discord channelPOST

Slack

List Slack channels for the channel pickerGETConnect a Slack channelPOST

Telegram

Generate Telegram codeGETConnect Telegram directlyPOSTCheck Telegram statusPATCH

Snapchat

List Snapchat profilesGETSelect Snapchat profilePOST

TikTok

Set TikTok brand identityPATCH

OpenAI Ads

Connect an OpenAI Ads accountPOST

WhatsApp

Connect WhatsApp via credentialsPOSTConnect WhatsApp from Embedded SignupPOSTGet Embedded Signup SDK configGETList numbers for selectionGETComplete number selectionPOST

YouTube

List YouTube playlistsGETCreate YouTube playlistPOSTSet default YouTube playlistPUTGet a YouTube video transcriptGET

Shopify

Get Shopify OAuth connect URLGETConnect a Shopify store with a custom-app Admin tokenPOST

WordPress

Get WordPress.com OAuth connect URLGETConnect self-hosted WordPress with an application passwordPOST

Other

Connect Webflow with a site API tokenPOSTConnect a Whop accountPOSTAdd an OAuth appPOSTRemove an OAuth appDELETEGet a phone handoffGETGet the saved welcome screenGETGet Google Analytics OAuth connect URLGETGet HubSpot OAuth connect URLGETGet an OAuth appGETGet Webflow OAuth URLGETGet Wix site install URLGETList Google Analytics properties for a pending connectGETList your OAuth appsGETConnect the chosen Google Analytics propertyPOSTAdmin-consent link for a Microsoft tenantGETCheck an OAuth app's keysPOSTSave the welcome screenPUTUpdate an OAuth appPATCH
Dashboard
OverviewPlatformsAPI ReferenceResources
Connect

Add an OAuth app

Saves your app's client ID and secret for a platform. The keys are checked with the platform first: keys it rejects return 400 OAUTH_APP_KEYS_REJECTED and are not saved; keys it could not check are saved with status unchecked. Allow the returned redirectUri in your app's settings on the platform before connecting. Only the account owner or a full-access team member can add apps, and not with a profile-scoped API key.

POST
/v1/connect/oauth-apps

Authorization

bearerAuth
AuthorizationBearer <token>

API key authentication: send your Zernio API key in the Authorization header, prefixed with Bearer.

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

import Zernio from '@zernio/node';const zernio = new Zernio({ apiKey: process.env.ZERNIO_API_KEY });const { data } = await zernio.connect.createOAuthApp({  body: {    platform: 'twitter',    label: 'string',    clientId: 'client_abc123',    clientSecret: 'string',  },});console.log(data);
{  "app": {    "id": "string",    "platform": "string",    "label": "string",    "clientId": "string",    "scopeAreas": [      "posting"    ],    "status": "ok",    "lastCheckedAt": "2019-08-24T14:15:22Z",    "lastError": "string",    "accountCount": 0,    "redirectUri": "http://example.com",    "webhook": {      "callbackUrl": "http://example.com",      "verifyToken": "string",      "object": "page",      "fields": [        "string"      ]    },    "createdAt": "2019-08-24T14:15:22Z"  }}
Was this page helpful?

Connect a Whop account

Connect a Whop account with an Account API key from the Whop dashboard (Developer > API keys). The key only has to be able to read its own account: Zernio calls `GET /accounts/me` once to learn the account id (`biz_...`) and name, then stores the key. What the connection unlocks today is the Whop Pixel through the tracking-tags API: the account id is the pixel, so `GET /v1/accounts/{accountId}/tracking-tags` lists it and `POST .../tracking-tags/{biz_...}/install` puts it on a Shopify store or WordPress site. Whop campaigns are not managed through Zernio. One Whop account per profile.

Remove an OAuth app

Removes the app. Accounts connected through it can no longer refresh their tokens, so when any are connected the call returns 409 OAUTH_APP_IN_USE with `details.accountCount` unless `confirm=true` is passed. With confirm, those accounts are marked as needing reconnection and each fires `account.disconnected`.

platform*string

One of the platforms listed in platforms of GET /v1/connect/oauth-apps.

label*string
Length1 <= length <= 80
clientId*string
Length1 <= length <= 500
clientSecret*string
Length1 <= length <= 1000
scopeAreas?array<>

Areas this app requests. Defaults to every area the platform supports; an area the platform cannot request separately is a 400.