Create Domain
Creates a new custom domain in your account.
Endpoint
PUT
v5/domain
Requires authentication
Path Parameters
None
Query Parameters
domain
string
required
The domain URL to register. Domains must be between 3 and 63 alphanumeric or hyphen characters. Your domain will automatically end with:
.alchemer.comtype
string
The domain type. Accepted values:
Private, Subdomain (case sensitive).redirect
string
The survey-not-found redirect URL (e.g.
company.com). Applies to Private domains only.
Response
Returns the newly created domain record nested under its domain ID key.
result_ok
boolean
Whether the request succeeded.
data
object
A keyed object containing the newly created domain record, where the key is the domain ID.
child attributes
id
integer
The unique ID of the newly created domain.
customerID
string
The account (customer) ID this domain belongs to.
type
string
The domain type. Possible values:
Private, Subdomain.domain
string
The registered domain URL.
redirect
string
The survey-not-found redirect URL. Empty string if not configured.
eStatus
string
The domain status (e.g.
Active).created
string
Timestamp when the domain was created.
Examples
Request (cURL)
curl -X PUT "https://api.alchemer.com/v5/domain?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&domain=surveys.yourcompany.com&type=Private"
Response
{
"result_ok": true,
"data": {
"YOUR_DOMAIN_ID": {
"id": YOUR_DOMAIN_ID,
"customerID": "YOUR_CUSTOMER_ID",
"type": "Private",
"domain": "surveys.yourcompany.com",
"redirect": "",
"eStatus": "Active",
"created": "2017-09-25 17:39:12"
}
}
}