API Evangelist conversational phrasing for Shopify Address API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Address API
  version: 1.0.0
extends: openapi/shopify-address-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-24'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 42
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/addresses.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to a customer (2020-01 API)
      effect: write
      questions:
      - How do I add a new shipping address to a customer on the 2020-01 Admin API?
      - Can a customer hold more than one address when I call the 2020-01 version?
      instructions:
      - text: Add a new address to customer {customer} via the 2020-01 API.
        slots:
          customer: path.customer_id
      - text: Using API version 2020-01, save another address on customer {customer}'s address book.
        slots:
          customer: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one customer address (2020-01 API)
      effect: read
      questions:
      - How do I fetch a single saved address for a customer on the 2020-01 API?
      - What details come back for one customer address in version 2020-01?
      instructions:
      - text: Show address {address} of customer {customer} using the 2020-01 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Fetch the details of address {address} belonging to {customer}, version 2020-01.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer address (2020-01 API)
      effect: write
      questions:
      - How do I correct a typo in a customer's saved address on the 2020-01 API?
      - Can I change an existing customer address rather than add a new one in 2020-01?
      instructions:
      - text: Update address {address} of customer {customer} using version 2020-01.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Edit the existing address {address} on customer {customer} with the 2020-01 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer address (2020-01 API)
      effect: destructive
      questions:
      - How do I delete an outdated address from a customer's address list on 2020-01?
      - Can I remove one address from a customer without deleting the customer, in 2020-01?
      instructions:
      - text: Delete address {address} from customer {customer} using the 2020-01 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Remove the old address {address} from {customer}'s address list, version 2020-01.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/addresses/{address_id}/default.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a customer's default address (2020-01 API)
      effect: write
      questions:
      - How do I make one of a customer's saved addresses their default on 2020-01?
      - Can I switch which address is a customer's primary one in the 2020-01 API?
      instructions:
      - text: Make address {address} the default for customer {customer} using 2020-01.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Set {customer}'s primary address to {address} with the 2020-01 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/addresses.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to a customer (2020-04 API)
      effect: write
      questions:
      - What call on the 2020-04 release adds an extra address to a shopper's account?
      - Is creating a customer address still supported in the 2020-04 version?
      instructions:
      - text: On the 2020-04 release, create an address for customer {customer}.
        slots:
          customer: path.customer_id
      - text: Append a fresh address record to shopper {customer} with version 2020-04.
        slots:
          customer: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one customer address (2020-04 API)
      effect: read
      questions:
      - Can I read one specific address off a customer in the 2020-04 release?
      - Which 2020-04 call returns a single address by its ID for a customer?
      instructions:
      - text: Retrieve address {address} for customer {customer} on 2020-04.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Pull up one saved address, {address}, of shopper {customer} with the 2020-04 release.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer address (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call modifies an address a customer already has on file?
      - Is it possible to overwrite a stored customer address in the 2020-04 release?
      instructions:
      - text: Change address {address} for customer {customer} on the 2020-04 release.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Revise shopper {customer}'s saved address {address} via 2020-04.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer address (2020-04 API)
      effect: destructive
      questions:
      - Which 2020-04 endpoint drops an address from a customer's saved addresses?
      - Is deleting a customer address supported in the 2020-04 release?
      instructions:
      - text: Remove address {address} from customer {customer} on 2020-04.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Drop saved address {address} off shopper {customer}'s account via the 2020-04 release.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/addresses/{address_id}/default.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a customer's default address (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call marks an address as the customer's default?
      - Is changing a customer's default address supported in the 2020-04 release?
      instructions:
      - text: Set address {address} as default for customer {customer} on 2020-04.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Promote saved address {address} to shopper {customer}'s default via the 2020-04 release.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/addresses.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to a customer (2020-07 API)
      effect: write
      questions:
      - Where do I post a new customer address in the 2020-07 Admin REST version?
      - Which 2020-07 endpoint stores an additional address for an existing customer?
      instructions:
      - text: Create a customer address for {customer} against the 2020-07 version.
        slots:
          customer: path.customer_id
      - text: Give customer {customer} one more saved address through 2020-07.
        slots:
          customer: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one customer address (2020-07 API)
      effect: read
      questions:
      - Where do I read a customer's individual address in the 2020-07 version?
      - Does version 2020-07 support getting one address by ID for a customer?
      instructions:
      - text: Get customer {customer}'s address {address} from the 2020-07 version.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Look up the single address {address} on buyer {customer} via 2020-07.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer address (2020-07 API)
      effect: write
      questions:
      - Where do I update an already-saved customer address in version 2020-07?
      - What endpoint in 2020-07 lets me fix a buyer's existing address?
      instructions:
      - text: Modify address {address} of customer {customer} through the 2020-07 version.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Fix the stored address {address} for buyer {customer} with 2020-07.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer address (2020-07 API)
      effect: destructive
      questions:
      - Where do I remove a customer's unwanted address in version 2020-07?
      - What happens to a customer's address list when I delete one address in 2020-07?
      instructions:
      - text: Delete customer {customer}'s address {address} through the 2020-07 version.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Erase the address {address} from buyer {customer} with 2020-07.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/addresses/{address_id}/default.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a customer's default address (2020-07 API)
      effect: write
      questions:
      - Where do I choose a buyer's default address in version 2020-07?
      - What endpoint in 2020-07 flips which saved address is primary for a customer?
      instructions:
      - text: Mark address {address} as customer {customer}'s default through 2020-07.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Switch buyer {customer}'s default address to {address} with the 2020-07 version.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/addresses.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to a customer (2020-10 API)
      effect: write
      questions:
      - How can I give an existing customer a second address with the 2020-10 API?
      - Does the 2020-10 Admin API let me attach a new address to a customer record?
      instructions:
      - text: Add an address to customer {customer} with the 2020-10 Admin API.
        slots:
          customer: path.customer_id
      - text: Register a new mailing address under customer {customer}, version 2020-10.
        slots:
          customer: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one customer address (2020-10 API)
      effect: read
      questions:
      - How can I view one particular address a customer has saved, using 2020-10?
      - What does the 2020-10 Admin API return for a single customer address?
      instructions:
      - text: Show me address {address} on customer {customer} with the 2020-10 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Read the saved address {address} of customer {customer}, API 2020-10.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer address (2020-10 API)
      effect: write
      questions:
      - How can I update an address a customer previously saved, using the 2020-10 API?
      - Does the 2020-10 Admin API support editing an existing customer address?
      instructions:
      - text: Update customer {customer}'s address {address} on the 2020-10 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Correct the details of existing address {address} for {customer}, version 2020-10.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer address (2020-10 API)
      effect: destructive
      questions:
      - How can I take an address off a customer's address list with the 2020-10 API?
      - Does the 2020-10 Admin API let me delete a single customer address?
      instructions:
      - text: Remove address {address} from customer {customer} with the 2020-10 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Delete the stale address {address} on {customer}, API version 2020-10.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/addresses/{address_id}/default.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a customer's default address (2020-10 API)
      effect: write
      questions:
      - How can I change which address a customer uses by default with the 2020-10 API?
      - Does the 2020-10 Admin API let me pick a default among a customer's addresses?
      instructions:
      - text: Make {address} the default address of customer {customer} on the 2020-10 API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Set the primary address for {customer} to saved address {address}, API 2020-10.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/addresses.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to a customer (2021-01 API)
      effect: write
      questions:
      - Can I create a customer address using the 2021-01 REST release?
      - What endpoint in version 2021-01 lets a merchant add an address for a buyer?
      instructions:
      - text: Through the 2021-01 release, add an address for customer {customer}.
        slots:
          customer: path.customer_id
      - text: Create one more address in the address list of buyer {customer} on 2021-01.
        slots:
          customer: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one customer address (2021-01 API)
      effect: read
      questions:
      - Can I retrieve just one of a customer's addresses in the 2021-01 release?
      - Which endpoint in 2021-01 gives me a single customer address by ID?
      instructions:
      - text: Using 2021-01, fetch address {address} of customer {customer}.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Display one address, {address}, for shopper {customer} on the 2021-01 release.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer address (2021-01 API)
      effect: write
      questions:
      - Can I change a customer's existing address with the 2021-01 release?
      - Which 2021-01 endpoint edits one address already on a customer's account?
      instructions:
      - text: With the 2021-01 release, edit address {address} of customer {customer}.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Overwrite the saved address {address} on shopper {customer} using 2021-01.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer address (2021-01 API)
      effect: destructive
      questions:
      - Can I delete one of a customer's addresses using the 2021-01 release?
      - Which 2021-01 call removes a saved address from a buyer's account?
      instructions:
      - text: Using 2021-01, delete address {address} of customer {customer}.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Strip address {address} out of shopper {customer}'s address book on the 2021-01 release.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/addresses/{address_id}/default.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a customer's default address (2021-01 API)
      effect: write
      questions:
      - Can I set a customer's default address using the 2021-01 release?
      - Which 2021-01 endpoint designates one saved address as a buyer's default?
      instructions:
      - text: Using 2021-01, set address {address} as the default for customer {customer}.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Designate {address} as shopper {customer}'s primary address on the 2021-01 release.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/addresses.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Add an address to a customer (unstable API)
      effect: write
      questions:
      - Is there an unstable-version endpoint for adding a customer address?
      - How would I test creating a customer address against the unstable Admin API?
      instructions:
      - text: Add an address to customer {customer} on the unstable API version.
        slots:
          customer: path.customer_id
      - text: Use the unstable release to create a new address for shopper {customer}.
        slots:
          customer: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Look up one customer address (unstable API)
      effect: read
      questions:
      - Is reading a single customer address available on the unstable API?
      - How would I get one customer address by ID from the unstable version?
      instructions:
      - text: Retrieve address {address} of customer {customer} from the unstable API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: On the unstable version, look up saved address {address} for buyer {customer}.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Edit a customer address (unstable API)
      effect: write
      questions:
      - Is there an unstable-version call to edit an existing customer address?
      - How would I update a saved customer address on the unstable Admin API?
      instructions:
      - text: Update address {address} for customer {customer} on the unstable version.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: Via the unstable API, change the existing address {address} of buyer {customer}.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/addresses/{address_id}.json'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a customer address (unstable API)
      effect: destructive
      questions:
      - Is removing a customer address possible on the unstable API version?
      - How would I delete a saved customer address against the unstable release?
      instructions:
      - text: Delete address {address} from customer {customer} on the unstable API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: On the unstable version, remove saved address {address} for buyer {customer}.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/addresses/{address_id}/default.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a customer's default address (unstable API)
      effect: write
      questions:
      - Is setting a default customer address available on the unstable API?
      - How would I mark a customer's default address against the unstable release?
      instructions:
      - text: Set address {address} as the default for customer {customer} on the unstable API.
        slots:
          customer: path.customer_id
          address: path.address_id
      - text: On the unstable version, make saved address {address} buyer {customer}'s primary one.
        slots:
          customer: path.customer_id
          address: path.address_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/webhooks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook topic (2020-01 API)
      effect: write
      questions:
      - How do I register a webhook subscription with an address and topic on 2020-01?
      - Can my webhook payloads arrive as XML instead of JSON in the 2020-01 API?
      instructions:
      - text: Create a webhook subscription on the 2020-01 API.
      - text: Subscribe a new webhook with {format} payloads using version 2020-01.
        slots:
          format: query.format
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/webhooks/{webhook_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's topic or address (2020-01 API)
      effect: write
      questions:
      - How do I point an existing webhook at a new callback URL on the 2020-01 API?
      - Can I switch the topic of a webhook I already subscribed, in 2020-01?
      instructions:
      - text: Update webhook {webhook}'s address using the 2020-01 API.
        slots:
          webhook: path.webhook_id
      - text: Change the topic on existing webhook {webhook} with version 2020-01.
        slots:
          webhook: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/webhooks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook topic (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call sets up a new webhook for a topic and callback address?
      - What payload formats can a new webhook use in the 2020-04 release?
      instructions:
      - text: Register a webhook for a topic and delivery address on 2020-04.
      - text: Set up a webhook subscription that sends {format} via the 2020-04 release.
        slots:
          format: query.format
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/webhooks/{webhook_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's topic or address (2020-04 API)
      effect: write
      questions:
      - Which 2020-04 call edits the destination URI of an existing webhook subscription?
      - Is changing a webhook's topic supported in the 2020-04 release?
      instructions:
      - text: Repoint webhook {webhook} to a new address on 2020-04.
        slots:
          webhook: path.webhook_id
      - text: Edit the topic of subscription {webhook} via the 2020-04 release.
        slots:
          webhook: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/webhooks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook topic (2020-07 API)
      effect: write
      questions:
      - Where do I create a webhook subscription in version 2020-07?
      - Is XML still an option for webhook payloads on the 2020-07 version?
      instructions:
      - text: Add a webhook subscription through the 2020-07 version.
      - text: Start a webhook subscription delivering {format} payloads with 2020-07.
        slots:
          format: query.format
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/webhooks/{webhook_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's topic or address (2020-07 API)
      effect: write
      questions:
      - Where do I modify an existing webhook's address in version 2020-07?
      - What can I change on an already-created webhook with 2020-07?
      instructions:
      - text: Modify webhook {webhook}'s delivery address through 2020-07.
        slots:
          webhook: path.webhook_id
      - text: Move existing webhook {webhook} to another topic with the 2020-07 version.
        slots:
          webhook: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/webhooks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook topic (2020-10 API)
      effect: write
      questions:
      - How can my app get notified of store events by subscribing a webhook on 2020-10?
      - Does the 2020-10 Admin API default new webhooks to JSON payloads?
      instructions:
      - text: Subscribe to a webhook topic with the 2020-10 Admin API.
      - text: Create a webhook that delivers {format} to my endpoint, API 2020-10.
        slots:
          format: query.format
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/webhooks/{webhook_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's topic or address (2020-10 API)
      effect: write
      questions:
      - How can I update the URI an existing webhook posts to, using the 2020-10 API?
      - Does the 2020-10 Admin API let me change a subscribed webhook's topic?
      instructions:
      - text: Update the address of webhook {webhook} on the 2020-10 API.
        slots:
          webhook: path.webhook_id
      - text: Switch existing webhook {webhook} to a different topic, API 2020-10.
        slots:
          webhook: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/webhooks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook topic (2021-01 API)
      effect: write
      questions:
      - Can I create a new webhook subscription using the 2021-01 release?
      - Which format values does the 2021-01 webhook create call accept?
      instructions:
      - text: Using 2021-01, create a webhook subscription for a topic.
      - text: Register a new webhook in {format} format on the 2021-01 release.
        slots:
          format: query.format
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/webhooks/{webhook_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's topic or address (2021-01 API)
      effect: write
      questions:
      - Can I edit an existing webhook's callback address using the 2021-01 release?
      - Which 2021-01 endpoint changes the topic of a webhook I already have?
      instructions:
      - text: Using 2021-01, change the callback address of webhook {webhook}.
        slots:
          webhook: path.webhook_id
      - text: Retarget subscription {webhook} to a new topic on the 2021-01 release.
        slots:
          webhook: path.webhook_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/webhooks.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Subscribe to a webhook topic (unstable API)
      effect: write
      questions:
      - Is creating a webhook subscription available on the unstable API?
      - How would I test a new webhook subscription against the unstable release?
      instructions:
      - text: Create a webhook subscription on the unstable API version.
      - text: On the unstable version, subscribe a webhook with {format} payloads.
        slots:
          format: query.format
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/webhooks/{webhook_id}.json'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a webhook's topic or address (unstable API)
      effect: write
      questions:
      - Is updating an existing webhook subscription possible on the unstable API?
      - How would I change an existing webhook's URI against the unstable release?
      instructions:
      - text: Update webhook {webhook}'s address on the unstable API version.
        slots:
          webhook: path.webhook_id
      - text: On the unstable version, change the topic of existing webhook {webhook}.
        slots:
          webhook: path.webhook_id
      method: generated
      generated: '2026-09-24'