Facebook Business Manager · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Facebook Business Manager Facebook Marketing Ads API

4 actions 4 updates phrasing extends openapi/facebook-business-manager-ads-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Facebook Business Manager's API. It is a proposal applied on top of the contract, not a document Facebook Business Manager publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/act_{ad_account_id}/ads'].get

$.paths['/act_{ad_account_id}/ads'].post

$.paths['/{ad_id}'].get

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Facebook Business Manager Facebook Marketing Ads API
  version: 1.0.0
extends: openapi/facebook-business-manager-ads-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/act_{ad_account_id}/ads'].get
  update:
    x-apievangelist-phrasing:
      intent: List the ads in an ad account
      effect: read
      questions:
      - Which ads are running in my ad account and which creative does each use?
      - Can I page through every ad in an account?
      instructions:
      - text: List all ads in ad account {ad_account_id}.
        slots:
          ad_account_id: path.ad_account_id
      - text: Show {limit} ads at a time from account {ad_account_id}.
        slots:
          ad_account_id: path.ad_account_id
          limit: query.limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/act_{ad_account_id}/ads'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an ad from a creative in an ad set
      effect: write
      questions:
      - How do I put an existing creative live as an ad inside an ad set?
      - Can I create an ad paused so it doesn't start delivering right away?
      instructions:
      - text: Create ad {name} in ad set {adset_id} using creative {creative} with status {status} on account {ad_account_id}.
        slots:
          ad_account_id: path.ad_account_id
          name: requestBody.name
          adset_id: requestBody.adset_id
          creative: requestBody.creative
          status: requestBody.status
      - text: Add a paused ad {name} to ad set {adset_id} with creative {creative}, status {status}, in account {ad_account_id}.
        slots:
          ad_account_id: path.ad_account_id
          name: requestBody.name
          adset_id: requestBody.adset_id
          creative: requestBody.creative
          status: requestBody.status
      method: generated
      generated: '2026-10-01'
- target: $.paths['/{ad_id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one ad's creative and status
      effect: read
      questions:
      - What creative and status does a specific ad have?
      - Can I look up a single ad by its ID?
      instructions:
      - text: Show me ad {ad_id}.
        slots:
          ad_id: path.ad_id
      - text: Get the {fields} of ad {ad_id}.
        slots:
          ad_id: path.ad_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'