Sign in
Shortcuts

Update shortcut

Updates the shortcut with the given ID.

post/rest/api/v1/updateshortcut

Query parameters

localestring

The client's preferred locale in rfc5646 format (e.g. en, ja, pt-BR). If omitted, the Accept-Language will be used. If not present or not supported, defaults to the closest match or en.

Headers

X-Glean-ActAsstring email

Email address of a user on whose behalf the request is intended to be made (should be non-empty only for global tokens).

X-Glean-Auth-Typestring

Auth type being used to access the endpoint (should be non-empty only for global tokens).

Request body

idinteger required

The opaque id of the user generated content.

inputAliasstring

Link text following go/ prefix as entered by the user.

destinationUrlstring

Destination URL for the shortcut.

destinationDocumentIdstring

Glean Document ID for the URL, if known.

descriptionstring

A short, plain text blurb to help people understand the intent of the shortcut.

unlistedboolean

Whether this shortcut is unlisted or not. Unlisted shortcuts are visible to author + admins only.

urlTemplatestring

For variable shortcuts, contains the URL template; note, destinationUrl contains default URL.

Example request

{
  "addedRoles": [
    {
      "person": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      }
    }
  ],
  "removedRoles": [
    {
      "person": {
        "name": "George Clooney",
        "obfuscatedId": "abc123"
      }
    }
  ]
}

Response

OK

Example response

{
  "shortcut": {
    "addedRoles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "removedRoles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ],
    "createdBy": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "updatedBy": {
      "name": "George Clooney",
      "obfuscatedId": "abc123"
    },
    "destinationDocument": {
      "metadata": {
        "container": "container",
        "parentId": "JIRA_EN-1337",
        "createTime": "2000-01-23T04:56:07.000Z",
        "datasource": "datasource",
        "author": {
          "name": "name"
        },
        "documentId": "documentId",
        "updateTime": "2000-01-23T04:56:07.000Z",
        "mimeType": "mimeType",
        "objectType": "Feature Request",
        "components": [
          "Backend",
          "Networking"
        ],
        "status": "Done",
        "customData": {
          "someCustomField": {
            "stringValue": "someCustomValue"
          }
        }
      }
    },
    "roles": [
      {
        "person": {
          "name": "George Clooney",
          "obfuscatedId": "abc123"
        }
      }
    ]
  }
}

Changes