v2

latestOpenAPI 3.1.0raw.githubusercontent.com2026-04-12308185.7 KB
domains

Update a domain (overwriting update)

Perform Domain updates while doing full resets of the records.

Change Owner with Record Reset

{
  "owner": {
    "type": "EXTERNAL",
    "address": "0x123"
  },
  "records": {}
}

Clears all records from the domain, then changes owner to the new owner address.

NOTE: You must include "records": {} to indicate the intent to clear records.

Owner Types

When changing owner of a domain, you must provide both a type and an address to clearly indicate the intent of the change.

  • NONE: Used when changing the owner to a "burn" address, which will result in nobody owning the domain
    • Valid "burn" addresses are 0x0000000000000000000000000000000000000000 and 0x000000000000000000000000000000000000dEaD
  • UD: Used when changing the owner to an addressed owned by Unstoppable Domains
  • SELF: Used when changing the owner to another address that belongs to your account
  • EXTERNAL: Used when changing the owner to address that doesn't qualify as any of the above.
    • WARNING: This will result in the domain belonging to an address outside of the management of Unstoppable Domains and we will have no way to recover it.

Update Records with Record Reset

{
  "records": {
    "key2": "value2"
  }
}

When applied to a domain with existing records, only key2 will remain after the update is complete.

See our documentation for more information on standardized keys.

put/domains/{name}

Path parameters

namestring required
Example:matt.crypto

Query parameters

$previewboolean

Allows simulating the operation creation (when set to true), without actually starting any processing. This can be used to validate the operation will be permitted and get a preview of the initial outcome.

When used, the operation in the response will have PREVIEW for all id and status values.

Request body

recordsUpdateDomainRecords

Example request

{
  "owner": {
    "address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321"
  },
  "records": {
    "crypto.ETH.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321",
    "crypto.MATIC.version.MATIC.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e5678",
    "crypto.MATIC.version.ERC20.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e0921"
  }
}

Response

@type'unstoppabledomains.com/partner.v3.DomainOperationResult' required

Example response

{
  "operation": {
    "id": "op-4abb409c-9283-4589-bd36-d27a757a2165",
    "domain": "matt.crypto",
    "lastUpdatedTimestamp": 1684356429790,
    "dependencies": [
      {
        "id": "bc-2db427bd-5613-40c7-85b1-ab38beed0ed0",
        "parameters": {
          "initialRecords": {
            "crypto.ETH.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321",
            "crypto.MATIC.version.MATIC.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e5678",
            "crypto.MATIC.version.ERC20.address": "0xb4783AeF93923a2d4eEA29C84f347F26E62e0921"
          },
          "toAddress": "0xb4783AeF93923a2d4eEA29C84f347F26E62e4321"
        }
      }
    ]
  }
}