REST API

Links

Links: 11 endpoints of the REST API.

GET/links

List links

Links of this environment, newest first by default. Filter by status, campaign, tag, domain_id and creation time, search with q, and sort by creation or update time. Archived links are left out unless status=archived or all.

Secret key scope (any of): links:read, links:write

Parameters

Field	Type	Description
`limit (query)`	`integer`	Items per page (1–100).
`cursor (query)`	`string`	`next_cursor` of the previous page; omit for the first page. A cursor only works with the sort order it was issued for.
`status (query)`	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked" \| "all" \| "deleted"`	One status, `all` (every link that is not deleted) or `deleted` (the trash, restorable for 30 days). Without it archived and deleted links are left out.
`campaign (query)`	`string`	Only links of this campaign key.
`tag (query)`	`string`	Only links with this tag.
`domain_id (query)`	`string`
`created_from (query)`	`string (date-time)`
`created_to (query)`	`string (date-time)`
`q (query)`	`string`	Case-insensitive search in the short path, the name and the deep-link path.
`sort (query)`	`"created_at" \| "updated_at"`
`direction (query)`	`"asc" \| "desc"`

Responses

200 A page of links.

Field	Type	Description
`data`required	`object[]`
`data[].id`required	`string`
`data[].url`required	`string`	The short URL: `https://{host}/{path}`.
`data[].qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`data[].domain_id`required	`string`
`data[].host`required	`string`
`data[].path`required	`string`
`data[].name`required	`string \| null`
`data[].deep_link_path`required	`string`
`data[].data`required	`object`
`data[].campaign`required	`object \| null`
`data[].utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`data[].utm.source`required	`string \| null`
`data[].utm.medium`required	`string \| null`
`data[].utm.content`required	`string \| null`
`data[].utm.term`required	`string \| null`
`data[].utm.creative`required	`string \| null`
`data[].effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`data[].effective_utm.source`required	`string \| null`
`data[].effective_utm.medium`required	`string \| null`
`data[].effective_utm.content`required	`string \| null`
`data[].effective_utm.term`required	`string \| null`
`data[].effective_utm.creative`required	`string \| null`
`data[].redirects`required	`object`
`data[].redirects.ios`required	`string \| null`
`data[].redirects.android`required	`string \| null`
`data[].redirects.web`required	`string \| null`
`data[].redirects.desktop`required	`string \| null`
`data[].redirects.fallback`required	`string \| null`
`data[].status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`data[].expires_at`required	`string (date-time) \| null`
`data[].allow_param_passthrough`required	`boolean`
`data[].tags`required	`string[]`
`data[].metadata`required	`object`
`data[].version`required	`integer`
`data[].created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`data[].created_at`required	`string (date-time)`
`data[].updated_at`required	`string (date-time)`
`data[].deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.
`next_cursor`required	`string \| null`	Pass as `cursor` to get the next page; `null` on the last page.

Example

Bash

curl -X GET "https://api.becklinks.com/v1/links" \
  -H "Authorization: Bearer $SECRET_KEY"

POST/links

Create a link

Creates a link on the environment’s shared domain (or on domain_id). Without path a random 7-character path is generated. In the live environment the creating user must have a verified email address. A destination URL that looks suspicious is saved and listed in warnings; one that is listed as dangerous is refused with 422 url_blocked.

Secret key scope (any of): links:write

Request body

Field	Type	Description
`domain_id`	`string`	The domain to serve the link on. Omit for the environment’s shared domain (`{slug}.becklinks.com`, or `{slug}-test.…` in test).
`path`	`string`	The short path, 1–64 characters of letters, digits, "-" and "_". Omit to get a generated 7-character path. A path of a deleted link stays reserved for 90 days.
`name`	`string \| null`
`deep_link_path`required	`string`	The in-app route handed to the app, e.g. `/product/123`; `/` for the start screen.
`data`	`object`	Custom JSON delivered to the app, at most 4 KB as stored; keys at most 64 characters.
`campaign`	`string \| null`	Key of a campaign of this environment; the link inherits its UTM defaults.
`utm`	`object \| null`	Overrides of the campaign’s UTM fields; a field left null is inherited.
`redirects`	`object \| null`	Per-platform destinations. `ios` and `android` take https or a custom app scheme, the rest https only; a missing destination uses the project defaults.
`expires_at`	`string (date-time) \| null`	When the link stops working (ISO-8601 UTC); must be in the future.
`allow_param_passthrough`	`boolean`	Pass query parameters added to the short URL on to the app payload (LNK-005).
`tags`	`string[]`
`metadata`	`object`	Your own annotations; never sent to the app. At most 4 KB as stored.

Responses

201 The new link.

Field	Type	Description
`id`required	`string`
`url`required	`string`	The short URL: `https://{host}/{path}`.
`qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`domain_id`required	`string`
`host`required	`string`
`path`required	`string`
`name`required	`string \| null`
`deep_link_path`required	`string`
`data`required	`object`
`campaign`required	`object \| null`
`utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`utm.source`required	`string \| null`
`utm.medium`required	`string \| null`
`utm.content`required	`string \| null`
`utm.term`required	`string \| null`
`utm.creative`required	`string \| null`
`effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`effective_utm.source`required	`string \| null`
`effective_utm.medium`required	`string \| null`
`effective_utm.content`required	`string \| null`
`effective_utm.term`required	`string \| null`
`effective_utm.creative`required	`string \| null`
`redirects`required	`object`
`redirects.ios`required	`string \| null`
`redirects.android`required	`string \| null`
`redirects.web`required	`string \| null`
`redirects.desktop`required	`string \| null`
`redirects.fallback`required	`string \| null`
`status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`expires_at`required	`string (date-time) \| null`
`allow_param_passthrough`required	`boolean`
`tags`required	`string[]`
`metadata`required	`object`
`version`required	`integer`
`created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.
`warnings`required	`object[]`
`warnings[].code`required	`"destination_suspicious"`
`warnings[].pointer`required	`string`	JSON Pointer to the field the warning is about.
`warnings[].detail`required	`string`
`warnings[].reasons`required	`string[]`	Stable reason codes of the URL check.

Example

Bash

curl -X POST "https://api.becklinks.com/v1/links" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"deep_link_path":"string"}'

POST/links/bulk

Create links in bulk

Creates up to 1,000 links in one request (body up to 10 MiB). By default every valid link is created and each invalid one is reported in results (the response is always 200; check failed). With atomic: true either all links are created or none. Each item follows CreateLinkRequest. A destination URL that looks suspicious is saved and listed in warnings; one that is listed as dangerous is refused with 422 url_blocked.

Secret key scope (any of): links:write

Request body

Field	Type	Description
`links`required	`object[]`	1 to 1000 objects shaped like CreateLinkRequest (the body may be up to 10 MiB).
`atomic`	`boolean`	false (default): every valid link is created and each invalid one is reported in `results`. true: all links are created or none (the first problem answers 422 and nothing is saved).

Responses

200 The outcome of each link.

Field	Type	Description
`created`required	`integer`
`failed`required	`integer`
`results`required	`object[]`	One entry per submitted link, in request order.
`results[].index`required	`integer`
`results[].status`required	`"created" \| "failed"`
`results[].link`required	`object \| null`
`results[].error`required	`object \| null`

Example

Bash

curl -X POST "https://api.becklinks.com/v1/links/bulk" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"links":[{}]}'

GET/links/{link}

Get a link

One link, including a deleted one that is still in the trash (deleted_at is set).

Secret key scope (any of): links:read, links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.

Responses

200 The link.

Field	Type	Description
`id`required	`string`
`url`required	`string`	The short URL: `https://{host}/{path}`.
`qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`domain_id`required	`string`
`host`required	`string`
`path`required	`string`
`name`required	`string \| null`
`deep_link_path`required	`string`
`data`required	`object`
`campaign`required	`object \| null`
`utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`utm.source`required	`string \| null`
`utm.medium`required	`string \| null`
`utm.content`required	`string \| null`
`utm.term`required	`string \| null`
`utm.creative`required	`string \| null`
`effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`effective_utm.source`required	`string \| null`
`effective_utm.medium`required	`string \| null`
`effective_utm.content`required	`string \| null`
`effective_utm.term`required	`string \| null`
`effective_utm.creative`required	`string \| null`
`redirects`required	`object`
`redirects.ios`required	`string \| null`
`redirects.android`required	`string \| null`
`redirects.web`required	`string \| null`
`redirects.desktop`required	`string \| null`
`redirects.fallback`required	`string \| null`
`status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`expires_at`required	`string (date-time) \| null`
`allow_param_passthrough`required	`boolean`
`tags`required	`string[]`
`metadata`required	`object`
`version`required	`integer`
`created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.

Example

Bash

curl -X GET "https://api.becklinks.com/v1/links/{link}" \
  -H "Authorization: Bearer $SECRET_KEY"

PATCH/links/{link}

Update a link

Changes the fields sent and keeps the short URL. Every change writes a new version. Send expected_version to refuse the change when someone else edited the link meanwhile (409 version_conflict). A request that changes nothing returns the link unchanged. path and the domain cannot change. A blocked link cannot be edited. A destination URL that looks suspicious is saved and listed in warnings; one that is listed as dangerous is refused with 422 url_blocked.

Secret key scope (any of): links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.

Request body

Field	Type	Description
`name`	`string \| null`
`deep_link_path`	`string`
`data`	`object`	Custom JSON delivered to the app, at most 4 KB as stored; keys at most 64 characters.
`campaign`	`string \| null`	Key of a campaign of this environment; the link inherits its UTM defaults.
`utm`	`object \| null`	Fields sent here change, fields left out stay; send a field as null to inherit it again.
`redirects`	`object \| null`	Destinations sent here change, others stay; send one as null to use the project default.
`expires_at`	`string (date-time) \| null`	ISO-8601 UTC, or null for no expiry. Setting a future date revives an expired link.
`allow_param_passthrough`	`boolean`	Pass query parameters added to the short URL on to the app payload (LNK-005).
`tags`	`string[]`
`metadata`	`object`	Your own annotations; never sent to the app. At most 4 KB as stored.
`expected_version`	`integer`	The `version` you based this change on. If the link changed since, the request fails with 409 `version_conflict` and nothing is saved.
`change_reason`	`string`	A note stored with the new version in the history.

Responses

200 The updated link.

Field	Type	Description
`id`required	`string`
`url`required	`string`	The short URL: `https://{host}/{path}`.
`qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`domain_id`required	`string`
`host`required	`string`
`path`required	`string`
`name`required	`string \| null`
`deep_link_path`required	`string`
`data`required	`object`
`campaign`required	`object \| null`
`utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`utm.source`required	`string \| null`
`utm.medium`required	`string \| null`
`utm.content`required	`string \| null`
`utm.term`required	`string \| null`
`utm.creative`required	`string \| null`
`effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`effective_utm.source`required	`string \| null`
`effective_utm.medium`required	`string \| null`
`effective_utm.content`required	`string \| null`
`effective_utm.term`required	`string \| null`
`effective_utm.creative`required	`string \| null`
`redirects`required	`object`
`redirects.ios`required	`string \| null`
`redirects.android`required	`string \| null`
`redirects.web`required	`string \| null`
`redirects.desktop`required	`string \| null`
`redirects.fallback`required	`string \| null`
`status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`expires_at`required	`string (date-time) \| null`
`allow_param_passthrough`required	`boolean`
`tags`required	`string[]`
`metadata`required	`object`
`version`required	`integer`
`created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.
`warnings`required	`object[]`
`warnings[].code`required	`"destination_suspicious"`
`warnings[].pointer`required	`string`	JSON Pointer to the field the warning is about.
`warnings[].detail`required	`string`
`warnings[].reasons`required	`string[]`	Stable reason codes of the URL check.

Example

Bash

curl -X PATCH "https://api.becklinks.com/v1/links/{link}" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}'

DELETE/links/{link}

Delete a link

Moves the link to the trash: it stops redirecting at once and can be restored for 30 days. Its short path stays reserved for 90 days so old traffic never reaches a new destination. Deleting a deleted link succeeds.

Secret key scope (any of): links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.

Responses

204 The link is deleted.

Example

Bash

curl -X DELETE "https://api.becklinks.com/v1/links/{link}" \
  -H "Authorization: Bearer $SECRET_KEY"

POST/links/{link}/archive

Archive a link

Hides the link from the default list and stops it from redirecting. Its short path stays its own; restore it to use it again.

Secret key scope (any of): links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.

Responses

200 The archived link.

Field	Type	Description
`id`required	`string`
`url`required	`string`	The short URL: `https://{host}/{path}`.
`qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`domain_id`required	`string`
`host`required	`string`
`path`required	`string`
`name`required	`string \| null`
`deep_link_path`required	`string`
`data`required	`object`
`campaign`required	`object \| null`
`utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`utm.source`required	`string \| null`
`utm.medium`required	`string \| null`
`utm.content`required	`string \| null`
`utm.term`required	`string \| null`
`utm.creative`required	`string \| null`
`effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`effective_utm.source`required	`string \| null`
`effective_utm.medium`required	`string \| null`
`effective_utm.content`required	`string \| null`
`effective_utm.term`required	`string \| null`
`effective_utm.creative`required	`string \| null`
`redirects`required	`object`
`redirects.ios`required	`string \| null`
`redirects.android`required	`string \| null`
`redirects.web`required	`string \| null`
`redirects.desktop`required	`string \| null`
`redirects.fallback`required	`string \| null`
`status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`expires_at`required	`string (date-time) \| null`
`allow_param_passthrough`required	`boolean`
`tags`required	`string[]`
`metadata`required	`object`
`version`required	`integer`
`created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.
`warnings`required	`object[]`
`warnings[].code`required	`"destination_suspicious"`
`warnings[].pointer`required	`string`	JSON Pointer to the field the warning is about.
`warnings[].detail`required	`string`
`warnings[].reasons`required	`string[]`	Stable reason codes of the URL check.

Example

Bash

curl -X POST "https://api.becklinks.com/v1/links/{link}/archive" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

POST/links/{link}/disable

Disable a link

Stops the link from redirecting (within a minute). Disabling a disabled link succeeds without change. Expired, archived and blocked links cannot be disabled (409).

Secret key scope (any of): links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.

Responses

200 The disabled link.

Field	Type	Description
`id`required	`string`
`url`required	`string`	The short URL: `https://{host}/{path}`.
`qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`domain_id`required	`string`
`host`required	`string`
`path`required	`string`
`name`required	`string \| null`
`deep_link_path`required	`string`
`data`required	`object`
`campaign`required	`object \| null`
`utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`utm.source`required	`string \| null`
`utm.medium`required	`string \| null`
`utm.content`required	`string \| null`
`utm.term`required	`string \| null`
`utm.creative`required	`string \| null`
`effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`effective_utm.source`required	`string \| null`
`effective_utm.medium`required	`string \| null`
`effective_utm.content`required	`string \| null`
`effective_utm.term`required	`string \| null`
`effective_utm.creative`required	`string \| null`
`redirects`required	`object`
`redirects.ios`required	`string \| null`
`redirects.android`required	`string \| null`
`redirects.web`required	`string \| null`
`redirects.desktop`required	`string \| null`
`redirects.fallback`required	`string \| null`
`status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`expires_at`required	`string (date-time) \| null`
`allow_param_passthrough`required	`boolean`
`tags`required	`string[]`
`metadata`required	`object`
`version`required	`integer`
`created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.
`warnings`required	`object[]`
`warnings[].code`required	`"destination_suspicious"`
`warnings[].pointer`required	`string`	JSON Pointer to the field the warning is about.
`warnings[].detail`required	`string`
`warnings[].reasons`required	`string[]`	Stable reason codes of the URL check.

Example

Bash

curl -X POST "https://api.becklinks.com/v1/links/{link}/disable" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

POST/links/{link}/enable

Enable a link

Makes a disabled link redirect again. An expired link is revived by changing its expires_at, an archived one by restoring it (409 otherwise).

Secret key scope (any of): links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.

Responses

200 The enabled link.

Field	Type	Description
`id`required	`string`
`url`required	`string`	The short URL: `https://{host}/{path}`.
`qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`domain_id`required	`string`
`host`required	`string`
`path`required	`string`
`name`required	`string \| null`
`deep_link_path`required	`string`
`data`required	`object`
`campaign`required	`object \| null`
`utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`utm.source`required	`string \| null`
`utm.medium`required	`string \| null`
`utm.content`required	`string \| null`
`utm.term`required	`string \| null`
`utm.creative`required	`string \| null`
`effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`effective_utm.source`required	`string \| null`
`effective_utm.medium`required	`string \| null`
`effective_utm.content`required	`string \| null`
`effective_utm.term`required	`string \| null`
`effective_utm.creative`required	`string \| null`
`redirects`required	`object`
`redirects.ios`required	`string \| null`
`redirects.android`required	`string \| null`
`redirects.web`required	`string \| null`
`redirects.desktop`required	`string \| null`
`redirects.fallback`required	`string \| null`
`status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`expires_at`required	`string (date-time) \| null`
`allow_param_passthrough`required	`boolean`
`tags`required	`string[]`
`metadata`required	`object`
`version`required	`integer`
`created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.
`warnings`required	`object[]`
`warnings[].code`required	`"destination_suspicious"`
`warnings[].pointer`required	`string`	JSON Pointer to the field the warning is about.
`warnings[].detail`required	`string`
`warnings[].reasons`required	`string[]`	Stable reason codes of the URL check.

Example

Bash

curl -X POST "https://api.becklinks.com/v1/links/{link}/enable" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

POST/links/{link}/restore

Restore a link

Brings an archived link back as active, or takes a deleted link out of the trash (within 30 days; it keeps the status it had, so restore an archived and deleted link twice).

Secret key scope (any of): links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.

Responses

200 The restored link.

Field	Type	Description
`id`required	`string`
`url`required	`string`	The short URL: `https://{host}/{path}`.
`qr_url`required	`string`	Path of the QR code image of this link (PNG or SVG) on this API, e.g. `/v1/links/{id}/qr`.
`domain_id`required	`string`
`host`required	`string`
`path`required	`string`
`name`required	`string \| null`
`deep_link_path`required	`string`
`data`required	`object`
`campaign`required	`object \| null`
`utm`required	`object`	The link’s own UTM values; null where the campaign’s value is inherited.
`utm.source`required	`string \| null`
`utm.medium`required	`string \| null`
`utm.content`required	`string \| null`
`utm.term`required	`string \| null`
`utm.creative`required	`string \| null`
`effective_utm`required	`object`	What a click records: the link’s value, else the campaign’s.
`effective_utm.source`required	`string \| null`
`effective_utm.medium`required	`string \| null`
`effective_utm.content`required	`string \| null`
`effective_utm.term`required	`string \| null`
`effective_utm.creative`required	`string \| null`
`redirects`required	`object`
`redirects.ios`required	`string \| null`
`redirects.android`required	`string \| null`
`redirects.web`required	`string \| null`
`redirects.desktop`required	`string \| null`
`redirects.fallback`required	`string \| null`
`status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`expires_at`required	`string (date-time) \| null`
`allow_param_passthrough`required	`boolean`
`tags`required	`string[]`
`metadata`required	`object`
`version`required	`integer`
`created_by`required	`string \| null`	The user who created the link; null for links made with an API or SDK key.
`created_at`required	`string (date-time)`
`updated_at`required	`string (date-time)`
`deleted_at`required	`string (date-time) \| null`	Set while the link is in the trash; it is purged 30 days later.
`warnings`required	`object[]`
`warnings[].code`required	`"destination_suspicious"`
`warnings[].pointer`required	`string`	JSON Pointer to the field the warning is about.
`warnings[].detail`required	`string`
`warnings[].reasons`required	`string[]`	Stable reason codes of the URL check.

Example

Bash

curl -X POST "https://api.becklinks.com/v1/links/{link}/restore" \
  -H "Authorization: Bearer $SECRET_KEY" \
  -H "Idempotency-Key: $(uuidgen)"

GET/links/{link}/versions

List the versions of a link

The history of the link, newest first: each version holds the whole link as it was. To go back to a version, PATCH the link with that snapshot’s values.

Secret key scope (any of): links:read, links:write

Parameters

Field	Type	Description
`link (path)`required	`string`	The ID of the link.
`limit (query)`	`integer`	Items per page (1–100).
`cursor (query)`	`string`	`next_cursor` of the previous page; omit for the first page. A cursor only works with the sort order it was issued for.

Responses

200 A page of versions.

Field	Type	Description
`data`required	`object[]`
`data[].version`required	`integer`
`data[].snapshot`required	`object`	The link as it was at this version. To go back to it, PATCH the link with these values.
`data[].snapshot.id`required	`string`
`data[].snapshot.domain`required	`string`
`data[].snapshot.path`required	`string`
`data[].snapshot.name`required	`string \| null`
`data[].snapshot.deep_link_path`required	`string`
`data[].snapshot.data`required	`object`
`data[].snapshot.campaign`required	`string \| null`
`data[].snapshot.utm`required	`object`
`data[].snapshot.utm.source`required	`string \| null`
`data[].snapshot.utm.medium`required	`string \| null`
`data[].snapshot.utm.content`required	`string \| null`
`data[].snapshot.utm.term`required	`string \| null`
`data[].snapshot.utm.creative`required	`string \| null`
`data[].snapshot.redirects`required	`object`
`data[].snapshot.redirects.ios`required	`string \| null`
`data[].snapshot.redirects.android`required	`string \| null`
`data[].snapshot.redirects.web`required	`string \| null`
`data[].snapshot.redirects.desktop`required	`string \| null`
`data[].snapshot.redirects.fallback`required	`string \| null`
`data[].snapshot.status`required	`"active" \| "disabled" \| "expired" \| "archived" \| "blocked"`
`data[].snapshot.expires_at`required	`string \| null`
`data[].snapshot.allow_param_passthrough`required	`boolean`
`data[].snapshot.tags`required	`string[]`
`data[].snapshot.metadata`required	`object`
`data[].snapshot.deleted_at`required	`string \| null`
`data[].snapshot.version`required	`integer`
`data[].snapshot.created_at`required	`string`
`data[].changed_by`required	`string \| null`	The user who made the change; null for an API or SDK key.
`data[].change_reason`required	`string \| null`
`data[].created_at`required	`string (date-time)`
`next_cursor`required	`string \| null`	Pass as `cursor` to get the next page; `null` on the last page.

Example

Bash

curl -X GET "https://api.becklinks.com/v1/links/{link}/versions" \
  -H "Authorization: Bearer $SECRET_KEY"