> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.taktoria.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.taktoria.com/_mcp/server.

# Update

PATCH https://api.taktoria.com/api/v1/golinks/{linkId}
Content-Type: application/json

Re-point it, rename it, publish it, put it away, or say who may
follow it. Publishing and archiving have no endpoints of their own:
`"draft": false` publishes a draft (and the activity feed says who
did), `"draft": true` takes a live link off the air, and `archived`
puts a link away or brings it back, each left alone if it is already
so. A domain in `access.domains` that is neither on the
allow-list nor already the link's gets `422 domain_not_allowed`;
`editorUserIds` naming anybody who is not a member of the workspace
gets `422 validation_error`. With a signed-in session, only a link that person may edit (one
naming no editors, naming them, made by them, or any if they are an
app admin of Go Links); any other is `403 forbidden`. A Viewer of Go
Links edits none (`403 viewer_only`).

Reference: https://docs.taktoria.com/api-reference/golinks/update

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://api.taktoria.com/api/v1` (Production, default)
- `http://localhost:3000/api/v1` (Local)

## Request

### Path parameters

- `linkId` (string, required)

### Body (application/json)

This endpoint expects an UpdateGoLinkRequest.

- `slug` (string, optional)
- `url` (string, optional)
- `description` (string, optional)
- `editorUserIds` (list of string, optional) — Replaces who may change it, beside its creator and Go Links' app admins; empty, anybody with a seat who is not a Viewer of Go Links. Each must be a member of the workspace, with a key as with a session: anybody else is a `422 validation_error` with `details: { field: "editorUserIds", userIds }` naming them, and nothing is saved.
- `archived` (boolean, optional)
- `draft` (boolean, optional) — False publishes a draft; true takes a live link off the air again.
- `access` (UpdateGoLinkAccess, optional) — Who may follow it on the hostname. A field left out keeps its value.

## Response

### 200

- `id` (string, required)
- `organizationId` (string, required)
- `slug` (string, required) — The bit after `go/`. Normalised hard on the way in: lowercase, with spaces and underscores folded to hyphens, because the whole value of `go/roadmap` is that a colleague can guess it.
- `shortUrl` (string, required) — The address to hand out: on the workspace's own Go Links hostname where it has one (`https://go.acme.com/roadmap`), otherwise this installation's `/go/roadmap`, which asks a member to sign in. What the link's QR code (`qrCode`) holds: the short link, never the destination, so re-pointing the link breaks nothing printed.
- `clicks` (integer, required) — Every follow since the link was made.
- `editorUserIds` (list of string, required) — Who may change it, when it is not simply anybody with a seat, beside its creator and Go Links' app admins, who always may. Empty means no restriction, which is what every link is until somebody narrows it. A Viewer of Go Links changes no link, named or not. Never affects who may *follow* a link: that is `access`. Members of the workspace when they were named; somebody since removed from it stays listed until the link's editors are saved again.
- `access` (GoLinkAccess, required) — Who may follow this link on the Go Links hostname, as a Dory event's audience says who may join it. There is no "anyone signed in": anybody can make an account, so for links it would be no check at all. A link made without saying is `DOMAIN` with no domains listed.
- `archived` (boolean, required) — Out of the list, still working. Archiving is about the list, not about breaking a URL somebody has in a document somewhere.
- `draft` (boolean, required) — Holds the slug without redirecting. Nobody else can take the name, but following it opens Go Links instead of the destination, and counts no click, until the link is published.
- `createdAt` (datetime, required)
- `updatedAt` (datetime, required)
- `url` (string, optional) — Where it goes. Null for a draft when called with a signed-in session by somebody who may not edit the link: a draft's destination is its editors' business. A key always sees it.
- `description` (string, optional)
- `lastUsedAt` (datetime, optional)
- `createdBy` (User, optional) — A person in a Taktoria organization.
- `archivedAt` (datetime, optional)

## Errors

### 403 Forbidden Error

Refused, and `error.code` says why. On an app's write endpoints, a signed-in session is refused `viewer_only` when the person is a Viewer of the app (they read it, and change nothing in it), and `seat_required` without a seat on it; a key is never either. Beyond those: `admin_required` when the change is an admin's (an app admin's for an app's admin powers, a workspace admin's for the workspace's settings), `forbidden` when the person may not change this one thing, `read_only_session` for a change only a key makes, `person_required` for what only a signed-in person does through their own account elsewhere (exporting a LaunchCal artifact to their docs tool), which a key cannot, `insufficient_scope` for a key without the scope, and `google_sign_in_required` for a session the workspace's Google rule turns away. Nothing was done.

- `error` (ErrorDetail, required)

### 404 Not Found Error

- `error` (ErrorDetail, required)

### 422 Validation Error

- `error` (ErrorDetail, required)

### 409 Conflict Error

The request conflicts with how things stand, and `error.code` says how: `conflict` in general, or an endpoint's own code (`draft`, `launched`, `steps_incomplete`, `ticketing_not_connected`, `docs_not_connected`, …), listed in its description and under Errors and pagination. Nothing was done.

- `error` (ErrorDetail, required)

### 429 Too Many Requests Error

Rate limited (`rate_limited`): the key, the signed-in person, the workspace or an expensive endpoint's own budget is used up for now. `Retry-After` says how many seconds to wait, and `details` names the `policy`, its `limit`, `windowSeconds` and `retryAfter`. Every answer to an authenticated request carries the IETF `RateLimit-Policy` and `RateLimit` headers, so a client can slow down before it gets this. Nothing was done; wait and send it again. See "Rate limits".

- `error` (ErrorDetail, required)

## Types

### UpdateGoLinkAccess

A field left out keeps its value (on create, the default).

- `audience` (enum, optional) — Who may follow a link on the workspace's Go Links hostname. On our own `/go/…` a link always takes a member signed in, whatever this says.
  - Allowed values: `PUBLIC`, `WORKSPACE`, `DOMAIN`
- `domains` (list of string, optional) — Replaces the listed domains, at most 20; `@` and whole addresses are forgiven. Each must be on the workspace's allow-list, or already be one of the link's: otherwise `422 domain_not_allowed`, with the domains in `details.domains`. An empty list means the whole allow-list, including domains added to it later; listing every domain on it instead fixes the choice to those.
- `requireGoogle` (boolean, optional) — Kept false where this deployment has no Google sign-in. Stored as sent, but a workspace that requires Google sign-in makes every link Google only whatever this says.

### GoLinkAccess

Who may follow this link on the Go Links hostname, as a Dory event's audience says who may join it. There is no "anyone signed in": anybody can make an account, so for links it would be no check at all. A link made without saying is `DOMAIN` with no domains listed.

- `audience` (enum, required) — Who may follow a link on the workspace's Go Links hostname. On our own `/go/…` a link always takes a member signed in, whatever this says.
  - Allowed values: `PUBLIC`, `WORKSPACE`, `DOMAIN`
- `requireGoogle` (boolean, required) — For `DOMAIN`, addresses are proved only by Google, never by a code. The rule as it applies: true whenever the workspace requires Google sign-in, whatever was set on the link.
- `domains` (list of string, optional) — For `DOMAIN`: the email domains let in, chosen from the workspace's allow-list (its verified domains left on it, and its partner domains: see `/partner-domains`). Only those still on the list count, as it is at the time; empty means the whole list, and with nothing on it only members can follow the link. An address at a subdomain counts. Kept, unused, under another audience. Null when called with a signed-in session by somebody who may not edit the link; a key always sees them.

### User

A person in a Taktoria organization.

- `id` (string, required)
- `name` (string, required)
- `email` (string, required)
- `image` (string, optional) — Their picture: one uploaded on the account page, or else their Google profile picture, brought in when they sign in with Google.

### ErrorDetail

- `code` (string, required) — A stable machine-readable code such as `not_found`.
- `message` (string, required)
- `details` (any, optional)

## Examples

**Request**

```json
{}
```

**Response**

```json
{
  "id": "id",
  "organizationId": "organizationId",
  "slug": "slug",
  "shortUrl": "shortUrl",
  "clicks": 1,
  "editorUserIds": [
    "editorUserIds",
    "editorUserIds"
  ],
  "access": {
    "audience": "PUBLIC",
    "requireGoogle": true,
    "domains": [
      "domains",
      "domains"
    ]
  },
  "archived": true,
  "draft": true,
  "createdAt": "2024-01-15T09:30:00Z",
  "updatedAt": "2024-01-15T09:30:00Z",
  "url": "url",
  "description": "description",
  "lastUsedAt": "2024-01-15T09:30:00Z",
  "createdBy": {
    "id": "id",
    "name": "name",
    "email": "email",
    "image": "image"
  },
  "archivedAt": "2024-01-15T09:30:00Z"
}
```

**SDK Code**

```python
import requests

url = "https://api.taktoria.com/api/v1/golinks/linkId"

payload = {}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.taktoria.com/api/v1/golinks/linkId';
const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.taktoria.com/api/v1/golinks/linkId"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.taktoria.com/api/v1/golinks/linkId")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.patch("https://api.taktoria.com/api/v1/golinks/linkId")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('PATCH', 'https://api.taktoria.com/api/v1/golinks/linkId', [
  'body' => '{}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.taktoria.com/api/v1/golinks/linkId");
var request = new RestRequest(Method.PATCH);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.taktoria.com/api/v1/golinks/linkId")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "PATCH"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```