Check text against the approved words.
Compares copy you have (a source file, a template, a rendered email) with the approved words from GET /sites/{idOrSlug}/approved-copy. text is searched for every approved section; sections compares the text given for each key with that section. Each approved section comes back exact, differs (with difference: where the words part ways, the approved words and what was found) or missing. Sections not approved, or whose approved words could not be read, are not compared (match null, with a reason). Words are compared after the normalizing the response lists in normalized: tags, entities, source-code escapes, whitespace and curly quotes. Placeholders such as {first_name} are part of the approved words and compared as written. exact says the visible words match; it does not cover markup, links or images. At most 500 KB of copy per call (413 too_large). Owner-authed. A POST for the size of the body; it reads and stores nothing.
Request
- Base URL: https://api.stacktr.ee
- URL: https://api.stacktr.ee/sites/{idOrSlug}/approved-copy/check
- Auth: one of:
- HTTP bearer
- OAuth 2 (authorization code, authorization URL https://api.stacktr.ee/oauth/authorize, token URL https://api.stacktr.ee/oauth/token, scopes: sites:read)
Request body
Response
One result per section.
Changes
No recorded changes to this operation across all 1 revision of this API.