Generated by API Evangelist
Written by API Evangelist tooling for Square's API. It is a proposal applied on top of the contract, not a document Square publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Square Snippets API
version: 1.0.0
extends: openapi/square-snippets-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['/v2/sites/{site_id}/snippet'].get
update:
x-apievangelist-phrasing:
intent: Get my snippet on a Square Online site
effect: read
questions:
- What code snippet has my app added to a Square Online site?
- Can I see the snippet another app added, or only my own?
instructions:
- text: Get my snippet on site {site_id}.
slots:
site_id: path.site_id
- text: Show the code my app injected into site {site_id}.
slots:
site_id: path.site_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/sites/{site_id}/snippet'].post
update:
x-apievangelist-phrasing:
intent: Add or update a snippet on a site
effect: write
questions:
- How do I add a script to the head of every page on a Square Online site?
- Does an added snippet also appear on checkout pages?
instructions:
- text: Add snippet {snippet} to site {site_id}.
slots:
snippet: requestBody.snippet
site_id: path.site_id
- text: Update the snippet on Square Online site {site_id} with {snippet}.
slots:
site_id: path.site_id
snippet: requestBody.snippet
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/sites/{site_id}/snippet'].delete
update:
x-apievangelist-phrasing:
intent: Remove my snippet from a site
effect: destructive
questions:
- How do I remove the code my app added to a Square Online site?
- Can I delete my snippet from one site but keep it on others?
instructions:
- text: Delete my snippet from site {site_id}.
slots:
site_id: path.site_id
- text: Remove the injected code from Square Online site {site_id}.
slots:
site_id: path.site_id
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.