mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-10 04:19:48 +00:00
18 lines
7.5 KiB
Markdown
18 lines
7.5 KiB
Markdown
# DomainSchema
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
| `id` | *string* | :heavy_check_mark: | The unique identifier of the domain. | |
|
|
| `slug` | *string* | :heavy_check_mark: | The domain name. | acme.com |
|
|
| `verified` | *boolean* | :heavy_minus_sign: | Whether the domain is verified. | |
|
|
| `primary` | *boolean* | :heavy_minus_sign: | Whether the domain is the primary domain for the workspace. | |
|
|
| `archived` | *boolean* | :heavy_minus_sign: | Whether the domain is archived. | |
|
|
| `noindex` | *boolean* | :heavy_minus_sign: | Prevent search engines from indexing the domain. | |
|
|
| `placeholder` | *string* | :heavy_minus_sign: | Provide context to your teammates in the link creation modal by showing them an example of a link to be shortened. | https://dub.co/help/article/what-is-dub |
|
|
| `expiredUrl` | *string* | :heavy_check_mark: | The URL to redirect to when a link under this domain has expired. | https://acme.com/expired |
|
|
| `target` | *string* | :heavy_check_mark: | The page your users will get redirected to when they visit your domain. | https://acme.com/landing |
|
|
| `type` | [components.Type](../../models/components/type.md) | :heavy_check_mark: | The type of redirect to use for this domain. | |
|
|
| `clicks` | *number* | :heavy_minus_sign: | The number of clicks on the domain. | | |