Skip to contentDevelopersPrezly website
Domains

Check Domain Records

Check DNS and refresh whether the custom domain is active.

Personal token scopes: sites:read. Your account must also have access to the requested data. Authentication

Although mapped to sites:read for personal tokens, this check can activate or deactivate the domain. The owner needs newsroom and custom-domain management permissions.

Read the guide

POST
/newsrooms/{newsroom_id}/domains/{domain}/check

This check changes state: valid DNS can activate the custom domain, and invalid DNS can deactivate it. It saves the newsroom and queues network/index updates. The personal-token mapping requires sites:read, while underlying management permissions still apply.

Personal access tokens: sites:read. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.

Authorization

API_key
headerAuthorizationBearer <token>

Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.

Path Parameters

newsroom_id*string

Newsroom UUID or ID

Length1 <= length
domain*string

Domain name

Response Body

OK

application/json
  1. response
domain*
Example Request
curl -X POST 'https://api.prezly.com/v2/newsrooms/string/domains/string/check'
Example Response200
{  "domain": {    "domain_name": "string",    "type": "prezly",    "status": "active",    "instructions": [      {        "domain_name": "string",        "type": "cname",        "recommended_value": "string",        "is_valid": true      }    ]  }}