Skip to main content
POST
Configure Domain Automatically
Not available yet. Automatic DNS setup has not been released, so today this route answers 404 DOMAIN_CONNECT_UNAVAILABLE on every call. Create the records yourself with Domain DNS Records.
The route is part of the API contract so clients can handle it. It requires the apps:write scope when called with an API key. The rest of this page describes the response shape, which no call returns today.
string
required
The application ID.
string
required
The domain ID, from List Application Domains.
string
If the application belongs to a workspace, the workspace’s ID. Required for workspace members acting on an application they don’t own.

Response

APIApplicationDomainConnect
The link is for you to open, not to call. After you approve it, the domain becomes active once DNS propagates; follow it with List Application Domains.

Error Responses

string
The error code indicating the reason for the failure. Possible values:
  • VALIDATION_ERROR: The path parameters failed validation (400). The response also carries message and path.
  • UNAUTHORIZED: The request is not authenticated (401).
  • USER_NOT_FOUND: The authenticated user could not be resolved (401).
  • ACCESS_DENIED: The user does not have permission to act on the application (403).
  • API_KEY_SCOPE_DENIED: The API key does not have the apps:write scope (403).
  • APP_NOT_FOUND: The specified application does not exist (404).
  • DOMAIN_NOT_FOUND: The application has no domain with that ID (404).
  • DOMAIN_CONNECT_UNAVAILABLE: Automatic setup is not available yet, so every call answers this code (404). Use the manual records instead.
  • RATE_LIMIT_EXCEEDED: The route’s budget was reached (429).
  • INTERNAL_SERVER_ERROR: Unexpected failure (500).
This route has its own budget of 10 requests per minute. See Rate Limiting.