> ## 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 an Instagram post’s draft

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

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

$instagramPost = Attract::instagramPosts()->shareInstagramPost(id: 'clx8m2k4p0000a1b2c3d4e5f6');
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "caption": "Example caption",
  "mediaType": "image",
  "isReel": false,
  "featured": false,
  "slug": "example-slug",
  "visibility": "public",
  "scheduledPublish": "Example scheduled publish",
  "scheduledUnpublish": "Example scheduled unpublish",
  "_mediaImage": [
    {}
  ],
  "mediaUrl": "https://acme.example/example",
  "_video": [
    {}
  ],
  "videoUrl": "https://acme.example/example",
  "videoRehostStatus": "",
  "permalink": "https://acme.example/example",
  "postedAt": "2026-10-24",
  "likeCount": 0,
  "commentsCount": 0,
  "comments": [],
  "hiddenComments": [],
  "source": "manual",
  "sourceId": "clx8m2k4p0000a1b2c3d4e5f6",
  "archived": false,
  "videoRehostCapBytes": 0,
  "_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 `shareInstagramPost()` and returns the answer.

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class ShareInstagramPostController
{
    public function __invoke(string $id): InstagramPost
    {
        return Attract::instagramPosts()->shareInstagramPost(id: $id);
    }
}
```

**2. Add the route**

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

Route::post('/instagram-post/{id}/share', ShareInstagramPostController::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 /instagram-post/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/ShareInstagramPost.php` (an invokable Action that calls `shareInstagramPost()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action instagramPosts.shareInstagramPost
> ```

## Call it from the terminal

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

It calls `shareInstagramPost()` 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::instagramPosts()->listInstagramPostsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

```bash Terminal theme={"dark"}
php artisan attract:call instagramPosts.listInstagramPostsPick 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. `shareInstagramPost(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
>
> An `InstagramPost` (`Fetchski\AttractCmsLaravel\Data\InstagramPost`). InstagramPost content type. Read its properties (`$instagramPost->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`, `_mediaImage` → `mediaImage`, `_video` → `video`).
>
> **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.
>
> **caption** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The post caption. Shown (optionally truncated) under the image.
>
> **mediaType** `Enums\\MediaType|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Drives the corner badge (a video/reel/album marker). One of `image`, `video`, `carousel`; a newer site may send others, so keep a fallback.
>
> **isReel** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Marks a video post as a reel (shows a reel badge instead of a generic video badge).
>
> **featured** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Hand-curation flag. The widget can be set to show only featured posts.
>
> **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`.
>
> **mediaImage** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The post image (a first-party media-library image). Used for manual posts and for synced posts when “re-host” storage is on. Falls back to the image URL below when empty. 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.
>
> **mediaUrl** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. A direct image URL (set by a sync in “hot-link” storage mode). Used only when no library image is set above. Instagram CDN URLs expire — prefer a library image. When set, a URL; empty or null when not.
>
> **video** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The playable clip as a first-party file (a piece from the Videos library). Set by a sync when “re-host” video storage is on; also pickable by hand for a manual post. Takes precedence over the video URL below — and, unlike it, never expires and needs no cookie consent to play. The related `video` 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.
>
> **videoUrl** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. A direct, hot-linked video file URL (set by a sync for video/reel posts under “hot-link” video storage). Played in-place in the on-site lightbox; the still image above is the poster. Instagram CDN video URLs expire quickly (\~32h) — the site re-checks freshness and the cron keeps it rotating, and a visitor who has not accepted functional cookies gets the still instead (the file loads from Meta). Re-host the video to avoid both. When set, a URL; empty or null when not.
>
> **videoRehostStatus** `Enums\\VideoRehostStatus|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Why this post’s clip is still loading from Instagram instead of your own media library. Anything other than the first value means the video expires in \~32h and is hidden from visitors who declined functional cookies. “Too large” is fixable: raise the cap in Connections → Instagram. One of \`\`, `too-large`, `not-video`, `failed`; a newer site may send others, so keep a fallback.
>
> **permalink** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The link to this post on Instagram. The whole tile links here when set. When set, a URL; empty or null when not.
>
> **postedAt** `?CarbonImmutable`
>
> **Sometimes sent:** `null` when the site leaves it out. Posted date. Format: an ISO 8601 date (`YYYY-MM-DD`).
>
> **likeCount** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Likes.
>
> **commentsCount** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Comments count.
>
> **comments** `Collection\<int, InstagramPostCommentsItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. A list of `InstagramPostCommentsItem`. Comments.
>
> **InstagramPostCommentsItem (Fetchski\AttractCmsLaravel\Data\InstagramPostCommentsItem)**
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The row’s id, unique in its array.
>
> **text** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Comment.
>
> **username** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Author.
>
> **fromId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Author ID (IGSID).
>
> **parentId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Parent comment ID.
>
> **timestamp** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Posted at.
>
> **likeCount** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Likes.
>
> **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.
>
> **hiddenComments** `Collection\<int, InstagramPostHiddenCommentsItem\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. A list of `InstagramPostHiddenCommentsItem`. Hidden comments.
>
> **InstagramPostHiddenCommentsItem (Fetchski\AttractCmsLaravel\Data\InstagramPostHiddenCommentsItem)**
>
> **id** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The row’s id, unique in its array.
>
> **text** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Comment.
>
> **username** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Author.
>
> **fromId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Author ID (IGSID).
>
> **parentId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Parent comment ID.
>
> **timestamp** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. Posted at.
>
> **likeCount** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. Likes.
>
> **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\\InstagramPostSource|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Source. One of `manual`, `instagram-login`, `facebook-login`, `demo`; a newer site may send others, so keep a fallback.
>
> **sourceId** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. The Graph media id — the de-duplication key set by a sync.
>
> **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.
>
> **videoRehostCapBytes** `?int`
>
> **Sometimes sent:** `null` when the site leaves it out. With `videoRehostStatus: too-large`, the size cap (bytes) the clip was over; 0 otherwise. Set by the sync.
>
> **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:instagram-posts:write` (or a master above it: `content:instagram-posts: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/ShareInstagramPostTest.php`, then run your tests:

```php tests/Feature/ShareInstagramPostTest.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 ShareInstagramPostTest extends TestCase
{
    use RefreshDatabase;

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

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

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

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

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class ShareInstagramPostAnswerTest extends TestCase
{
    public function test_share_instagram_post_answers_your_values(): void
    {
        Attract::fake([
            'instagramPosts.shareInstagramPost' => InstagramPost::factory()->make(['title' => 'Your value']),
        ]);

        $instagramPost = Attract::instagramPosts()->shareInstagramPost(id: 'clx8m2k4p0000a1b2c3d4e5f6');

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

## Related

> [card] [List an Instagram post’s locales](https://docs.fetchski-attract.com/laravel/reference/instagram-posts/get-instagram-post-locales.md)
>
> `Attract::instagramPosts()->getInstagramPostLocales()`

> [card] [List Instagram posts](https://docs.fetchski-attract.com/laravel/reference/instagram-posts/list-instagram-posts.md)
>
> `Attract::instagramPosts()->listInstagramPosts()`

> [card] [Create an Instagram post](https://docs.fetchski-attract.com/laravel/reference/instagram-posts/create-instagram-post.md)
>
> `Attract::instagramPosts()->createInstagramPost()`

> [card] [Get an Instagram post](https://docs.fetchski-attract.com/laravel/reference/instagram-posts/get-instagram-post.md)
>
> `Attract::instagramPosts()->getInstagramPost()`

> [card] [Replace an Instagram post](https://docs.fetchski-attract.com/laravel/reference/instagram-posts/replace-instagram-post.md)
>
> `Attract::instagramPosts()->replaceInstagramPost()`

> [card] [Delete an Instagram post](https://docs.fetchski-attract.com/laravel/reference/instagram-posts/delete-instagram-post.md)
>
> `Attract::instagramPosts()->deleteInstagramPost()`

> [card] [POST /instagram-post/\{\_id}/share](https://docs.fetchski-attract.com/api-reference/instagram-posts/share-an-instagram-post’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.