Skip to content

Update a short link (EDITOR, alias of PUT)

projectId
required
string
linkId
required
string
Media typeapplication/json

Partial update; at least one field required.

object
>= 1 properties
name
string | null
destinationUrl
string
>= 1 characters
status

One of linkStatuses enum.

string
utmSource
string | null
utmMedium
string | null
utmCampaign
string | null
utmTerm
string | null
utmContent
string | null
platformConfig
object | null
expiresAt
string | null
domainId

Undefined=no change, null=rebind to platform default domain.

string | null
Examplegenerated
json
{
"name": "example",
"destinationUrl": "example",
"status": "example",
"utmSource": "example",
"utmMedium": "example",
"utmCampaign": "example",
"utmTerm": "example",
"utmContent": "example",
"platformConfig": "example",
"expiresAt": "example",
"domainId": "example"
}

{ ok, link }

Media typeapplication/json
object
key
additional properties
any

Invalid config

Media typeapplication/json

Validation error envelope (Zod). issues/details present on schema failures.

object
error
required
string
issues
Array<object>
object
key
additional properties
any
details
Array<object>
object
key
additional properties
any
Examplegenerated
json
{
"error": "example",
"issues": [
{}
],
"details": [
{}
]
}

Not found

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}

Short-code conflict

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
"error": "example",
"message": "example"
}