Skip to content
Docs
Esc
↑↓navigate↵open⌘Jpreview

Update registration settings

Changes settings of a domain the team registered through Spacefast: transferLock, WHOIS privacySetting, the registrant (contactId of a saved contact), and the autoRenew preference. Unlocking transfers, turning off privacy, or changing the registrant affects who controls the domain and whose details are public, so make those changes only at the user’s request. autoRenew is saved as a preference only; nothing renews automatically yet, and renewal is a separate registration action.

PATCH/v1/domains/{domainId}/registration
Authorization
AuthorizationBearer token · headerrequired

Space key (sfc_…) for an unclaimed anonymous Space. Also the fragment of its claim URL and the token of its /__/<key> door. A publish without a credential returns it in claim with the claim link. With the key, getSpace extends the Space's expiry window, getSpaceVersion follows its publish, createSpaceOpenLink returns its reusable open link, and restoreSpace undoes a deleteSpace while the claim window remains open.

or
AuthorizationBearer token · headerrequired

Better Auth session, OAuth access token, OAuth client-credentials token, or sfm_ Space machine credential.

or
AuthorizationOAuth2 access token · headerrequired

OAuth 2.0 with explicit Spacefast capability scopes. Use the authorization-code flow for people and client credentials for machines.

Scopes:domains:write
Path parameters
domainIdstringrequired
Request body
requiredapplication/json
autoRenewboolean

Saves the auto-renew preference. Nothing renews on its own yet; renew with { action: "renew" }.

transferLockboolean

Pass true to enable the registrar transfer lock. Pass false to disable it.

privacySettingstring

WHOIS privacy behavior.

Allowed:enable_privacy_serviceredact_contact_infodisclose_contact_info
contactIdstring | null

Registrant contact record.

Show properties
Any of:
string
string
null
null
Responses
200

Response for status 200

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

dataobjectrequired
Show properties
idstring | nullrequired

Registration or transfer record id; null when unregistered.

domainIdstringrequired

Domain inventory record (dom_...).

hostnamestringrequired

Registered hostname.

providerstring | nullrequired

Wrapped registrar bridge where the registration lives.

Show properties
Any of:
string
string
null
null
statusstringrequired

Registration lifecycle status. pending_payment means checkout is open and nothing is registered yet.

expiresAtstring<date-time> | nullrequired

Instant when the registration expires.

Show properties
Any of:
string<date-time>
string<date-time>
null
null
redemptionEndsAtstring<date-time> | nullrequired

Instant when the redemption window ends after expiry.

Show properties
Any of:
string<date-time>
string<date-time>
null
null
autoRenewbooleanrequired

Saved auto-renew preference. Nothing renews on its own yet; renew by hand.

transferLockbooleanrequired

Whether outbound transfers are locked.

privacySettingstring | nullrequired

WHOIS privacy behavior.

Show properties
Any of:
string
string
null
null
contactIdstring | nullrequired

Registrant contact record.

failureReasonstring | nullrequired

Provider failure detail when status is failed.

purchaseobject | nullrequired

Money state of the current purchase or renewal line; null when none is in flight.

Show properties
Any of:
object
intentIdstringrequired

Purchase intent that paid for this line.

lineStatusstringrequired
Allowed:awaiting_paymentsubmittingsettledrefundingrefundedcancelled
checkoutobject | null

The open payment link, when you request includeCheckout. You get it only when you may purchase this domain and, when the checkout was opened with billing authority over the paying team, hold that authority too. Null when you cannot get an open link; check checkoutUnavailable for lookup failures. Omitted when you do not request it or may not purchase this domain.

Show properties
Any of:
object
idstringrequired

Existing Stripe Checkout session id.

urlstring<uri>required

Open this existing checkout to complete payment.

expiresAtstring<date-time>required

When this checkout expires.

matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
null
null
checkoutUnavailableboolean

True when the requested payment link could not be retrieved or verified. Registration status remains available. Retry the read to recover the existing checkout; do not start another purchase.

quotedFeeAmountCentsinteger | nullrequired

Registrar fee before tax, in cents.

Show properties
Any of:
integer
integer
null
null
paidAmountCentsinteger | nullrequired

What the customer paid for this line, tax included, in cents.

Show properties
Any of:
integer
integer
null
null
refundobject | nullrequired
Show properties
Any of:
object
referencestringrequired

Stripe refund id.

amountCentsintegerrequired
min -9007199254740991 · max 9007199254740991
refundedAtstring<date-time>required
matches ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
null
null
null
null
createdAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
updatedAtstring<date-time> | nullrequired
Show properties
Any of:
string<date-time>
string<date-time>
null
null
default

Problem details (RFC 9457). Any 4xx/5xx response is one application/problem+json document.

$schemastring<uri>

Canonical JSON Schema URL for this response body. The server also sends it in the Link: rel="describedby" response header.

typestringrequired

Problem type URI resolving to the error docs page. The server derives it mechanically from code against the docs origin.

titlestringrequired

Short human-readable summary of the problem type. The server derives it mechanically from code.

statusintegerrequired

HTTP status code of this response, repeated in the body.

min -9007199254740991 · max 9007199254740991
detailstringrequired

Human-readable failure explanation for this occurrence.

codestringrequired

Stable snake_case error code naming the failed public contract.

pointerstring

RFC 6901 JSON Pointer into the failing request field, for example "/files/37/path", on validation failures.

detailsobject

Machine-readable context for the error code.

fixstring

One sentence on what to do about this error code, the same text as the type page. Read it before retrying.

suggestionsstring[]

Actionable recovery steps safe to show in dashboards, SDKs, and CLI output.

nextstring[]

Copy-pasteable commands or API requests an agent can run next.

requestIdstringrequired

The request id to quote when contacting support.

Try it
Server
Authorization
Parameters
Bodyapplication/json
Request
curl -X PATCH 'https://api.spacefast.com/v1/domains/string/registration' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "autoRenew": true,
  "transferLock": true,
  "privacySetting": "enable_privacy_service",
  "contactId": "string"
}'
Response
{
  "$schema": "http://example.com",
  "data": {
    "id": "string",
    "domainId": "string",
    "hostname": "string",
    "provider": "dsapi",
    "status": "string",
    "expiresAt": "2019-08-24T14:15:22Z",
    "redemptionEndsAt": "2019-08-24T14:15:22Z",
    "autoRenew": true,
    "transferLock": true,
    "privacySetting": "enable_privacy_service",
    "contactId": "string",
    "failureReason": "string",
    "purchase": {
      "intentId": "string",
      "lineStatus": "awaiting_payment",
      "checkout": {
        "id": "string",
        "url": "http://example.com",
        "expiresAt": "2019-08-24T14:15:22Z"
      },
      "checkoutUnavailable": true,
      "quotedFeeAmountCents": -9007199254740991,
      "paidAmountCents": -9007199254740991,
      "refund": {
        "reference": "string",
        "amountCents": -9007199254740991,
        "refundedAt": "2019-08-24T14:15:22Z"
      }
    },
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}

Was this page helpful?