Skip to main content
PUT
Regenerate unlisted link
Replace {your-subdomain} with your workspace’s subdomain.
Learn how to find your subdomain in Workspace subdomain.

Headers

X-Api-Key
string
default:your-api-key
required

Use the X-Api-Key header to provide your workspace API key. Refer to Authentication for more information.

Path Parameters

article_id
string
required

Unique identifier of the article. Can be the article's slug, permalink, or ID. Refer to Getting the Article ID section for detailed instructions.

Body

application/json
expiration_type
enum<string>
default:never

How the link should expire. Defaults to "never". For "one_day", "seven_days", or "thirty_days", the expiration date is computed automatically. Use "custom" together with expiration_date for an exact expiration time.

Available options:
never,
one_day,
seven_days,
thirty_days,
custom
Example:

"seven_days"

expiration_date
string<date-time>

Exact expiration date and time. Must be in the future. Required when expiration_type is "custom"; providing it together with any other expiration_type is rejected. If provided without expiration_type, expiration_type is treated as "custom".

Example:

"2026-08-21T10:00:00.000Z"

Response

OK - Request succeeded