Update Domain
Updates configuration for an existing custom domain in your account.
Endpoint
POST
v5/domain/{domain_id}
Requires authentication
Path Parameters
The domain to update.
domain_id
string
required
The ID of the domain to update.
Query Parameters
All query parameters are optional. Supply only the fields you want to change.
domain
string
The domain URL to register. Domains must be between 3 and 63 alphanumeric or hyphen characters. Your domain will automatically end with:
.alchemer.com
type
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 updated domain record nested under its domain ID key.
result_ok
boolean
Whether the request succeeded.
data
object
A keyed object containing the updated domain record, where the key is the domain ID.
child attributes
id
integer
The unique ID of the domain.
customerID
string
The account (customer) ID this domain belongs to.
type
string
The domain type. Possible values:
Private, Subdomain.domain
string
The domain URL after the update.
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 originally created.
Examples
Request (cURL)
curl -X POST "https://api.alchemer.com/v5/domain/YOUR_DOMAIN_ID?api_token=YOUR_API_TOKEN&api_token_secret=YOUR_API_TOKEN_SECRET&domain=surveys.yourcompany.com"
Response
{
"result_ok": true,
"data": {
"YOUR_DOMAIN_ID": {
"id": YOUR_DOMAIN_ID,
"customerID": "YOUR_CUSTOMER_ID",
"type": "Private",
"domain": "surveys.alchemer.com",
"redirect": "",
"eStatus": "Active",
"created": "2017-09-25 17:39:12"
}
}
}