Update external link

PATCH

public

api

hub

external-links

{linkPublicId}

Update external link

curl --request PATCH \
  --url https://api.gennia.ai/public/api/v1/hub/external-links/{linkPublicId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "title": "Documentation",
  "url": "https://docs.example.com"
}
'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "displayOrder": 123,
  "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "url": "<string>"
}

Autorizações

X-Api-Key

string

header

obrigatório

Parâmetros de caminho

linkPublicId

string<uuid>

obrigatório

External link public ID

Corpo

application/json

Body for updating an existing external link on the hub. All fields are optional.

title

string

New display title of the link.

Required string length: 1 - 100

Exemplo:

"Documentation"

url

string

New URL of the link.

Maximum string length: 2048

Exemplo:

"https://docs.example.com"

Resposta

createdAt

string<date-time>

displayOrder

integer<int32>

publicId

string<uuid>

title

string

url

string

List clientsPaginated list of client workspaces in the hub bound to the API key.

Update external link

curl --request PATCH \
  --url https://api.gennia.ai/public/api/v1/hub/external-links/{linkPublicId} \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "title": "Documentation",
  "url": "https://docs.example.com"
}
'

{
  "createdAt": "2023-11-07T05:31:56Z",
  "displayOrder": 123,
  "publicId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "title": "<string>",
  "url": "<string>"
}