Create Facebook integration

POST 
/ad-publishing/facebook/integration

Create a Facebook ad integration for a location with page and ad account

Request

Version stringrequired

API Version

Available optionsv3

application/json

application/json

Body

Bodyrequired

locationIdstringrequired

Location identifier

pageIdstringrequired

Facebook page ID

adAccountIdstring

Ad account identifier

Example (auto)

{
  "locationId": "loc_abc123",
  "pageId": "123456789",
  "adAccountId": "act_123456"
}

application/json

The stored integration. Broader than the read — also returns the top-level userAccessToken.

application/json

Schema

Schema

idstringrequired

Integration identifier

locationIdstringrequired

Location identifier

statusstringrequired
Connection state
Available optionsconnectedexpireddisconnected
pricingModelstringrequired
How the location pays for ads
Available optionsdone_for_youconnect_your_bm
userAccessTokenstringrequired

Live user access token for the connected Facebook user. Treat as a credential.

fbAdAccountIdstring

Connected ad account id

fbDefaultPageIdstring

Page used by default when publishing

pagesobject[]required

Pages linked to the integration, each with its access token

unSubscriptionReasonsstring[]required

Reasons the location previously unsubscribed. Empty array when none.

createdAtstringrequired

Created at

updatedAtstringrequired

Updated at

Example (auto)

{
  "id": "68b6e9577058423e35c3c358",
  "locationId": "g8EFf47NY6PxodNBEHzP",
  "status": "connected",
  "pricingModel": "connect_your_bm",
  "userAccessToken": "<user-access-token>",
  "fbAdAccountId": "act_357046700569338",
  "fbDefaultPageId": "1180808591782587",
  "pages": [
    {
      "id": "196684453527082",
      "name": "Acme Restaurant",
      "accessToken": "<page-access-token>",
      "createdOn": "2026-08-14T07:54:16.206Z",
      "_id": "6a82addf630fffe07b9bedd7"
    }
  ],
  "unSubscriptionReasons": [],
  "createdAt": "2025-09-02T12:55:51.522Z",
  "updatedAt": "2026-08-19T12:03:39.896Z"
}