Sign in
Go Links

Add a go link

Adds a new go link for the organization.

post/organizations/{organizationId}/goLinks

Request

  • Base URL: https://docs.superhuman.com/apis/v1
  • URL: https://docs.superhuman.com/apis/v1/organizations/{organizationId}/goLinks
  • Auth: HTTP bearer

Path parameters

organizationIdstring required

ID of the organization.

Request body

namestring required

The name of the Go Link that comes after go/. Only alphanumeric characters, dashes, and underscores are allowed.

destinationUrlstring required

The URL that the Go Link redirects to.

descriptionstring

Optional description for the Go Link.

urlPatternstring nullable

Optional destination URL with {*} placeholders for variables to be inserted. Variables are specified like go/<name>/<var1>/<var2>.

creatorEmailstring nullable

Optional creator email for the Go Link. Only organization admins can set this field.

Example request

{
  "urlPattern": "https://example.com/{*}/{*}",
  "creatorEmail": "foo@bar.com"
}

Response

Confirmation that the go link was added.

AddGoLinkResult required

The result of adding a Go Link.

Changes

No recorded changes to this operation across all 1 revision of this API.