Signed links

Update a signed link

Partial update. template_id is immutable and the secret is unchanged.

patch/v1/signed-links/{link_id}

Request

  • Base URL: https://api-eu.dynamicdocumentapi.com
  • URL: https://api-eu.dynamicdocumentapi.com/v1/signed-links/{link_id}
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

link_idstring required

Signed link id (lnk_…).

Request body

access'signed' | 'open'

open accepts unsigned requests within allowed_params and param_limits.

  • signed - signed
  • open - open
allowed_paramsstring[]

Dynamic properties callers may set, e.g. title.text.

allowed_referrersstring[]
cache_ttl_secondsinteger nullable
defaultsobject
enabledboolean
expires_atstring date-time nullable
fallback_image_asset_idstring nullable

Ready image asset (ast_…) returned instead of 402 render_limit_reached; null clears.

formatsstring[]
namestring
param_limitsobject
quota_totalinteger nullable
rate_limit_per_ip_per_hourinteger nullable
template_idstring

Response

access'signed' | 'open' required
  • signed - signed
  • open - open
allowed_paramsstring[] required
allowed_referrersstring[] nullable required
base_urlstring uri required

Append /{any-name}.{ext}?… and a signature.

cache_ttl_secondsinteger nullable required
created_atstring date-time required
defaultsobject required

Parameter values used when the URL omits them.

enabledboolean required
expires_atstring date-time nullable required
fallback_image_asset_idstring nullable required

ast_…: image served instead of 402 render_limit_reached.

formatsstring[] required
idstring required

lnk_…

namestring required
objectstring
param_limitsobject required

e.g. {"title.text": {"max_length": 80}}.

quota_totalinteger nullable required
quota_usedinteger required
rate_limit_per_ip_per_hourinteger nullable required
template_idstring required

Changes

No recorded changes to this operation across all 2 revisions of this API.