PATCH
/
v1
/
workspaces
/
{workspace_id}
/
domains
/
{domain_id}
curl --request PATCH \
  --url https://api.ziplink.click/v1/workspaces/{workspace_id}/domains/{domain_id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "alias": "My Company Marketing Domain",
  "custom_not_found_url": "https://example.com/not-found",
  "fallback_domain": "fallback.com"
}'
{
  "alias": "My Company Marketing Domain",
  "created_at": "2023-11-07T05:31:56Z",
  "custom_not_found_url": "https://example.com/404",
  "domain": "exmpl.com",
  "fallback_domain": "example.com",
  "id": "ab782971-4d79-47ab-8685-77cf5a34b2bb",
  "updated_at": "2023-11-07T05:31:56Z",
  "workspace_id": "ab782971-4d79-47ab-8685-77cf5a34b2bb"
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
workspace_id
string
required

ID of the workspace.

Example:

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

​
domain_id
string
required

ID of the domain.

Example:

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

Body

application/json
​
alias
string | null

Alias of the domain.

Required string length: 1 - 120
Example:

"My Company Marketing Domain"

​
custom_not_found_url
string | 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

200
application/json
OK

A domain related to a workspace.

​
alias
string | null
required

A custom name for the domain to identify easier.

Required string length: 1 - 120
Example:

"My Company Marketing Domain"

​
created_at
string
required

Date when the workspace was created.

​
custom_not_found_url
string | null
required

The URL to be redirected to when a 404 error occurs.

Maximum length: 2000
Example:

"https://example.com/404"

​
domain
string
required

Domain that will be used for custom redirects.

Required string length: 4 - 255
Example:

"exmpl.com"

​
fallback_domain
string | null
required

The URL to be redirected to when a redirect is requested.

Required string length: 4 - 255
Example:

"example.com"

​
id
string
required

Unique identifier of the domain.

Example:

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

​
updated_at
string | null
required

Date when the workspace was updated.

​
workspace_id
string
required

Unique identifier of the workspace the domain belongs to.

Example:

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