Additional properties that you can pass to the partner's short link. Will be used to override the default link properties for this partner.
| Field | Type | Required | Description | Example |
|---|---|---|---|---|
external_id |
OptionalNullable[str] | ➖ | The ID of the link in your database. If set, it can be used to identify the link in future API requests (must be prefixed with 'ext_' when passed as a query parameter). This key is unique across your workspace. | 123456 |
tenant_id |
OptionalNullable[str] | ➖ | The ID of the tenant that created the link inside your system. If set, it can be used to fetch all links for a tenant. | |
prefix |
Optional[str] | ➖ | Path prefix for each default referral link slug (e.g. /c/ → https://{domain}/c/{identity}). If the group has multiple default links, a short random suffix is appended to the identity segment for uniqueness (e.g. c/jane-a7f2). |
|
archived |
Optional[bool] | ➖ | Whether the short link is archived. Defaults to false if not provided. |
|
tag_ids |
Optional[operations.CreatePartnerTagIds] | ➖ | The unique IDs of the tags assigned to the short link. | [ "clux0rgak00011..." ] |
tag_names |
Optional[operations.CreatePartnerTagNames] | ➖ | The unique name of the tags assigned to the short link (case insensitive). | |
comments |
OptionalNullable[str] | ➖ | The comments for the short link. | |
expires_at |
OptionalNullable[str] | ➖ | The date and time when the short link will expire at. | |
expired_url |
OptionalNullable[str] | ➖ | The URL to redirect to when the short link has expired. | |
password |
OptionalNullable[str] | ➖ | The password required to access the destination URL of the short link. | |
proxy |
Optional[bool] | ➖ | Whether the short link uses Custom Link Previews feature. Defaults to false if not provided. |
|
title |
OptionalNullable[str] | ➖ | The custom link preview title (og:title). Will be used for Custom Link Previews if proxy is true. Learn more: https://d.to/og |
|
description |
OptionalNullable[str] | ➖ | The custom link preview description (og:description). Will be used for Custom Link Previews if proxy is true. Learn more: https://d.to/og |
|
image |
OptionalNullable[str] | ➖ | The custom link preview image (og:image). Will be used for Custom Link Previews if proxy is true. Learn more: https://d.to/og |
|
video |
OptionalNullable[str] | ➖ | The custom link preview video (og:video). Will be used for Custom Link Previews if proxy is true. Learn more: https://d.to/og |
|
rewrite |
Optional[bool] | ➖ | Whether the short link uses link cloaking. Defaults to false if not provided. |
|
ios |
OptionalNullable[str] | ➖ | The iOS destination URL for the short link for iOS device targeting. | |
android |
OptionalNullable[str] | ➖ | The Android destination URL for the short link for Android device targeting. | |
do_index |
Optional[bool] | ➖ | Allow search engines to index your short link. Defaults to false if not provided. Learn more: https://d.to/noindex |
|
test_variants |
List[operations.CreatePartnerTestVariants] | ➖ | An array of A/B test URLs and the percentage of traffic to send to each URL. | [ { "url": "https://example.com/variant-1", "percentage": 50 }, { "url": "https://example.com/variant-2", "percentage": 50 } ] |
test_started_at |
OptionalNullable[str] | ➖ | The date and time when the tests started. | |
test_completed_at |
OptionalNullable[str] | ➖ | The date and time when the tests were or will be completed. |