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

> Update an existing redirect.

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

$redirect = Attract::redirects()->updateRedirect(id: 'clx8m2k4p0000a1b2c3d4e5f6');
```

```json 200 wrap theme={"dark"}
{
  "title": "Example title",
  "redirectSlug": "example-slug",
  "urlType": "internal",
  "_newPage": [
    {}
  ],
  "externalUrl": "https://acme.example/example",
  "statusCode": "301",
  "ignoreQueryString": false,
  "forwardQueryString": false,
  "slug": "example-slug",
  "archived": false,
  "_id": "clx8m2k4p0000a1b2c3d4e5f6",
  "type": "Example type",
  "createdAt": "2026-10-24T09:30:00.000Z",
  "updatedAt": "2026-10-24T09:30:00.000Z"
}
```

## In your app

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

**1. Add the controller**

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

declare(strict_types=1);

namespace App\Http\Controllers;

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

final class UpdateRedirectController
{
    public function __invoke(string $id): Redirect
    {
        return Attract::redirects()->updateRedirect(id: $id);
    }
}
```

**2. Add the route**

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

Route::patch('/redirect/{id}', UpdateRedirectController::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 `PATCH /redirect/clx8m2k4p0000a1b2c3d4e5f6` (a form adds `@csrf`, as every web route checks it, and `@method('PATCH')`), 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/UpdateRedirect.php` (an invokable Action that calls `updateRedirect()`) and its test under `tests/Feature/Actions/Attract/` (Pest when your app has it):
>
> ```bash Terminal theme={"dark"}
> php artisan make:attract-action redirects.updateRedirect
> ```

## Call it from the terminal

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

It calls `updateRedirect()` 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.

## 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::redirects()->listRedirectsPick(fields: ['title', 'slug'])->firstWhere('slug', 'getting-started'); // ['id' => …, 'title' => …, 'slug' => …], or null
```

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

Pass `$row['id']` as `id`. See [Find an id](https://docs.fetchski-attract.com/find-an-id.md).

> [accordion] Required parameters
>
> Named arguments, e.g. `updateRedirect(id: …)`; leave out the optional ones.
>
> **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
>
> **title** `?string`
>
> **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.
>
> **redirectSlug** `?string`
>
> **Optional.** Leave it out and the site uses `""`. Format with leading slash (e.g., /old-url)
>
> **urlType** `Enums\\UrlType|string|null`
>
> **Optional.** Leave it out and the site uses `"internal"`. Link Type. One of `internal`, `external`.
>
> **newPage** `array\<int, array\<string, mixed\>\>|Collection\<int, array\<string, mixed\>\>|null`
>
> **Optional.** The related `@apostrophecms/page` 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.
>
> **externalUrl** `?string`
>
> **Optional.** Leave it out (or pass `null`) and it isn’t sent: the site’s default applies. When set, a URL; empty or null when not.
>
> **statusCode** `Enums\\StatusCode|string|null`
>
> **Optional.** Leave it out and the site uses `"301"`. Redirect Type. One of `302`, `301`.
>
> **ignoreQueryString** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. Ignore query string when matching.
>
> **forwardQueryString** `?bool`
>
> **Optional.** Leave it out and the site uses `false`. Forward query string.
>
> **slug** `?string`
>
> **Optional.** Leave it out and the site uses `""`. The URL name: lowercase words joined by hyphens (letters outside a–z, even emoji, are kept).
>
> **archived** `?bool`
>
> **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 `Redirect` (`Fetchski\AttractCmsLaravel\Data\Redirect`). Redirect content type. Read its properties (`$redirect->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`, `_newPage` → `newPage`).
>
> **title** `string`
>
> **Always sent.** Its title: the name it goes by in every list, and the heading of its page where it has one.
>
> **redirectSlug** `string`
>
> **Always sent.** Format with leading slash (e.g., /old-url)
>
> **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.
>
> **createdAt** `CarbonImmutable`
>
> **Always sent.** When it was created (ISO 8601). Format: an ISO 8601 date and time.
>
> **updatedAt** `CarbonImmutable`
>
> **Always sent.** When it last changed (ISO 8601). Format: an ISO 8601 date and time.
>
> **urlType** `Enums\\UrlType|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Link Type. One of `internal`, `external`; a newer site may send others, so keep a fallback.
>
> **newPage** `Collection\<int, array\<string, mixed\>\>|null`
>
> **Sometimes sent:** `null` when the site leaves it out. The related `@apostrophecms/page` 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.
>
> **externalUrl** `?string`
>
> **Sometimes sent:** `null` when the site leaves it out. When set, a URL; empty or null when not.
>
> **statusCode** `Enums\\StatusCode|string|null`
>
> **Sometimes sent:** `null` when the site leaves it out. Redirect Type. One of `302`, `301`; a newer site may send others, so keep a fallback.
>
> **ignoreQueryString** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Ignore query string when matching.
>
> **forwardQueryString** `?bool`
>
> **Sometimes sent:** `null` when the site leaves it out. Forward query string.
>
> **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.

> [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:redirects:write` (or a master above it: `content:redirects: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/UpdateRedirectTest.php`, then run your tests:

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

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

        $this->actingAs(User::factory()->create())
            ->patchJson('/redirect/clx8m2k4p0000a1b2c3d4e5f6')
            ->assertOk();

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

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

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

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

declare(strict_types=1);

namespace Tests\Feature;

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

final class UpdateRedirectAnswerTest extends TestCase
{
    public function test_update_redirect_answers_your_values(): void
    {
        Attract::fake([
            'redirects.updateRedirect' => Redirect::factory()->make(['title' => 'Your value']),
        ]);

        $redirect = Attract::redirects()->updateRedirect(id: 'clx8m2k4p0000a1b2c3d4e5f6');

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

## Related

> [card] [List redirects](https://docs.fetchski-attract.com/laravel/reference/redirects/list-redirects.md)
>
> `Attract::redirects()->listRedirects()`

> [card] [Create a redirect](https://docs.fetchski-attract.com/laravel/reference/redirects/create-redirect.md)
>
> `Attract::redirects()->createRedirect()`

> [card] [Get a redirect](https://docs.fetchski-attract.com/laravel/reference/redirects/get-redirect.md)
>
> `Attract::redirects()->getRedirect()`

> [card] [Replace a redirect](https://docs.fetchski-attract.com/laravel/reference/redirects/replace-redirect.md)
>
> `Attract::redirects()->replaceRedirect()`

> [card] [Delete a redirect](https://docs.fetchski-attract.com/laravel/reference/redirects/delete-redirect.md)
>
> `Attract::redirects()->deleteRedirect()`

> [card] [Archive redirects](https://docs.fetchski-attract.com/laravel/reference/redirects/archive-redirects.md)
>
> `Attract::redirects()->archiveRedirects()`

> [card] [PATCH /@apostrophecms/redirect/\{\_id}](https://docs.fetchski-attract.com/api-reference/redirects/update-a-redirect.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.