Update a vanity domain

PATCH

/vanity-domains/{vanityDomainId}

Vanity Domains

Updates a vanity domain. Setting primary: true designates this hostname as the one used in the workspace's outbound-email links (magic links, invitations, notifications) for its context, atomically replacing any previous primary of that context. Setting false clears it.

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

Vanity domain updated

Bodyapplication/json

🟠401Unauthorized

🟠404Record Not Found

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH 'https://api.aworld.cloud/dashboard/v1/vanity-domains/' \
--header 'Content-Type: application/json' \
--data '{
    "primary": true
}'

Response Example

{
    "vanityDomainId": "FUMzPf00hz_kcj2R2Hlzq",
    "hostname": "learn.acme.com",
    "context": "app",
    "cloudflareCustomHostnameId": "string",
    "primary": false,
    "accountId": "stringstri",
    "workspaceId": "stringstri",
    "sourceRegion": "us-east-1",
    "createdAt": "2019-08-24T14:15:22.123Z",
    "updatedAt": "2019-08-24T14:15:22.123Z",
    "status": {
        "state": "PENDING",
        "sslStatus": "string",
        "ownershipStatus": "string",
        "verificationRecords": [
            {
                "kind": "OWNERSHIP",
                "type": "TXT",
                "name": "string",
                "value": "string"
            }
        ]
    }
}

Modified at 2026-07-22 08:08:42

Get a vanity domain

Delete a vanity domain