/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
API Reference Remove Domain

Remove Domain

Remove a custom domain from a project

DELETE/v1/projects/{projectId}/domains/{domainId}Try it
Session token

Remove a custom domain from a project. The documentation will no longer be accessible via this domain.

Note

Org membership is required. Being signed in is not enough: you must be a member of the organization that owns {projectId}. A project you cannot see returns 404, one you are not a member of returns 403 with the forbidden code — see Authentication.

Requires the admin or owner role. Adding, verifying, retrying and removing custom domains are admin actions; a member gets 403 forbidden with details.requiredRole: "admin". Any member can list domains and poll their status.

Removing a domain is not plan-gated, so a workspace that has downgraded can still clean up its domains.

Path Parameters

NameDescription
projectId:stringpathRequired
The project ID (e.g., 3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c).
domainId:stringpathRequired
The domain ID.

Response

Returns 200 with { "data": { "deleted": true } }. If the domain was the project's primary domain, the project no longer has one: its docsUrl goes back to https://{slug}-docs.syntext.dev.

Response

Warning

After removing a domain, visitors to that domain will see an error page. The documentation will still be accessible via its default {slug}-docs.syntext.dev URL. The domain is released, so it can be added to another project.

Error Responses

403 Forbidden

Returned when you are a member of the workspace but not an admin or owner (details.requiredRole: "admin"), or not a member of the organization that owns the project.

404 Not Found

Returned when the project does not exist. Deleting is idempotent: a domain id that is not in the project, or has already been removed, still returns { "data": { "deleted": true } }.

Was this page helpful? Yes No
Request
bashJavaScriptPythonGoRubyPHPJavaC#bash
curl -X DELETE https://api.syntext.dev/v1/projects/3f2a9c1e-8b4d-4e7a-9c21-5d6e7f8a9b0c/domains/6b1e0c9a-2f4d-4b8e-9a51-0c7d3e2f1a44 \
-H "Authorization: Bearer $SYNTEXT_JWT"
Responseapplication/json
json
{
"data": { "deleted": true }
}
Product
Resources
Company
© 2026 SyntextBuilt with Syntext