In your app
A controller answers a route on your app: it callsrevertTeamMemberDraftToPublished() and returns the answer.
Add the controller
app/controllers/revert_team_member_draft_to_published_controller.ts
Add the route
start/routes.ts
.use(middleware.auth())): it acts with your key’s access.Call it
Your own page’s form or script sends
POST /team-member/clx8m2k4p0000a1b2c3d4e5f6/revert-draft-to-published and gets back its answer as JSON. Test it, below, calls it.false when it had no changes to discard).
Find the id
id is the document’s _id, from a list. Ask the list for only the fields you need: each row is a document’s id and those fields.
AdonisJS
row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).
Required parameters
Required parameters
One object, e.g.
revertTeamMemberDraftToPublished({ id }); leave out the optional fields.Returns
Returns
TeamMember | false: the TeamMember, or false. TeamMember content type. Read its properties (teamMember.title): each says whether the site always sends it. The example answer is the site’s wire JSON: some keys differ from the property names (_id → id, _photo → photo, _hoverPhoto → hoverPhoto).Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.
Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
Always sent. The document’s id. On a type with drafts it ends in its locale and mode (
…:en:published, …:en:draft): the part before the first colon is its aposDocId, shared by both copies. The {_id} the type’s routes take.Sometimes sent:
undefined when the site leaves it out, and it can be null. e.g. “Founder” or “Operations lead”.Sometimes sent:
undefined when the site leaves it out, and it can be null. Optional one-liner shown on the compact card layouts — a motto, specialty or fun fact.Sometimes sent:
undefined when the site leaves it out, and it can be null. Optional short biography, shown on the roomier card layouts.Sometimes sent:
undefined when the site leaves it out, and it can be null. Hand-curation flag. The widget can show only featured members, and the Spotlight layout renders them large.Sometimes sent:
undefined when the site leaves it out, and it can be null. Members are listed lowest number first — the explicit team order.Sometimes sent:
undefined when the site leaves it out, and it can be null. Select whether this content is public or private.Sometimes sent:
undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Sometimes sent:
undefined when the site leaves it out, and it can be null. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.Sometimes sent:
undefined when the site leaves it out, and it can be null. A list of TeamMemberMemberFontOverridesItem. Optional. Set part of this team member’s card in a different typeface. Leave empty to follow the section (and the site fonts).Sometimes sent:
undefined when the site leaves it out, and it can be null. Optional headshot from the media library. Falls back to the Photo URL below, then to a lettered-initial avatar. The related @apostrophecms/image documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out.Sometimes sent:
undefined when the site leaves it out, and it can be null. Alternative to uploading: a full https:// link to a photo hosted elsewhere. Only used when no Photo is selected above — prefer uploading when you can (it enables cropping, focal point and responsive sizes). When set, a URL; empty or null when not.Sometimes sent:
undefined when the site leaves it out, and it can be null. Optional second photo (e.g. a candid shot) that cross-fades in when a visitor hovers the card. Needs the Team section’s hover-photo toggle on. The related @apostrophecms/image documents, in order (empty when none). To set it, send a list of { "_id": "…" }, one per document (one at most); a document the site can’t find is left out.Sometimes sent:
undefined when the site leaves it out, and it can be null. URL alternative to the alternate photo above — only used when none is selected. Same hover behavior. When set, a URL; empty or null when not.Sometimes sent:
undefined when the site leaves it out, and it can be null. Optional. Only shown when the Team section has “Show email / phone” turned on. When set, an email address; empty or null when not.Sometimes sent:
undefined when the site leaves it out, and it can be null. Optional. Only shown when the Team section has “Show email / phone” turned on.Sometimes sent:
undefined when the site leaves it out, and it can be null. A list of TeamMemberSocialLinksItem. Each profile is optional — add only the networks you use. A link only appears once it has a URL. Pick a platform for its brand icon, or “Other / custom” to choose any icon.Sometimes sent:
undefined when the site leaves it out, and it can be null. Set automatically. Demo placeholders are removed the moment a real member is published.Sometimes sent:
undefined when the site leaves it out, and it can be null. Internal de-duplication key set by the demo seed.Sometimes sent:
undefined when the site leaves it out, and it can be null. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.Sometimes sent:
undefined when the site leaves it out, and it can be null. When it was created (ISO 8601).Sometimes sent:
undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601).Sometimes sent:
undefined when the site leaves it out, and it can be null. The draft’s preview share key, while its share link is on: the link is the draft’s _url with aposShareKey and aposShareId (the draft’s _id) in its query. Absent otherwise, and on published documents.Errors
Errors
Nothing to catch: the SDK retries what is safe, and throws the rest as the classes below. Your exception handler turns them into your app’s own answers, once for every call (see Map SDK errors to responses); catch only what you want to react to here.
The site refused what was sent:
errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.The API key is missing or refused (malformed, revoked, expired), or a signature its signing mode needs is missing or stale.Retried first: No. Read:
siteMessage, errorName, data.The key may not do this: a scope it lacks, or an address outside its allowlist.
siteMessage names it.Retried first: No. Read: siteMessage, errorName, data.Nothing matches, or the caller may not see it.Retried first: No. Read:
siteMessage, errorName, data.The site failed. Its logs say why.Retried first: No: a write may have landed. Read:
siteMessage, errorName, data.No answer: DNS, a refused connection, TLS, or the timeout (15 s per attempt by default).Retried first: Only when nothing reached the site (
neverConnected()); never after a timeout, when it may have landed. Read: reason, neverConnected.The client refused to send it (e.g. a path segment of
..); the site never saw it.Retried first: No. Read: reason (what to change).Any other status, or a success whose JSON doesn’t match this SDK version’s types (update the SDK).Retried first: No. Read:
reason, status.sites.forSite('acme') named a slug config/attract.ts doesn’t list (with the keys in the database: no row in attract_api_keys).Retried first: No: nothing was sent. Read: message, slug.Behavior
- Access: an API key with
content:team-members:write(or a master above it:content:team-members:all,content:all,admin:all). A signed-in person may call it as far as their own permissions allow; anyone else gets 403. - Rate limit: the key’s own writes-per-minute limit, set when the key is created (default 120); over it, 429 with
Retry-After. The client waits and retries for you; you seeRateLimitedonly if that runs out. - Retries: a write is sent again only after a 429 (refused before it acted) or when it never reached the site. After a timeout or a 5xx it may have landed: check before you send it again.
- Timeout: 15 s per attempt by default; raise
timeout(milliseconds) inconfig/attract.tsfor longer.
Test it
It calls the controller above with the SDK faked:fakeAttract() puts the fake in the container for this one test, and it answers every call with a valid example, so nothing leaves your machine and no key is read. Save it as tests/unit/team_members_revert_team_member_draft_to_published.spec.ts, then run your tests:
tests/unit/team_members_revert_team_member_draft_to_published.spec.ts
Terminal
teamMembers.revertTeamMemberDraftToPublished with factories.TeamMember({...}), the fields you give over a valid example.
tests/unit/team_members_revert_team_member_draft_to_published_answers.spec.ts
Related
List a team member’s locales
site.teamMembers().getTeamMemberLocales()List team members
site.teamMembers().listTeamMembers()Create a team member
site.teamMembers().createTeamMember()Get a team member
site.teamMembers().getTeamMember()Replace a team member
site.teamMembers().replaceTeamMember()Delete a team member
site.teamMembers().deleteTeamMember()POST /team-member/{_id}/revert-draft-to-published
The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.