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.

Use these endpoints to change the availability of a verified account domain. Activate the domain to allow domain-based user linking. Deactivate the domain to stop using it without deleting it.

Activate account domain

Use this endpoint to activate a verified 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

This endpoint does not require a request body.

Request example

PATCH https://api.platform_address_here/api/v1/account/3fa85f64-5717-4562-b3fc-2c963f66afa6/domain/3fa85f64-5717-4562-b3fc-2c963f66afa6/activate
Authorization: Bearer {token}
Content-Type: application/json

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"
}

Response status codes

Code	Description
200	Success
400	Bad request
401	Not authorized
403	Forbidden
404	Domain not found

Deactivate account domain

Use this endpoint to deactivate an account domain.

Endpoint
Method	PATCH
Request URL	/api/v1/account/{accountUuid}/domain/{domainUuid}/deactivate
Headers
Authorization *	Bearer TOKEN
Content-Type	application/json
Request
accountUuid *	Target account UUID
domainUuid *	Account domain UUID

This endpoint does not require a request body.

Request example

PATCH https://api.platform_address_here/api/v1/account/3fa85f64-5717-4562-b3fc-2c963f66afa6/domain/3fa85f64-5717-4562-b3fc-2c963f66afa6/deactivate
Authorization: Bearer {token}
Content-Type: application/json

Response example

If the domain is deactivated, the response will contain the INACTIVE status.

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

Response status codes

Code	Description
200	Success
400	Bad request
401	Not authorized
403	Forbidden
404	Domain not found

Related topics

• Add Account Domain

• Check Account Domain

• Domain Statuses & Verify Methods