Skip to main content
POST
Redirect a domain

Authorizations

Authorization
string
header
required

Send your API token as Authorization: Bearer <api-token>.

Path Parameters

domainID
string
required

The domain's _id. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Query Parameters

teamID
string

Run the request in the context of a team you belong to, instead of your personal account. 24-character hexadecimal ID.

Pattern: ^[0-9a-fA-F]{24}$

Body

application/json
redirectTo
string
default:""

The full URL to redirect to, for example https://example.com. Empty to remove the redirect. Wildcard hosts aren't allowed.

redirectStatus
enum<integer>
default:302
Available options:
301,
302

Response

The redirect was saved. The response body is empty.