Skip to main content

In your app

A controller answers a route on your app: it calls replaceTeamMember() and returns the answer.

Add the controller

app/controllers/replace_team_member_controller.ts
The other values are the example’s: take yours from the request, a form or your database.

Add the route

start/routes.ts
Put it behind your auth middleware (.use(middleware.auth())): it acts with your key’s access.

Call it

Your own page’s form or script sends PUT /team-member/clx8m2k4p0000a1b2c3d4e5f6 and gets back its answer as JSON. Test it, below, calls it.
PATCH changes only the fields sent. Update an existing team member.

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
Pass row.id as id. Drafts: list with { aposMode: 'draft' } to get the draft’s id (Find an id).

Required parameters

One object, e.g. replaceTeamMember({ id }); leave out the optional fields.
string
required
Required. The document’s _id: a full id names its own locale and mode (the draft’s …:en:draft, the published one’s …:en:published; no aposMode needed), a bare aposDocId takes the request’s (aposLocale, aposMode).
string
required
Required. Its title: the name it goes by in every list, and the heading of its page where it has one.
AposMode | null | undefined
Optional. Leave it out and the site uses "published". published (the default) or draft. Drafts need a credential that may see them: an API key with the type’s write scope (content:<type>:write), or a signed-in editor. The public and a key with only the read scope get 403. One of draft, published.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. The locale to read or write, e.g. en (default: the site’s default locale).
string | null | undefined
Optional. Leave it out and the site uses "". e.g. “Founder” or “Operations lead”.
string | null | undefined
Optional. Leave it out and the site uses "". Optional one-liner shown on the compact card layouts — a motto, specialty or fun fact.
string | null | undefined
Optional. Leave it out and the site uses "". Optional short biography, shown on the roomier card layouts.
Optional. Leave it out and the site uses false. Hand-curation flag. The widget can show only featured members, and the Spotlight layout renders them large.
number | null | undefined
Optional. Leave it out and the site uses 0. Members are listed lowest number first — the explicit team order.
string | null | undefined
Optional. Leave it out and the site uses "". The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept). Left out, it’s made from the title.
Visibility | null | undefined
Optional. Leave it out and the site uses "public". Select whether this content is public or private. One of public, loginRequired.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. An ISO 8601 date and time, e.g. 2026-10-21T14:30:00.000Z.
readonly TeamMemberMemberFontOverridesItem[] | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Set part of this team member’s card in a different typeface. Leave empty to follow the section (and the site fonts). At most 4 items.
readonly Readonly<Record<string, unknown>>[] | null | undefined
Optional. 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. At most 1 items.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. 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.
readonly Readonly<Record<string, unknown>>[] | null | undefined
Optional. 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. At most 1 items.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. 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.
string | null | undefined
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. Optional. Only shown when the Team section has “Show email / phone” turned on. When set, an email address; empty or null when not.
string | null | undefined
Optional. Leave it out and the site uses "". Optional. Only shown when the Team section has “Show email / phone” turned on.
Optional. Leave it out (or pass null) and it isn’t sent: the site’s default applies. 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.
boolean | null | undefined
Optional. Leave it out and the site uses false. In the archive: kept, but out of every list and off the site until it is restored. false (or null) for a live document.
A TeamMember. 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).
string
Always sent. Its title: the name it goes by in every list, and the heading of its page where it has one.
string
Always sent. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
string
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.
string
Always sent. The document type’s name: always this type’s.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. e.g. “Founder” or “Operations lead”.
string | null
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.
string | null
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.
number | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Members are listed lowest number first — the explicit team order.
Visibility | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Select whether this content is public or private. One of public, loginRequired; a newer site may send others, so keep a fallback.
string | null
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.
string | null
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.
readonly TeamMemberMemberFontOverridesItem[] | null
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). At most 4 items.
readonly Readonly<Record<string, unknown>>[] | null
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. At most 1 items.
string | null
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.
readonly Readonly<Record<string, unknown>>[] | null
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. At most 1 items.
string | null
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.
string | null
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.
string | null
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.
FaqCategorySource | null
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. One of manual, demo; a newer site may send others, so keep a fallback.
string | null
Sometimes sent: undefined when the site leaves it out, and it can be null. Internal de-duplication key set by the demo seed.
boolean | null
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.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it was created (ISO 8601). Format: an ISO 8601 date and time.
Date | null
Sometimes sent: undefined when the site leaves it out, and it can be null. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
string | null
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.
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.
400
The site refused what was sent: errors lists each field’s problem, siteMessage the first.Retried first: No. Read: errors (field → messages), siteMessage.
401
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.
403
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.
404
Nothing matches, or the caller may not see it.Retried first: No. Read: siteMessage, errorName, data.
500
The site failed. Its logs say why.Retried first: No: a write may have landed. Read: siteMessage, errorName, data.
no answer
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.
not sent
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
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.
setup
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.
setup
The site’s entry is wrong: a malformed baseUrl or key, a key filed under another slug, or no default site. node ace attract:check names the fix.Retried first: No: nothing was sent. Read: message (what to fix).

Behavior

  • Access: an API key with content:team-members:write (or a master above it: content:team-members:all, content:all, admin:all). In published mode (the default) it goes live too, so the key also needs content:team-members:publish (or a master above it); send aposMode=draft (or a draft _id and no aposMode) to change only the draft. 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 see RateLimited only 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) in config/attract.ts for 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_replace_team_member.spec.ts, then run your tests:
tests/unit/team_members_replace_team_member.spec.ts
Terminal
Answer with your own values: fake teamMembers.replaceTeamMember with factories.TeamMember({...}), the fields you give over a valid example.
tests/unit/team_members_replace_team_member_answers.spec.ts

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()

Delete a team member

site.teamMembers().deleteTeamMember()

Update a team member

site.teamMembers().updateTeamMember()

PUT /team-member/{_id}

The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.