Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.transfer

POST /{namespace}/domains/{domain}/transfer

Transfer moves a Domain’s registration to another holder or registrar, with its records intact.

Noun: Domain
Mode: do
Event: Domain.transferred

You, to your agent

Transfer the latest domain.

curl -X POST https://api.sb/shiftnote.app/domains/domain_1/transfer \
  -H "Authorization: Bearer $STARTUP_BUILDER_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"to":"Example to","kind":"in"}'

import { $ } from 'startup-builder'

const domain = await $.Domain.transfer({ domain: 'domain_1', to: 'Example to', kind: 'in' })

npx startup-builder do Domain.transfer --json '{"domain":"domain_1","to":"Example to","kind":"in"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.transfer({ domain: 'domain_1', to: 'Example to', kind: 'in' })"
  }
}

Inputs

Input	Type	Required	Description
`domain`	Domain	required	The Domain to move.
`to`	`string`	required	The receiving holder or registrar.
`kind`	`string`	required	`in` from another registrar, `registrant` to a new owner, `push` between accounts, or `out` to leave.
`code`	Secret		The transfer code, for `in` and `out`.

Outputs

Output	Type	Required	Description
`domain`	Domain	required	The transferred Domain.

Effects

Emits Domain.transferred.
Performed by the Legal Lead.
One-way (customer): it waits out its delay window, and runs in the send and do modes.
Refuses before transferableAt.
Keeps the record and its history; a claimed label moves as a redirect, then retires.

Refuses when

Check	Error	Fix	Then call
The key is valid, but its scopes do not allow this operation.	`forbidden`	Use a key whose scopes cover the operation, or ask an owner of the namespace to grant them.	Domain.transfer
The record is not in a state that allows this Verb, so the call is refused.	`refused`	Read the record, run the Verb that moves it to an allowed state, then retry.	Domain.transfer
Before `transferableAt`	`refused`	Clear what the check names, then call it again.	Domain.transfer

When it waits

Gate	Default
Decision class	High: one-way, broad (customer)
Delay window	1 business day, in which a watcher can pause, redirect or cancel it; then it runs.
Limit	The call Limit of the Permission it runs under.
Over the Limit	It waits `pending` for an Approval from the Founder. Approved, it runs; refused, it ends `refused` with `limit-exceeded`; unanswered by its deadline, it ends `canceled`.

Domain.search

Previous Page

Domain.update

Next Page