blog.pckt.domain.set Documentation (EN)

main procedure

Set or update the custom domain for a publication. Returns a verification token that must be installed as a TXT record before calling verify.

Parameters

blog stringat-uri Required

AT-URI of the publication record (site.standard.publication). Authority MUST match the caller's DID.

Input

Encodingapplication/json

domain string Required

Fully-qualified domain name (lowercase).

maxLength: 253 bytes

Output

Encodingapplication/json

domain string Required

No description available.

verificationToken string Optional

Token to install as a TXT record at _pckt-verify.<domain>.

verified boolean Required

No description available.

Errors

BlogNotFound

PlanLimitReached

InvalidDomain

Try It

Requests are sent directly from your browser. Some servers may block requests due to CORS.

Service Endpoint Base URL for XRPC calls (e.g., https://bsky.social)

Request Body (JSON) Enter valid JSON for the request body

View raw schema

{
  "type": "procedure",
  "input": {
    "schema": {
      "type": "object",
      "required": [
        "domain"
      ],
      "properties": {
        "domain": {
          "type": "string",
          "maxLength": 253,
          "description": "Fully-qualified domain name (lowercase)."
        }
      }
    },
    "encoding": "application/json"
  },
  "errors": [
    {
      "name": "BlogNotFound"
    },
    {
      "name": "PlanLimitReached"
    },
    {
      "name": "InvalidDomain"
    }
  ],
  "output": {
    "schema": {
      "type": "object",
      "required": [
        "domain",
        "verified"
      ],
      "properties": {
        "domain": {
          "type": "string"
        },
        "verified": {
          "type": "boolean"
        },
        "verificationToken": {
          "type": "string",
          "description": "Token to install as a TXT record at _pckt-verify.<domain>."
        }
      }
    },
    "encoding": "application/json"
  },
  "parameters": {
    "type": "params",
    "required": [
      "blog"
    ],
    "properties": {
      "blog": {
        "type": "string",
        "format": "at-uri",
        "description": "AT-URI of the publication record (site.standard.publication). Authority MUST match the caller's DID."
      }
    }
  },
  "description": "Set or update the custom domain for a publication. Returns a verification token that must be installed as a TXT record before calling verify."
}