Scope3 · OpenAPI Overlay 1.0.0
API Evangelist conversational phrasing for Scope3 Account API
19 actions
19 updates
phrasing
extends
openapi/scope3-account-api-openapi.yml
Generated by API Evangelist
Written by API Evangelist tooling for Scope3's API. It is a proposal applied on top of the contract, not a document Scope3 publishes.
What the actions change
x-apievangelist-phrasing
Targets 19 · first 16 shown; the file carries all of them
$.info
$.paths['/accounts/current'].get
$.paths['/accounts'].get
$.paths['/accounts/create-child'].post
$.paths['/accounts/{customerId}/domain'].patch
$.paths['/accounts/{customerId}'].delete
$.paths['/accounts/{customerId}/membership'].get
$.paths['/accounts/{customerId}/membership'].patch
$.paths['/browser-origins'].get
$.paths['/browser-origins'].post
$.paths['/browser-origins/{id}'].delete
$.paths['/notification-preferences'].get
$.paths['/notification-preferences'].put
$.paths['/notification-delivery-preferences'].get
$.paths['/notification-delivery-preferences'].put
$.paths['/market-readiness'].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 Scope3 Account API
version: 1.0.0
extends: openapi/scope3-account-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: 18
- target: $.paths['/accounts/current'].get
update:
x-apievangelist-phrasing:
intent: Get my current account
effect: read
questions:
- Which customer account am I currently working in?
- Can I see the account context for my login?
instructions:
- text: Show my current account.
- text: Tell me which customer account I'm signed into.
method: generated
generated: '2026-10-01'
- target: $.paths['/accounts'].get
update:
x-apievangelist-phrasing:
intent: List accounts I belong to
effect: read
questions:
- Which customer accounts do I have membership on?
- Can I see all the orgs my user can access?
instructions:
- text: List all my customer accounts.
- text: Show every account I'm a member of.
method: generated
generated: '2026-10-01'
- target: $.paths['/accounts/create-child'].post
update:
x-apievangelist-phrasing:
intent: Create a child account
effect: write
questions:
- How do I create a child account under my organization?
- Do I need admin rights to add a child customer account?
instructions:
- text: Create a child account named {name} with role {customerRole}.
slots:
name: requestBody.name
customerRole: requestBody.customerRole
- text: Add child account {name} as {customerRole} with default currency {defaultCurrency}.
slots:
name: requestBody.name
customerRole: requestBody.customerRole
defaultCurrency: requestBody.defaultCurrency
method: generated
generated: '2026-10-01'
- target: $.paths['/accounts/{customerId}/domain'].patch
update:
x-apievangelist-phrasing:
intent: Update an organization's domain
effect: write
questions:
- Can I change the registered organization domain for a customer?
- Who is allowed to update a customer's domain?
instructions:
- text: Set the domain of customer {customerId} to {customerDomain}.
slots:
customerId: path.customerId
customerDomain: requestBody.customerDomain
- text: Update organization domain for {customerId} to {customerDomain}.
slots:
customerId: path.customerId
customerDomain: requestBody.customerDomain
method: generated
generated: '2026-10-01'
- target: $.paths['/accounts/{customerId}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a child account
effect: destructive
questions:
- Can I permanently delete a child customer account?
- Why would deleting a child account fail with a conflict?
instructions:
- text: Delete child account {customerId}.
slots:
customerId: path.customerId
- text: Hard-delete child customer {customerId}.
slots:
customerId: path.customerId
method: generated
generated: '2026-10-01'
- target: $.paths['/accounts/{customerId}/membership'].get
update:
x-apievangelist-phrasing:
intent: Get an org's membership settings
effect: read
questions:
- Is domain auto-join turned on for my organization?
- Can I check membership settings for a customer org?
instructions:
- text: Get membership settings for customer {customerId}.
slots:
customerId: path.customerId
- text: Check whether domain auto-join is enabled for {customerId}.
slots:
customerId: path.customerId
method: generated
generated: '2026-10-01'
- target: $.paths['/accounts/{customerId}/membership'].patch
update:
x-apievangelist-phrasing:
intent: Turn domain auto-join on or off
effect: write
questions:
- How do I let people with my company email join automatically?
- What's required before I can enable domain auto-join?
instructions:
- text: Set domain auto-join for customer {customerId} to {allowDomainAutoJoin}.
slots:
customerId: path.customerId
allowDomainAutoJoin: requestBody.allowDomainAutoJoin
- text: 'Enable domain auto-join on {customerId}: {allowDomainAutoJoin}.'
slots:
customerId: path.customerId
allowDomainAutoJoin: requestBody.allowDomainAutoJoin
method: generated
generated: '2026-10-01'
- target: $.paths['/browser-origins'].get
update:
x-apievangelist-phrasing:
intent: List allowed browser origins
effect: read
questions:
- Which browser origins can call the MCP and OAuth endpoints for my account?
- Can I review the CORS-allowed origins on my account?
instructions:
- text: List my allowed browser origins.
- text: Show the origins registered for browser MCP access.
method: generated
generated: '2026-10-01'
- target: $.paths['/browser-origins'].post
update:
x-apievangelist-phrasing:
intent: Register a browser origin
effect: write
questions:
- How do I allow my web app's origin to call the MCP endpoints from a browser?
- Can a registered browser origin include a path or wildcard?
instructions:
- text: Register browser origin {origin}.
slots:
origin: requestBody.origin
- text: Allow origin {origin} labeled {label} for browser MCP and OAuth calls.
slots:
origin: requestBody.origin
label: requestBody.label
method: generated
generated: '2026-10-01'
- target: $.paths['/browser-origins/{id}'].delete
update:
x-apievangelist-phrasing:
intent: Remove a browser origin
effect: destructive
questions:
- Can I revoke CORS access for a browser origin I registered?
- What happens to an origin once I delete it?
instructions:
- text: Delete browser origin {id}.
slots:
id: path.id
- text: Archive origin {id} so it loses CORS access.
slots:
id: path.id
method: generated
generated: '2026-10-01'
- target: $.paths['/notification-preferences'].get
update:
x-apievangelist-phrasing:
intent: Get my notification opt-ins
effect: read
questions:
- Which notifications have I opted into?
- Can I see my personal notification preferences?
instructions:
- text: Show my notification preferences.
- text: List the notifications I've opted into.
method: generated
generated: '2026-10-01'
- target: $.paths['/notification-preferences'].put
update:
x-apievangelist-phrasing:
intent: Set my notification opt-ins
effect: write
questions:
- How do I change which notifications I receive?
- Does updating my opt-ins replace the existing ones?
instructions:
- text: Set my notification opt-ins to {optIns}.
slots:
optIns: requestBody.optIns
- text: Replace my notification preferences with {optIns}.
slots:
optIns: requestBody.optIns
method: generated
generated: '2026-10-01'
- target: $.paths['/notification-delivery-preferences'].get
update:
x-apievangelist-phrasing:
intent: Get Slack notification settings
effect: read
questions:
- Are product updates and outage alerts going to our Slack channel?
- Which Slack channel receives my account's alerts?
instructions:
- text: Show my account's Slack notification settings.
- text: Check whether source outage alerts are on in Slack.
method: generated
generated: '2026-10-01'
- target: $.paths['/notification-delivery-preferences'].put
update:
x-apievangelist-phrasing:
intent: Change a Slack notification setting
effect: write
questions:
- Can I turn off product update messages in our Slack channel?
- How quickly can source outage alerts be sent to Slack?
instructions:
- text: Turn off Product Updates in our Slack channel.
- text: Send source outage alerts to Slack after 30 minutes.
method: generated
generated: '2026-10-01'
- target: $.paths['/market-readiness'].post
update:
x-apievangelist-phrasing:
intent: Preview market readiness by country and channel
effect: read
questions:
- Is a given country and channel open for buying yet?
- What supply evidence exists for a market I want to enter?
instructions:
- text: Preview market readiness for cells {cells}.
slots:
cells: requestBody.cells
- text: Check pilot state and supply for country-channel cells {cells}.
slots:
cells: requestBody.cells
method: generated
generated: '2026-10-01'
- target: $.paths['/readiness'].get
update:
x-apievangelist-phrasing:
intent: Get my buyer readiness
effect: read
questions:
- What do I still need to do before my buyer account can activate?
- Which destinations am I ready to buy on?
instructions:
- text: Show my buyer readiness.
- text: List per-destination buying readiness for my account.
method: generated
generated: '2026-10-01'
- target: $.paths['/readiness/operator'].patch
update:
x-apievangelist-phrasing:
intent: Set my buyer operator domain
effect: write
questions:
- How do I confirm the commercial operator domain on my buyer account?
- Can I change my operator domain without changing the organization?
instructions:
- text: Set my buyer operator domain to {operatorDomain}.
slots:
operatorDomain: requestBody.operatorDomain
- text: Confirm {operatorDomain} as our commercial operator domain.
slots:
operatorDomain: requestBody.operatorDomain
method: generated
generated: '2026-10-01'
- target: $.paths['/accounts/liveness'].get
update:
x-apievangelist-phrasing:
intent: Check storefront liveness for seller accounts
effect: read
questions:
- Are my sellers' storefronts live or in a critical state?
- Can I check liveness for several seller accounts at once?
instructions:
- text: Get storefront liveness for customers {customerIds}.
slots:
customerIds: query.customerIds
- text: Show storefront liveness verdicts for my seller accounts.
method: generated
generated: '2026-10-01'