Skip to main content
POST
/
v1
/
workspaces
/
{workspace_id}
/
domains
Create new domain
curl --request POST \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id}/domains \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alias": "My Company Marketing Domain",
  "custom_not_found_url": "https://example.com/not-found",
  "domain": "example.com",
  "fallback_domain": "fallback.com"
}'
{
  "id": "<string>"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
workspace_id
string<uuid>
required

ID of the workspace.

Example:

"ab782971-4d79-47ab-8685-77cf5a34b2bb"

Query Parameters

​
offset
integer
default:0

Number of resources to skip.

Required range: x >= 0
​
limit
integer
default:100

Number of resources to return.

Required range: 1 <= x <= 1000

Body

application/json
​
domain
string
required

Domain that belongs to the workspace.

Required string length: 4 - 2000
Example:

"example.com"

​
alias
string | null

Alias of the domain.

Required string length: 1 - 120
Example:

"My Company Marketing Domain"

​
custom_not_found_url
string<uri> | null

Custom not found URL for the workspace.

Required string length: 4 - 2000
Example:

"https://example.com/not-found"

​
fallback_domain
string | null

Fallback domain for the workspace.

Required string length: 4 - 2000
Example:

"fallback.com"

Response

Example response

​
id
string
required

ID of the newly created resource.