pozyDocs
Dashboard

Accounts & connections · Connect

Add an OAuth app

Adds an OAuth app.

POSThttps://api.pozy.ai/v1/connect/oauth-apps
Not available yetcreateOAuthApp

Guide: Use your own platform apps

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

This endpoint is not available yet. Calls return 403 feature_not_available.

Request body

application/json, required

  • platformstringrequired
  • labelstringrequired

    1 to 80 characters.

  • clientIdstringrequired

    1 to 500 characters.

  • clientSecretstringrequired

    1 to 1000 characters.

  • metaAppIdstring

    Matches ^\d{1,32}$.

  • metaAppSecretstring

    1 to 1000 characters.

  • slackSigningSecretstring

    1 to 1000 characters.

  • scopeAreasarray of string

    Each item: one of posting, analytics, comments, messaging.

Example

curl -X POST "https://api.pozy.ai/v1/connect/oauth-apps" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "platform": "instagram",
  "label": "string",
  "clientId": "6676c044a482bcb231679047",
  "clientSecret": "string"
}'

Response

201 on success

  • appobjectrequired
    15 child fields
    • idstringrequired
    • platformstringrequired
    • labelstringrequired
    • clientIdstringrequired
    • scopeAreasarray of stringrequired

      Each item: one of posting, analytics, comments, messaging.

    • statusstringrequired

      One of ok, unchecked, invalid.

    • lastCheckedAtstring (date-time)

      Can be null.

    • lastErrorstring

      Can be null.

    • accountCountintegerrequired
    • redirectUristring (URL)required
    • webhookobject

      Can be null.

      4 child fields
      • callbackUrlstring (URL)required
      • verifyTokenstringrequired
      • objectstringrequired

        One of page, instagram.

      • fieldsarray of stringrequired
    • sharedWebhookUrlstring (URL)

      Can be null.

    • hasSlackSigningSecretboolean
    • slackEventsobject

      Can be null.

      2 child fields
      • requestUrlstring (URL)required
      • botEventsarray of stringrequired
    • createdAtstring (date-time)required
201 response
{
  "app": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "platform": "instagram",
    "label": "string",
    "clientId": "6676c044a482bcb231679047",
    "scopeAreas": [
      "posting"
    ],
    "status": "ok",
    "lastCheckedAt": "2026-10-02T09:00:00.000Z",
    "lastError": "string",
    "accountCount": 42,
    "redirectUri": "https://pozy.ai/media/example-1.jpg",
    "webhook": {
      "callbackUrl": "https://pozy.ai/media/example-1.jpg",
      "verifyToken": "string",
      "object": "page",
      "fields": [
        "string"
      ]
    },
    "sharedWebhookUrl": "https://pozy.ai/media/example-1.jpg",
    "hasSlackSigningSecret": true,
    "slackEvents": {
      "requestUrl": "https://pozy.ai/media/example-1.jpg",
      "botEvents": [
        "string"
      ]
    },
    "createdAt": "2026-10-02T09:00:00.000Z"
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Connect

GETGet OAuth connect URLPOSTComplete OAuth callbackGETConnect ads for a platformGETGet Shopify OAuth connect URLPOSTConnect a Shopify store with a custom-app Admin tokenGETGet Google Analytics OAuth connect URLGETList Google Analytics properties for a pending connectPOSTConnect the chosen Google Analytics propertyGETGet HubSpot OAuth connect URLGETGet WordPress.com OAuth connect URLGETGet Wix site install URLGETGet Webflow OAuth URLPOSTConnect Webflow with a site API tokenPOSTConnect self-hosted WordPress with an application passwordPATCHSet TikTok brand identityGETList Facebook pagesPOSTSelect Facebook pageGETList Pages with a linked Instagram accountPOSTSelect the Page whose Instagram account to connectGETList Google Business Profile locationsPOSTSelect Google Business Profile locationGETGet a phone handoffGETGet the saved welcome screenPUTSave the welcome screenGETList your OAuth appsGETGet an OAuth appPATCHUpdate an OAuth appDELRemove an OAuth appPOSTCheck an OAuth app's keysGETGet pending OAuth dataGETList LinkedIn orgsPOSTSelect LinkedIn orgGETList Pinterest boardsPOSTSelect Pinterest boardGETList Snapchat profilesPOSTSelect Snapchat profilePOSTConnect Bluesky accountPOSTConnect an OpenAI Ads accountPOSTConnect a Whop accountPOSTConnect WhatsApp via credentialsGETList numbers for selectionPOSTComplete number selectionPOSTConnect WhatsApp from Embedded SignupGETGet Embedded Signup SDK configPOSTConnect a Discord channelGETList Slack channels for the channel pickerPOSTConnect a Slack channelGETGenerate Telegram codePOSTConnect Telegram directlyPATCHCheck Telegram statusGETRead a Facebook Page's webhook subscriptionPOSTRe-subscribe a Facebook Page to Pozy's webhooksGETList Facebook pagesPUTUpdate Facebook pageGETList LinkedIn orgsPUTSwitch LinkedIn account typeGETList Pinterest boardsPOSTCreate Pinterest boardPUTSet default Pinterest boardGETGet a YouTube video transcriptGETList YouTube playlistsPOSTCreate YouTube playlistPUTSet default YouTube playlistGETList Google Business Profile locationsPUTUpdate Google Business Profile locationPOSTAssign Google Business Profile location to another profileGETList Reddit subredditsPUTSet default subredditGETGet subreddit rulesPOSTVote on a Reddit post or commentGETList subreddit flairsPOSTSet Reddit post flairGETAdmin-consent link for a Microsoft tenant