Impact · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Partner Withdrawal Settings API

4 actions 4 updates phrasing extends openapi/impact-withdrawal-settings-api-openapi.yml

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

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info

$.paths['/Mediapartners/{AccountSID}/WithdrawalSettings'].get

$.paths['/Mediapartners/{AccountSID}/WithdrawalSettings'].put

$.paths['/Mediapartners/{AccountSID}/WithdrawalSettings/RequiredFields'].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 Partner Withdrawal Settings API
  version: 1.0.0
extends: openapi/impact-withdrawal-settings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/Mediapartners/{AccountSID}/WithdrawalSettings'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a partner's withdrawal settings
      effect: read
      questions:
      - What bank account and payout schedule is on my partner account?
      - Where can I check how I get paid?
      instructions:
      - text: Retrieve withdrawal settings for partner account {sid}.
        slots:
          sid: path.AccountSID
      - text: Show payout banking and scheduling for account {sid}.
        slots:
          sid: path.AccountSID
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/WithdrawalSettings'].put
  update:
    x-apievangelist-phrasing:
      intent: Update a partner's withdrawal settings
      effect: write
      questions:
      - How do I change where my partner earnings are paid out?
      - Can I set a minimum payment threshold for withdrawals?
      instructions:
      - text: Set payment method on account {sid} to {method}.
        slots:
          sid: path.AccountSID
          method: requestBody.PaymentMethod
      - text: Pay out to PayPal address {email} on partner account {sid}.
        slots:
          sid: path.AccountSID
          email: requestBody.PaypalEmailAddress
      - text: Set my withdrawal threshold to {threshold}.
        slots:
          threshold: requestBody.PaymentThreshold
      method: generated
      generated: '2026-09-26'
- target: $.paths['/Mediapartners/{AccountSID}/WithdrawalSettings/RequiredFields'].get
  update:
    x-apievangelist-phrasing:
      intent: Get required banking fields for a country
      effect: read
      questions:
      - Which banking fields are mandatory for payouts in my country?
      - What do I need to fill in before setting up a new payment method?
      instructions:
      - text: Get required banking fields for {country} on account {sid}.
        slots:
          sid: path.AccountSID
          country: query.bankCountry
      - text: List mandatory fields for {country} with payment method {method}.
        slots:
          country: query.bankCountry
          method: query.paymentMethod
      method: generated
      generated: '2026-09-26'