Activate/Deactivate Account Domain

This document contains details for activating and deactivating an account domain via the /activate and /deactivate endpoints, including response examples and domain statuses.

Activate account domain

Use this endpoint to activate an account domain.

Endpoint

Method

PATCH

Request URL

/api/v1/account/{accountUuid}/domain/{domainUuid}/activate

Headers

Authorization *

Bearer TOKEN

Content-Type

application/json

Request

accountUuid *

Target account UUID

domainUuid *

Account domain UUID

Response example

If the domain is activated, the response will contain the ACTIVE status.

{
    "uuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "accountUuid": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "domain": "google.com",
    "status": "ACTIVE",
    "verifyInfo" : {
        "domain": "_whitedoc-verify",
        "value": "abc123"
    },
    "verifyMethod": "DNS_TXT_RECORD"
}

Deactivate account domain

Use this endpoint to deactivate an account domain.