Shopify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Shopify Account API

13 actions 13 updates phrasing extends openapi/shopify-account-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Shopify's API. It is a proposal applied on top of the contract, not a document Shopify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 13

$.info
$.paths['/admin/api/2020-01/customers/{customer_id}/account_activation_url.json'].post
$.paths['/admin/api/2020-01/customers/{customer_id}/send_invite.json'].post
$.paths['/admin/api/2020-04/customers/{customer_id}/account_activation_url.json'].post
$.paths['/admin/api/2020-04/customers/{customer_id}/send_invite.json'].post
$.paths['/admin/api/2020-07/customers/{customer_id}/account_activation_url.json'].post
$.paths['/admin/api/2020-07/customers/{customer_id}/send_invite.json'].post
$.paths['/admin/api/2020-10/customers/{customer_id}/account_activation_url.json'].post
$.paths['/admin/api/2020-10/customers/{customer_id}/send_invite.json'].post
$.paths['/admin/api/2021-01/customers/{customer_id}/account_activation_url.json'].post
$.paths['/admin/api/2021-01/customers/{customer_id}/send_invite.json'].post
$.paths['/admin/api/unstable/customers/{customer_id}/account_activation_url.json'].post
$.paths['/admin/api/unstable/customers/{customer_id}/send_invite.json'].post

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Shopify Account API
  version: 1.0.0
extends: openapi/shopify-account-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: 12
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/account_activation_url.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a customer account activation link (API 2020-01)
      effect: write
      questions:
      - How do I generate an activation URL for a customer who hasn't activated their account, on API 2020-01?
      - Can I create a one-off account activation link to send myself on the January 2020 release?
      instructions:
      - text: Generate an account activation URL for customer {customer_id} via 2020-01.
        slots:
          customer_id: path.customer_id
      - text: Make a fresh activation link for inactive customer {customer_id}, January 2020 API.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-01/customers/{customer_id}/send_invite.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a customer an account invite (API 2020-01)
      effect: write
      questions:
      - Which 2020-01 call emails a customer an invitation to create their store account?
      - Can I trigger the account invite email for one shopper on the January 2020 API?
      instructions:
      - text: Send customer {customer_id} an account invite using 2020-01.
        slots:
          customer_id: path.customer_id
      - text: Invite shopper {customer_id} to set up their account, January 2020 release.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/account_activation_url.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a customer account activation link (API 2020-04)
      effect: write
      questions:
      - What April 2020 endpoint returns an activation URL for a customer whose account is still disabled?
      - Is the account activation link generated per customer on API 2020-04?
      instructions:
      - text: Create an activation URL for customer {customer_id} on 2020-04.
        slots:
          customer_id: path.customer_id
      - text: Give me the account activation link for {customer_id} from the April 2020 API.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-04/customers/{customer_id}/send_invite.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a customer an account invite (API 2020-04)
      effect: write
      questions:
      - How can I send a customer their account invite email with the April 2020 API?
      - Does version 2020-04 have a send_invite call for customers?
      instructions:
      - text: Email an account invitation to customer {customer_id} via 2020-04.
        slots:
          customer_id: path.customer_id
      - text: On the April 2020 release, send the invite to shopper {customer_id}.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/account_activation_url.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a customer account activation link (API 2020-07)
      effect: write
      questions:
      - Where do I get an account activation URL for an unactivated customer on the July 2020 API?
      - Can the 2020-07 release hand back an activation link instead of emailing it?
      instructions:
      - text: Generate customer {customer_id}'s activation URL with version 2020-07.
        slots:
          customer_id: path.customer_id
      - text: 'July 2020 API: produce an activation link for customer {customer_id}.'
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-07/customers/{customer_id}/send_invite.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a customer an account invite (API 2020-07)
      effect: write
      questions:
      - What's the July 2020 call to email a customer an account invite?
      - Is sending a customer account invite a POST on the 2020-07 API?
      instructions:
      - text: Send an account invite to customer {customer_id} on 2020-07.
        slots:
          customer_id: path.customer_id
      - text: Use the July 2020 release to invite {customer_id} to create an account.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/account_activation_url.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a customer account activation link (API 2020-10)
      effect: write
      questions:
      - How do I get an activation URL for a customer who never activated their account, on the 2020-10 API?
      - Which October 2020 endpoint creates a customer account activation link?
      instructions:
      - text: Create an account activation URL for customer {customer_id}, API 2020-10.
        slots:
          customer_id: path.customer_id
      - text: Get a new activation link for customer {customer_id} on the October 2020 version.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2020-10/customers/{customer_id}/send_invite.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a customer an account invite (API 2020-10)
      effect: write
      questions:
      - Can I email a customer an invite to activate their account with the current 2020-10 API?
      - Which October 2020 call sends a customer account invitation?
      instructions:
      - text: Send customer {customer_id} an account invite on 2020-10.
        slots:
          customer_id: path.customer_id
      - text: Email the account invitation to {customer_id} via the October 2020 release.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/account_activation_url.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a customer account activation link (API 2021-01)
      effect: write
      questions:
      - How can I produce an activation URL for a disabled customer account on 2021-01?
      - Does the January 2021 release still generate customer activation links?
      instructions:
      - text: Generate an activation link for customer {customer_id} via 2021-01.
        slots:
          customer_id: path.customer_id
      - text: 'January 2021 API: create account activation URL for {customer_id}.'
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/2021-01/customers/{customer_id}/send_invite.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a customer an account invite (API 2021-01)
      effect: write
      questions:
      - What 2021-01 call emails a shopper an invitation to their store account?
      - Can I resend a customer's account invite on the January 2021 API?
      instructions:
      - text: Invite customer {customer_id} to their account using 2021-01.
        slots:
          customer_id: path.customer_id
      - text: Send the account invite email to {customer_id}, January 2021 release.
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/account_activation_url.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Get a customer account activation link (unstable)
      effect: write
      questions:
      - Can the unstable API generate an account activation URL for a customer?
      - What unstable endpoint returns an activation link for an inactive customer?
      instructions:
      - text: Generate an activation URL for customer {customer_id} on unstable.
        slots:
          customer_id: path.customer_id
      - text: 'Unstable channel: create account activation link for {customer_id}.'
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'
- target: $.paths['/admin/api/unstable/customers/{customer_id}/send_invite.json'].post
  update:
    x-apievangelist-phrasing:
      intent: Email a customer an account invite (unstable API)
      effect: write
      questions:
      - Is there an unstable-channel call to send a customer an account invite?
      - How do I email an account invitation to a shopper via the unstable API?
      instructions:
      - text: Send customer {customer_id} an account invite via unstable.
        slots:
          customer_id: path.customer_id
      - text: 'Unstable channel: invite shopper {customer_id} to create an account.'
        slots:
          customer_id: path.customer_id
      method: generated
      generated: '2026-09-24'