domain-management

Update a domain

Comprehensive domain update — modify nameservers, DNSSEC, contacts, flags, and DNS records in a single operation. All fields are optional; only include the sections you want to change. Returns an operation that tracks all the resulting changes.

patch/domains/{name}

Path parameters

namestring required

Domain name

Query parameters

$previewboolean required

Preview mode — validate the request without executing changes.

Request body

Example request

{
  "nameservers": {
    "items": [
      "ns1.example.com",
      "ns2.example.com"
    ]
  },
  "contacts": {
    "owner": {
      "id": "ct-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "phone": {
        "dialingPrefix": "+1"
      }
    },
    "admin": {
      "id": "ct-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "phone": {
        "dialingPrefix": "+1"
      }
    },
    "tech": {
      "id": "ct-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "phone": {
        "dialingPrefix": "+1"
      }
    },
    "billing": {
      "id": "ct-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      "phone": {
        "dialingPrefix": "+1"
      }
    }
  },
  "records": {
    "update": [
      {
        "id": "rr-a1b2c3d4-e5f6-7890-abcd-ef1234567890"
      }
    ]
  }
}

Response

Update operation created

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

Example response

{
  "operation": {
    "id": "op-a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "dependencies": [
      {
        "id": "plop_abc12345-1234-1234-1234-abc123456789",
        "parameters": {
          "owner": {
            "id": "con_abc12345-1234-1234-1234-abc123456789"
          },
          "contacts": {
            "admin": {
              "id": "con_abc12345-1234-1234-1234-abc123456789"
            },
            "billing": {
              "id": "con_abc12345-1234-1234-1234-abc123456789"
            },
            "tech": {
              "id": "con_abc12345-1234-1234-1234-abc123456789"
            }
          },
          "period": 1
        }
      }
    ]
  }
}

Changes

Changed in 2 of the 26 revisions of this API.416

  • 64f751be432d415See the full diff
    • the registrantAgreementAcknowledged request property const value true was added

      request-property-const-added

    • removed the enum value true of the request property contacts/owner/tldData/ca/registrantAgreementAcknowledged

      request-property-enum-value-removed

    • the nameservers/dnssec/items/items/algorithm request property type/format changed from number/ to integer/

      request-property-type-changed

    • the nameservers/dnssec/items/items/digestType request property type/format changed from number/ to integer/

      request-property-type-changed

    • added the new DOMAIN_ADMIN_DNS_ZONE_MIGRATE enum value to the operation/type response property for the response status 200

      response-property-enum-value-added

    • added the non-success response with the status 400

      response-non-success-status-added

    • added the non-success response with the status 401

      response-non-success-status-added

    • added the non-success response with the status 403

      response-non-success-status-added

    • added the non-success response with the status 404

      response-non-success-status-added

    • added the non-success response with the status 500

      response-non-success-status-added

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

    • endpoint added

      endpoint-added

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog