Facebook Business Manager · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Facebook Business Manager Facebook Marketing Custom Audiences API

3 actions 3 updates phrasing extends openapi/facebook-business-manager-custom-audiences-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 3

$.info

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

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

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 Custom Audiences API
  version: 1.0.0
extends: openapi/facebook-business-manager-custom-audiences-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: 2
- target: $.paths['/act_{ad_account_id}/customaudiences'].get
  update:
    x-apievangelist-phrasing:
      intent: List an ad account's custom audiences
      effect: read
      questions:
      - Which custom audiences have I built in my ad account and roughly how big are they?
      - Can I page through all saved audiences for an account?
      instructions:
      - text: List the custom audiences in ad account {ad_account_id}.
        slots:
          ad_account_id: path.ad_account_id
      - text: Show custom audiences for account {ad_account_id} with fields {fields}.
        slots:
          ad_account_id: path.ad_account_id
          fields: query.fields
      method: generated
      generated: '2026-10-01'
- target: $.paths['/act_{ad_account_id}/customaudiences'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a custom or lookalike audience
      effect: write
      questions:
      - How do I make a lookalike audience for ad targeting?
      - Can I build an audience from website visitors using a rule?
      - What subtypes can a new custom audience be, like customer file or app activity?
      instructions:
      - text: Create a {subtype} audience named {name} in ad account {ad_account_id}.
        slots:
          ad_account_id: path.ad_account_id
          subtype: requestBody.subtype
          name: requestBody.name
      - text: Make a lookalike audience {name} of subtype {subtype} using spec {lookalike_spec}.
        slots:
          name: requestBody.name
          subtype: requestBody.subtype
          lookalike_spec: requestBody.lookalike_spec
      - text: Build a website audience {name} with subtype {subtype} and rule {rule}.
        slots:
          name: requestBody.name
          subtype: requestBody.subtype
          rule: requestBody.rule
      method: generated
      generated: '2026-10-01'