mirror of
https://github.com/LukeHagar/dub-node.git
synced 2025-12-06 04:19:37 +00:00
14 lines
5.2 KiB
Markdown
14 lines
5.2 KiB
Markdown
# CreateDomainRequestBody
|
|
|
|
|
|
## Fields
|
|
|
|
| Field | Type | Required | Description | Example |
|
|
| ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------ |
|
|
| `slug` | *string* | :heavy_check_mark: | Name of the domain. | acme.com |
|
|
| `type` | [operations.Type](../../models/operations/type.md) | :heavy_minus_sign: | The type of redirect to use for this domain. | redirect |
|
|
| `target` | *string* | :heavy_minus_sign: | The page your users will get redirected to when they visit your domain. | https://acme.com/landing |
|
|
| `expiredUrl` | *string* | :heavy_minus_sign: | Redirect users to a specific URL when any link under this domain has expired. | https://acme.com/expired |
|
|
| `archived` | *boolean* | :heavy_minus_sign: | Whether to archive this domain. `false` will unarchive a previously archived domain. | false |
|
|
| `noindex` | *boolean* | :heavy_minus_sign: | Prevent search engines from indexing the domain. Defaults to `false`. | |
|
|
| `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 | |