In your app
A function makes the call on the client it is given, so your code passes the real one and a test passes a fake.Add the function
src/attract/create-team-member.ts
Call it
A script makes the client once and calls the function:A route handler, a job or a queue worker calls it the same way.
scripts/create-team-member.ts
Terminal
Required parameters
Required parameters
Optional parameters
Optional parameters
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.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).Optional. Leave it out and the site uses
"". e.g. “Founder” or “Operations lead”.Optional. Leave it out and the site uses
"". Optional one-liner shown on the compact card layouts — a motto, specialty or fun fact.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.Optional. Leave it out and the site uses
0. Members are listed lowest number first — the explicit team order.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.Optional. Leave it out and the site uses
"public". Select whether this content is public or private. One of public, loginRequired.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.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.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.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.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.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.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.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.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.Returns
Returns
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).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. One of public, loginRequired; a newer site may send others, so keep a fallback.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). At most 4 items.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.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. At most 1 items.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. One of manual, demo; a newer site may send others, so keep a fallback.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). Format: an ISO 8601 date and time.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.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; catch only what you want to react to (see Errors and testing).
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 your sites (createSiteClients()) don’t have.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). In published mode (the default) it goes live too, so the key also needscontent:team-members:publish(or a master above it); sendaposMode=draftto 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 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) on the client for longer.
Test it
It calls the function above with a fake client: the fake answers every call with a valid example, so nothing leaves your machine and no settings or key are needed. Run it withnode --test.
tests/teamMembers-createTeamMember.test.ts
teamMembers.createTeamMember with factories.TeamMember({...}), the fields you give over a valid example.
tests/teamMembers-createTeamMember-answer.test.ts
Related
List a team member’s locales
site.teamMembers().getTeamMemberLocales()List team members
site.teamMembers().listTeamMembers()Get a team member
site.teamMembers().getTeamMember()Replace a team member
site.teamMembers().replaceTeamMember()Delete a team member
site.teamMembers().deleteTeamMember()Update a team member
site.teamMembers().updateTeamMember()POST /team-member
The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.