> ## Documentation Index
> Fetch the complete documentation index at: https://docs.fetchski-attract.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update a team member

> Update an existing team member.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const teamMember = await site.teamMembers().updateTeamMember({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "role": "Example role",
  "tagline": "Example tagline",
  "bio": "Example bio",
  "featured": false,
  "sortOrder": 0,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "memberFontOverrides": [],
  "_photo": [
    {}
  ],
  "photoUrl": "https://acme.example/example",
  "_hoverPhoto": [
    {}
  ],
  "hoverPhotoUrl": "https://acme.example/example",
  "email": "jo@acme.example",
  "phone": "Example phone",
  "socialLinks": [],
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z",
  "aposShareKey": "k3v9x2m7q1z8w4p6"
}
```

## In your app

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

**1. Add the controller**

```ts app/controllers/update_team_member_controller.ts theme={"dark"}
import { inject } from '@adonisjs/core'
import type { HttpContext } from '@adonisjs/core/http'
import { SiteClient } from '@fetchski/attract-cms-sdk'

@inject()
export default class UpdateTeamMemberController {
  constructor(protected site: SiteClient) {}

  async handle({ params }: HttpContext) {
    return this.site.teamMembers().updateTeamMember({ id: params.id })
  }
}
```

**2. Add the route**

```ts start/routes.ts theme={"dark"}
import router from '@adonisjs/core/services/router'

const UpdateTeamMemberController = () => import('#controllers/update_team_member_controller')

router.patch('/team-member/:id', [UpdateTeamMemberController])
```

Put it behind your auth middleware (`.use(middleware.auth())`): it acts with your key’s access.

**3. Call it**

Your own page’s form or script sends `PATCH /team-member/clx8m2k4p0000a1b2c3d4e5f6` and gets back its answer as JSON. Test it, below, calls it.

## 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.

```ts AdonisJS wrap theme={"dark"}
import app from '@adonisjs/core/services/app'
import { SiteClient } from '@fetchski/attract-cms-sdk'

const site = await app.container.make(SiteClient)
const row = (await site.teamMembers().listTeamMembersPick(['title', 'slug'])).find((each) => each.slug === 'getting-started') // { id, title, slug }, or undefined
```

Pass `row.id` as `id`. Drafts: list with `{ aposMode: 'draft' }` to get the draft’s id ([Find an id](https://docs.fetchski-attract.com/find-an-id.md)).

> [accordion] Required parameters
>
> One object, e.g. `updateTeamMember({ id })`; leave out the optional fields.
>
> **id** `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`).

> [accordion] Optional parameters
>
> **aposMode** `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`.
>
> **aposLocale** `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).
>
> **title** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **role** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. e.g. “Founder” or “Operations lead”.
>
> **tagline** `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.
>
> **bio** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Optional short biography, shown on the roomier card layouts.
>
> **featured** `boolean | null | undefined`
>
> **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.
>
> **sortOrder** `number | null | undefined`
>
> **Optional.** Leave it out and the site uses `0`. Members are listed lowest number first — the explicit team order.
>
> **slug** `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).
>
> **visibility** `Visibility | null | undefined`
>
> **Optional.** Leave it out and the site uses `"public"`. Select whether this content is public or private. One of `public`, `loginRequired`.
>
> **scheduledPublish** `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`.
>
> **scheduledUnpublish** `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`.
>
> **memberFontOverrides** `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.
>
> **TeamMemberMemberFontOverridesItem**
>
> **id** `string`
>
> The row’s id, unique in its array.
>
> **target** `Target | null`
>
> Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`.
>
> **source** `Source | null`
>
> Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`.
>
> **slot** `Slot | null`
>
> Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`.
>
> **curated** `Curated | null`
>
> Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`.
>
> **cdnProvider** `CdnProvider | null`
>
> Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`.
>
> **cdnFamily** `string`
>
> Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.
>
> **cdnWeights** `string`
>
> Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.
>
> **uploads** `readonly TeamMemberMemberFontOverridesItemUploadsItem[]`
>
> A list of `TeamMemberMemberFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.
>
> **TeamMemberMemberFontOverridesItemUploadsItem**
>
> **file** `Readonly\<Record\<string, unknown\>\>` *required*
>
> **Required.** File attachment reference.
>
> **id** `string`
>
> The row’s id, unique in its array.
>
> **weight** `Weight | null`
>
> Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`.
>
> **style** `Style | null`
>
> Style. One of `normal`, `italic`.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> Optional: any keys not listed above, by their wire names; they are sent with the rest.
>
> **fallback** `Fallback | null`
>
> Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> Optional: any keys not listed above, by their wire names; they are sent with the rest.
>
> **photo** `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.
>
> **photoUrl** `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.
>
> **hoverPhoto** `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.
>
> **hoverPhotoUrl** `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.
>
> **email** `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.
>
> **phone** `string | null | undefined`
>
> **Optional.** Leave it out and the site uses `""`. Optional. Only shown when the Team section has “Show email / phone” turned on.
>
> **socialLinks** `readonly TeamMemberSocialLinksItem[] | null | undefined`
>
> **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.
>
> **TeamMemberSocialLinksItem**
>
> **platform** `Platform` *required*
>
> **Required.** Platform. One of `instagram`, `facebook`, `x-twitter`, `youtube`, `tiktok`, `linkedin`, `github`, `pinterest`, `whatsapp`, `snapchat`, `threads`, `bluesky`, `mastodon`, `yelp`, `google`, `spotify`, `vimeo`, `custom`.
>
> **url** `string` *required*
>
> **Required.** Full link to the profile, e.g. [https://instagram.com/yourbusiness](https://instagram.com/yourbusiness). Format: an absolute URL.
>
> **id** `string`
>
> The row’s id, unique in its array.
>
> **label** `string`
>
> Overrides the screen-reader / tooltip label. Recommended for a custom platform — defaults to the icon name (e.g. “discord” → “Discord”).
>
> **icon** `string`
>
> Font Awesome icon name (no “fa-” prefix), e.g. discord. Browse fontawesome.com/icons.
>
> **iconFamily** `IconFamily | null`
>
> Custom icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> Optional: any keys not listed above, by their wire names; they are sent with the rest.
>
> **archived** `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.

> [accordion] 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`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **slug** `string`
>
> **Always sent.** The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **id** `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.
>
> **type** `string`
>
> **Always sent.** The document type’s name: always this type’s.
>
> **role** `string | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. e.g. “Founder” or “Operations lead”.
>
> **tagline** `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.
>
> **bio** `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.
>
> **featured** `boolean | null`
>
> **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.
>
> **sortOrder** `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** `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.
>
> **scheduledPublish** `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`.
>
> **scheduledUnpublish** `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`.
>
> **memberFontOverrides** `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.
>
> **TeamMemberMemberFontOverridesItem**
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **target** `Target | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Which text this typeface replaces. Rows apply in order, so a broad row (Everything) followed by a narrow one (Headings) gives the section a base face plus an exception. One of `all`, `heading`, `body`, `eyebrow`, `button`, `code`; a newer site may send others, so keep a fallback.
>
> **source** `Source | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where the typeface comes from. The first option costs nothing extra — those faces are already loaded. The others load an additional font on pages that use this section. One of `slot`, `curated`, `cdn`, `upload`; a newer site may send others, so keep a fallback.
>
> **slot** `Slot | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Set in Site design → Typography. Following the site’s own faces keeps a section on-brand and adds no download. One of `display`, `body`, `accent`; a newer site may send others, so keep a fallback.
>
> **curated** `Curated | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Vetted families from Bunny Fonts and Fontshare, with their available weights already verified. One of `archivo`, `bricolage-grotesque`, `clash-display`, `courier-prime`, `dm-mono`, `dm-sans`, `fira-code`, `fraunces`, `general-sans`, `ibm-plex-mono`, `ibm-plex-sans`, `inconsolata`, `inter`, `jetbrains-mono`, `karla`, `lora`, `manrope`, `nunito-sans`, `outfit`, `playfair-display`, `public-sans`, `red-hat-mono`, `satoshi`, `sentient`, `sora`, `source-code-pro`, `source-sans-3`, `source-serif-4`, `space-grotesk`, `space-mono`, `spline-sans-mono`, `supreme`, `switzer`, `syne`, `ubuntu-mono`, `unbounded`, `victor-mono`, `work-sans`, `zodiak`; a newer site may send others, so keep a fallback.
>
> **cdnProvider** `CdnProvider | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Where to browse for the family. Pick one, then follow the link below to find the exact name. One of `bunny`, `fontshare`; a newer site may send others, so keep a fallback.
>
> **cdnFamily** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Exactly as the provider’s catalog spells it, e.g. "Space Grotesk" or "Clash Display". A name the provider doesn’t have loads nothing and this row is ignored.
>
> **cdnWeights** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Comma-separated weights to load, e.g. 400, 700. Empty loads 400, 500, 700. Weights the family doesn’t ship are skipped by the CDN and synthesized by the browser (faux bold) — but a family that ships only ONE weight (Acme, for instance) loads nothing at all unless that weight is among these, so set it explicitly if the typeface doesn’t appear.
>
> **uploads** `readonly TeamMemberMemberFontOverridesItemUploadsItem[]`
>
> **Sometimes sent:** `undefined` when the site leaves it out. A list of `TeamMemberMemberFontOverridesItemUploadsItem`. One file per weight/style of the SAME typeface. woff2 strongly recommended (smallest, universally supported); woff/ttf/otf also accepted. At most 4 items.
>
> **TeamMemberMemberFontOverridesItemUploadsItem**
>
> **file** `Readonly\<Record\<string, unknown\>\>`
>
> **Always sent.** File attachment reference.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **weight** `Weight | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.
>
> **style** `Style | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.
>
> **fallback** `Fallback | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Generic system font shown while this typeface loads (and if it fails). Curated picks set this automatically. One of `sans`, `serif`, `mono`; a newer site may send others, so keep a fallback.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.
>
> **photo** `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.
>
> **photoUrl** `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.
>
> **hoverPhoto** `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.
>
> **hoverPhotoUrl** `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.
>
> **email** `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.
>
> **phone** `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.
>
> **socialLinks** `readonly TeamMemberSocialLinksItem[] | null`
>
> **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.
>
> **TeamMemberSocialLinksItem**
>
> **platform** `Platform`
>
> **Always sent.** Platform. One of `instagram`, `facebook`, `x-twitter`, `youtube`, `tiktok`, `linkedin`, `github`, `pinterest`, `whatsapp`, `snapchat`, `threads`, `bluesky`, `mastodon`, `yelp`, `google`, `spotify`, `vimeo`, `custom`; a newer site may send others, so keep a fallback.
>
> **url** `string`
>
> **Always sent.** Full link to the profile, e.g. [https://instagram.com/yourbusiness](https://instagram.com/yourbusiness). Format: an absolute URL.
>
> **id** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. The row’s id, unique in its array.
>
> **label** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Overrides the screen-reader / tooltip label. Recommended for a custom platform — defaults to the icon name (e.g. “discord” → “Discord”).
>
> **icon** `string`
>
> **Sometimes sent:** `undefined` when the site leaves it out. Font Awesome icon name (no “fa-” prefix), e.g. discord. Browse fontawesome.com/icons.
>
> **iconFamily** `IconFamily | null`
>
> **Sometimes sent:** `undefined` when the site leaves it out, and it can be `null`. Custom icon family. One of `classic-regular`, `duotone-regular`, `brands`, `jelly`, `jelly-duo`, `whiteboard`; a newer site may send others, so keep a fallback.
>
> **fields** `Readonly\<Record\<string, unknown\>\>`
>
> **Always there:** `{}` when there are none. Any keys the site sent that aren’t listed above (such as one added after this SDK was built), by their wire names, as sent. Pass this model to a write and they are sent too.
>
> **source** `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.
>
> **sourceId** `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.
>
> **archived** `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.
>
> **createdAt** `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.
>
> **updatedAt** `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.
>
> **aposShareKey** `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.

> [accordion] 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](https://docs.fetchski-attract.com/adonisjs/calling-the-api.md#map-sdk-errors-to-responses)); catch only what you want to react to here.
>
> **ValidationFailed** `400`
>
> The site refused what was sent: `errors` lists each field’s problem, `siteMessage` the first.
>
> **Retried first:** No. **Read:** `errors` (field → messages), `siteMessage`.
>
> **AuthenticationFailed** `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`.
>
> **Forbidden** `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`.
>
> **NotFound** `404`
>
> Nothing matches, or the caller may not see it.
>
> **Retried first:** No. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteError** `500`
>
> The site failed. Its logs say why.
>
> **Retried first:** No: a write may have landed. **Read:** `siteMessage`, `errorName`, `data`.
>
> **SiteUnreachable** `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`.
>
> **RequestNotSent** `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).
>
> **SiteRequestFailed** `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`.
>
> **UnknownSite** `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`.
>
> **SiteConfigurationError** `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_update_team_member.spec.ts`, then run your tests:

```ts tests/unit/team_members_update_team_member.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import app from '@adonisjs/core/services/app'
import testUtils from '@adonisjs/core/services/test_utils'
import { fakeAttract } from '@fetchski/attract-cms-adonis/testing'
import UpdateTeamMemberController from '#controllers/update_team_member_controller'

test('teamMembers.updateTeamMember', async () => {
  const site = fakeAttract()

  const ctx = await testUtils.createHttpContext()
  ctx.params = { id: 'clx8m2k4p0000a1b2c3d4e5f6' }
  const controller = await app.container.make(UpdateTeamMemberController)
  await controller.handle(ctx)

  site.assertCalled('teamMembers.updateTeamMember', (args) => args.id === 'clx8m2k4p0000a1b2c3d4e5f6')
})
```

```bash Terminal theme={"dark"}
node ace test
```

**Answer with your own values:** fake `teamMembers.updateTeamMember` with `factories.TeamMember({...})`, the fields you give over a valid example.

```ts tests/unit/team_members_update_team_member_answers.spec.ts theme={"dark"}
import { test } from '@japa/runner'
import { factories, fakeAttract } from '@fetchski/attract-cms-adonis/testing'

test('teamMembers.updateTeamMember answers your values', async ({ assert }) => {
  const site = fakeAttract({
    'teamMembers.updateTeamMember': factories.TeamMember({ title: 'Your value' }),
  })

  const teamMember = await site.teamMembers().updateTeamMember({ id: 'clx8m2k4p0000a1b2c3d4e5f6' })
  assert.containSubset(teamMember, { title: 'Your value' })
})
```

## Related

> [card] [List a team member’s locales](https://docs.fetchski-attract.com/adonisjs/reference/team-members/get-team-member-locales.md)
>
> `site.teamMembers().getTeamMemberLocales()`

> [card] [List team members](https://docs.fetchski-attract.com/adonisjs/reference/team-members/list-team-members.md)
>
> `site.teamMembers().listTeamMembers()`

> [card] [Create a team member](https://docs.fetchski-attract.com/adonisjs/reference/team-members/create-team-member.md)
>
> `site.teamMembers().createTeamMember()`

> [card] [Get a team member](https://docs.fetchski-attract.com/adonisjs/reference/team-members/get-team-member.md)
>
> `site.teamMembers().getTeamMember()`

> [card] [Replace a team member](https://docs.fetchski-attract.com/adonisjs/reference/team-members/replace-team-member.md)
>
> `site.teamMembers().replaceTeamMember()`

> [card] [Delete a team member](https://docs.fetchski-attract.com/adonisjs/reference/team-members/delete-team-member.md)
>
> `site.teamMembers().deleteTeamMember()`

> [card] [PATCH /team-member/\{\_id}](https://docs.fetchski-attract.com/api-reference/team-members/update-a-team-member.md)
>
> The endpoint this calls, in the API reference: the HTTP request and answer, and every rule the site checks.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.