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

# Share a team member’s draft

> Turns the draft’s preview share link on or off.

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$teamMember = Attract::teamMembers()->shareTeamMember(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 `shareTeamMember()` and returns the answer.

**1. Add the controller**

```php app/Http/Controllers/ShareTeamMemberController.php theme={"dark"}
<?php

declare(strict_types=1);

namespace App\Http\Controllers;

use Fetchski\AttractCmsLaravel\Data\TeamMember;
use Fetchski\AttractCmsLaravel\Facades\Attract;

final class ShareTeamMemberController
{
    public function __invoke(string $id): TeamMember
    {
        return Attract::teamMembers()->shareTeamMember(id: $id);
    }
}
```

**2. Add the route**

```php routes/web.php theme={"dark"}
use App\Http\Controllers\ShareTeamMemberController;
use Illuminate\Support\Facades\Route;

Route::post('/team-member/{id}/share', ShareTeamMemberController::class)->middleware('auth');
```

It acts with your key’s access, so `auth` lets only your signed-in users reach it.

**3. Call it**

Your own page’s form or script sends `POST /team-member/clx8m2k4p0000a1b2c3d4e5f6/share` (a form adds `@csrf`, as every web route checks it), and gets back its answer as JSON. Test it, below, calls it.

> [!TIP]
>
> To keep the call in an Action instead, this writes `app/Actions/Attract/ShareTeamMember.php` (an invokable Action that calls `shareTeamMember()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action teamMembers.shareTeamMember
> ```

## Call it from the terminal

```bash Terminal theme={"dark"}
php artisan attract:call teamMembers.shareTeamMember id=clx8m2k4p0000a1b2c3d4e5f6
```

It calls `shareTeamMember()` on your default site and prints its answer as JSON. It writes, so it asks first: add `--force` to skip the question in a script. See [Call any method from the terminal](https://docs.fetchski-attract.com/call-command.md) for every argument type.

Takes the draft’s exact `_id` (`…:en:draft`). Answers the draft, with its `aposShareKey` while the link is on: the link is the draft’s `_url` with `aposShareKey` and `aposShareId` (the draft’s `_id`) in its query.

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

```php Laravel wrap theme={"dark"}
use Fetchski\AttractCmsLaravel\Facades\Attract;

$row = Attract::teamMembers()->listTeamMembersPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

```bash Terminal theme={"dark"}
php artisan attract:call teamMembers.listTeamMembersPick fields=title,slug
```

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
>
> Named arguments, e.g. `shareTeamMember(id: …)`; leave out the optional ones.
>
> **id** `string` *required*
>
> **Required.** The draft’s exact `_id` (`…:en:draft`).

> [accordion] Optional parameters
>
> **share** `?bool`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. true adds a share key (`aposShareKey`) to the draft; false (the default) removes it.

> [accordion] Returns
>
> A `TeamMember` (`Fetchski\AttractCmsLaravel\Data\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`
>
> **Sometimes sent:** `null` when the site leaves it out. e.g. “Founder” or “Operations lead”.
>
> **tagline** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional one-liner shown on the compact card layouts — a motto, specialty or fun fact.
>
> **bio** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional short biography, shown on the roomier card layouts.
>
> **featured** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Hand-curation flag. The widget can show only featured members, and the Spotlight layout renders them large.
>
> **sortOrder** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Members are listed lowest number first — the explicit team order.
>
> **visibility** `Enums\\Visibility|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Select whether this content is public or private. One of `public`, `loginRequired`; a newer site may send others, so keep a fallback.
>
> **scheduledPublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **scheduledUnpublish** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. An ISO 8601 date and time, e.g. `2026-10-21T14:30:00.000Z`.
>
> **memberFontOverrides** `Collection\<int, TeamMemberMemberFontOverridesItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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 (Fetchski\AttractCmsLaravel\Data\TeamMemberMemberFontOverridesItem)**
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The row’s id, unique in its array.
>
> **target** `Enums\\Target|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `Enums\\Source|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `Enums\\Slot|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `Enums\\Curated|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `Enums\\CdnProvider|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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:** `null` 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:** `null` 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** `Collection\<int, TeamMemberMemberFontOverridesItemUploadsItem\>|null`
>
> **Sometimes sent:** `null` 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 (Fetchski\AttractCmsLaravel\Data\TeamMemberMemberFontOverridesItemUploadsItem)**
>
> **file** `array\<string, mixed\>`
>
> **Always sent.** File attachment reference.
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The row’s id, unique in its array.
>
> **weight** `Enums\\Weight|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Weight. One of `100`, `200`, `300`, `400`, `500`, `600`, `700`, `800`, `900`; a newer site may send others, so keep a fallback.
>
> **style** `Enums\\Style|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Style. One of `normal`, `italic`; a newer site may send others, so keep a fallback.
>
> **fields** `array\<string, mixed\>`
>
> **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. An object in it that a PHP array would read as a list (`{}`, `{"0": …}`) is a `stdClass`, so it is sent back as an object.
>
> **fallback** `Enums\\Fallback|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `array\<string, mixed\>`
>
> **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. An object in it that a PHP array would read as a list (`{}`, `{"0": …}`) is a `stdClass`, so it is sent back as an object.
>
> **photo** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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`
>
> **Sometimes sent:** `null` when the site leaves it out. 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`
>
> **Sometimes sent:** `null` when the site leaves it out. 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`
>
> **Sometimes sent:** `null` when the site leaves it out. Optional. Only shown when the Team section has “Show email / phone” turned on.
>
> **socialLinks** `Collection\<int, TeamMemberSocialLinksItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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 (Fetchski\AttractCmsLaravel\Data\TeamMemberSocialLinksItem)**
>
> **platform** `Enums\\Platform|string`
>
> **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:** `null` when the site leaves it out. The row’s id, unique in its array.
>
> **label** `?string`
>
> **Sometimes sent:** `null` 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:** `null` when the site leaves it out. Font Awesome icon name (no “fa-” prefix), e.g. discord. Browse fontawesome.com/icons.
>
> **iconFamily** `Enums\\IconFamily|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `array\<string, mixed\>`
>
> **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. An object in it that a PHP array would read as a list (`{}`, `{"0": …}`) is a `stdClass`, so it is sent back as an object.
>
> **source** `Enums\\FaqCategorySource|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. 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`
>
> **Sometimes sent:** `null` when the site leaves it out. Internal de-duplication key set by the demo seed.
>
> **archived** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. 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** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **aposShareKey** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. 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 Laravel logs and renders the rest (see [Errors and testing](https://docs.fetchski-attract.com/laravel/errors.md)).
>
> **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`
>
> `Attract::site('acme')` named a slug that isn’t under `sites` in `config/fetchski-attract.php`.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()`, `$e->slug`.
>
> **SiteConfigurationError** `setup`
>
> The site’s config entry is wrong: no `url`, a malformed `api_key`, a key filed under another slug, or no default site.
>
> **Retried first:** No: nothing was sent. **Read:** `getMessage()` (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`). 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` in `config/fetchski-attract.php` for longer.

## Test it

It calls the route above with the SDK faked: the fake answers every call with a valid example, so nothing leaves your machine and no config or key is needed. Save it as `tests/Feature/ShareTeamMemberTest.php`, then run your tests:

```php tests/Feature/ShareTeamMemberTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use App\Models\User;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

final class ShareTeamMemberTest extends TestCase
{
    use RefreshDatabase;

    public function test_share_team_member(): void
    {
        Attract::fake();

        $this->actingAs(User::factory()->create())
            ->postJson('/team-member/clx8m2k4p0000a1b2c3d4e5f6/share')
            ->assertOk();

        Attract::assertCalled('teamMembers.shareTeamMember', fn (array $args): bool => $args['id'] === 'clx8m2k4p0000a1b2c3d4e5f6');
    }
}
```

```bash Terminal theme={"dark"}
php artisan test
```

**Answer with your own values:** fake `teamMembers.shareTeamMember` with `TeamMember::factory()->make([...])`, the fields you give over a valid example.

```php tests/Feature/ShareTeamMemberAnswerTest.php theme={"dark"}
<?php

declare(strict_types=1);

namespace Tests\Feature;

use Fetchski\AttractCmsLaravel\Data\TeamMember;
use Fetchski\AttractCmsLaravel\Facades\Attract;
use Tests\TestCase;

final class ShareTeamMemberAnswerTest extends TestCase
{
    public function test_share_team_member_answers_your_values(): void
    {
        Attract::fake([
            'teamMembers.shareTeamMember' => TeamMember::factory()->make(['title' => 'Your value']),
        ]);

        $teamMember = Attract::teamMembers()->shareTeamMember(id: 'clx8m2k4p0000a1b2c3d4e5f6');

        $this->assertSame('Your value', $teamMember->title);
    }
}
```

## Related

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

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

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

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

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

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

> [card] [POST /team-member/\{\_id}/share](https://docs.fetchski-attract.com/api-reference/team-members/share-a-team-member’s-draft.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.