Skip to main content
PATCH
Update a dynamic link

Authorizations

Authorization
string
header
required

Company API key, sent as Authorization: Bearer <key>. Create it in the dashboard (Developer > API Keys) with the permissions the integration needs.

Path Parameters

id
string
required

Body

application/json
name
string

Required on creation, unique in the company

Maximum string length: 255
short_code
string

Path of the short URL; generated when absent

Maximum string length: 50
Pattern: ^[A-Za-z0-9_-]+$

Required on creation

fallback_url
string<uri>

Required on creation

description
string | null
Maximum string length: 300
expire_at
string<date-time> | null
android_platform_id
string | null

An Android app (GET /deep-links/platforms); at least one platform

ios_platform_id
string | null

An iOS app; at least one platform

Response

200 - application/json

Always HTTP 200: the outcome is in success and code (absolute value of the response code).

success
boolean
Example:

true

code
integer
Example:

1000

message
string
Example:

"Request success."

body
object

Endpoint payload, null when there is none

token
string | null

Present only on authentication routes

trace_id
string | null

Present only when success is false