Create | Taktoria API

{
  "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"
}

Make a link. access.domains off the workspace’s allow-list are refused with 422 domain_not_allowed, and editorUserIds naming anybody who is not a member of the workspace with 422 validation_error. Any member with a seat may, with a signed-in session as in the app, except a Viewer of Go Links (403 viewer_only).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

slugstringRequired

urlstringRequired

A bare acme.com/thing is assumed to be https. Anything that is not http(s) is refused: a javascript: destination on a link the whole company is told to click is stored XSS.

descriptionstringOptional

editorUserIdslist of stringsOptional

Who may change it, beside its creator and Go Links’ app admins; empty or left out, 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 (a user of another workspace, or an id that is nobody’s) is a 422 validation_error with details: { field: "editorUserIds", userIds } naming them, and nothing is saved.

draftbooleanOptional

Claim the slug now and publish it later. Defaults to false.

accessobjectOptional

Who may follow it on the hostname. Left out, the default.

Response

This endpoint returns an object.

idstring

organizationIdstring

slugstring

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.

shortUrlstring

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.

clicksinteger

Every follow since the link was made.

editorUserIdslist of strings

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.

accessobject

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.

archivedboolean

Out of the list, still working. Archiving is about the list, not about breaking a URL somebody has in a document somewhere.

draftboolean

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.

createdAtdatetime

updatedAtdatetime

urlstringOptional

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.

descriptionstringOptional

lastUsedAtdatetimeOptional

createdByobjectOptional

A person in a Taktoria organization.

archivedAtdatetimeOptional

Errors

402

Subscription Required Error

403

Forbidden Error

409

Conflict Error

422

Validation Error

429

Too Many Requests Error