Accounts & connections · Accounts

Share the Page with a partner business

Shares the Page with a partner business. Works with Facebook and Instagram accounts.

POSThttps://api.pozy.ai/v1/accounts/{accountId}/business-partners

Facebook and InstagramgrantBusinessPartner

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

Path parameters

Name	Type	Notes
`accountId`required	string

Request body

application/json, required

businessIdstringrequired
permittedTasksarray of string
Each item: one of MANAGE, CREATE_CONTENT, MODERATE, MESSAGING, ADVERTISE, ANALYZE, MODERATE_COMMUNITY, MANAGE_JOBS, PAGES_MESSAGING, PAGES_MESSAGING_SUBSCRIPTIONS, READ_PAGE_MAILBOXES, VIEW_MONETIZATION_INSIGHTS, MANAGE_LEADS, CASHIER_ROLE, GLOBAL_STRUCTURE_MANAGEMENT, PROFILE_PLUS_FULL_CONTROL, PROFILE_PLUS_MANAGE, PROFILE_PLUS_FACEBOOK_ACCESS, PROFILE_PLUS_CREATE_CONTENT, PROFILE_PLUS_MODERATE, PROFILE_PLUS_MODERATE_DELEGATE_COMMUNITY, PROFILE_PLUS_MESSAGING, PROFILE_PLUS_ADVERTISE, PROFILE_PLUS_ANALYZE and 5 more.

Example

curl -X POST "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-partners" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "businessId": "68520dbeeafb126eab3873f6"
}'

const res = await fetch("https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-partners", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.POZY_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    businessId: "68520dbeeafb126eab3873f6"
  }),
});
const data = await res.json();
if (!res.ok) throw new Error(data?.error ?? `Request failed with status ${res.status}`);
console.log(data);

import os
import requests

resp = requests.post(
    "https://api.pozy.ai/v1/accounts/696e0b682d0a31188e7a2ba9/business-partners",
    headers={"Authorization": f"Bearer {os.environ['POZY_API_KEY']}"},
    json={
        "businessId": "68520dbeeafb126eab3873f6",
    },
    timeout=30,
)
resp.raise_for_status()
print(resp.json())

Response

200 on success

pageobject
- idstring
- namestring
- businessobject
  Can be null.
  2 child fields
  - idstring
  - namestring
- instagramBusinessAccountobject
  Can be null.
  2 child fields
  - idstring
  - usernamestring
partnerobject
- businessIdstring
- permittedTasksarray of string
alreadySharedboolean

200 response

{
  "page": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "business": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "name": "Acme"
    },
    "instagramBusinessAccount": {
      "id": "6bfebd43ddc270f6d2c56fc5",
      "username": "acme"
    }
  },
  "partner": {
    "businessId": "68520dbeeafb126eab3873f6",
    "permittedTasks": [
      "string"
    ]
  },
  "alreadyShared": true
}

Errors

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

400	invalid_request_error	A parameter or body field is missing or invalid. `param` names it.
401	authentication_error	The API key is missing, revoked or expired.
403	permission_error	The key is read-only, scoped to other profiles, or has this resource group disabled.
404	not_found	Nothing with that id exists in your workspace.
429	rate_limit_error	Too many requests this minute. Wait for `Retry-After` seconds.

Every code is listed in Errors.