/v1/workspace/domains/{id}/form-hostServe forms from a workspace domain
Names the address under one of the workspace's verified domains (apply.acmecapital.com) that its form links use instead of the default, and answers the domain with its formHost: the CNAME record to create and a pending status. One per workspace - naming another replaces it. Refused with 409 when the domain is not verified, 400 when the address is not under the domain (or is the domain itself, which DNS cannot point anywhere), 503 when this deployment serves no custom form addresses. Use the domain's recheck once the record is published; links switch over only when it is found.
Access class: workspace:admin.
Send request
Use the documented inputs to call this endpoint directly.
Parameters
Values are applied to the request and the example on the right.
Request body
application/jsonrequiredResponses
the action's answer
{
"data": {
"createdAt": "2026-01-01T00:00:00Z",
"domain": "string",
"formHost": {
"hostname": "string",
"record": {
"host": "string",
"ok": true,
"purpose": "string",
"required": true,
"type": "string",
"value": "string"
},
"status": "string"
},
"id": "",
"inboundCount": 1.5,
"lastCheckedAt": "2026-01-01T00:00:00Z",
"records": [
{
"host": "string",
"lastCheckedAt": "string",
"ok": true,
"purpose": "string",
"required": true,
"type": "string",
"value": "string"
}
],
"status": "string",
"verifiedAt": "2026-01-01T00:00:00Z"
}
}a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.
{
"error": "string"
}