Update a short link (EDITOR)
Authorizations
Section titled “Authorizations”Parameters
Section titled “Parameters”Path Parameters
Section titled “Path Parameters”projectId
required
string
linkId
required
string
Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
Partial update; at least one field required.
object
name
string | null
destinationUrl
string
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
{ "name": "example", "destinationUrl": "example", "status": "example", "utmSource": "example", "utmMedium": "example", "utmCampaign": "example", "utmTerm": "example", "utmContent": "example", "platformConfig": "example", "expiresAt": "example", "domainId": "example"}Responses
Section titled “Responses”{ ok, link }
Media typeapplication/json
object
key
additional properties
any
Invalid config / domain validation failed
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
{ "error": "example", "issues": [ {} ], "details": [ {} ]}Not found
Media typeapplication/json
object
error
required
Human-readable error message.
string
message
string
Examplegenerated
{ "error": "example", "message": "example"}Short-code conflict at default domain
Media typeapplication/json
object
error
required
Human-readable error message.
string
message
string
Examplegenerated
{ "error": "example", "message": "example"}