mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 04:19:37 +00:00
16 lines
6.3 KiB
Markdown
16 lines
6.3 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. | |
|
|
| `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 |
|
|
| `createdAt` | *string* | :heavy_check_mark: | The date the domain was created. | |
|
|
| `updatedAt` | *string* | :heavy_check_mark: | The date the domain was last updated. | | |