Skip to content
Navigation

Sherpo customer API

Rich text fields come back as HTML in a closed format, wrapped in <rich-text version="1">, as stored once validated. Allowed: p, h1 (Title), h2 (Heading), h3 (Subheading), br; marks strong, em, u, s, sup, sub, code (b as strong, i as em, del as s, strike as s); a with href (http, https, mailto, tel, ftp, ftps, callto, sms, cid, xmpp, irc, ircs or a relative path), target="_blank"; span with style color or background-color (#rgb or #rrggbb); style text-align (left, center, right, justify) on p and h1 to h3; ul; ol (start); li (data-checked="true" or "false" for a task list); table, thead, tbody, tr, th, td (colspan, rowspan); pre with one code (class="language-<id>", the id one of bash, c, cpp, csharp, css, go, xml, java, javascript, json, kotlin, markdown, php, python, ruby, rust, sql, swift, typescript, yaml); blockquote; hr; details (open) with its summary first; figure with at most one figcaption, first or last; a link's rel (noopener, noreferrer, nofollow) is read and never stored. Images, videos, audio, slideshows, formulas, diagrams, downloads and other blocks are <block type="…" props="{…JSON…}"></block> elements (no raw img or video); which types a field takes is in its description. Example:

Welcome

Start with the intro, then read the notes.

  • Watch the intro

  • Take the quiz

Why it works

Short lessons stick.

The guide: https://api.sherpo.io/customer/docs/text.

profile

contact

billing

checkout

store

visit

product

entry

feed

page

body

prompt

attachment

media

progress

completion

notification

push

order

subscription

grant

entitlement

review

ticket

event

quiz

attempt

certificate

license

portfolio

software

Type to search…

↑↓ navigate↵ selectEsc close