Skip to content

by Startups.Studio

Product Domains and access Domain

Domain.release

POST /{namespace}/domains/{domain}/release

Release lets a Domain’s registration or claim end, keeping its record, history and aliases.

Noun: Domain
Mode: do
Event: Domain.released

You, to your agent

Release the latest domain.

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

import { $ } from 'startup-builder'

const domain = await $.Domain.release({ domain: 'domain_1', reason: 'Example reason' })

npx startup-builder do Domain.release --json '{"domain":"domain_1","reason":"Example reason"}'

{
  "name": "do",
  "arguments": {
    "code": "return await $.Domain.release({ domain: 'domain_1', reason: 'Example reason' })"
  }
}

Inputs

Input	Type	Required	Description
`domain`	Domain	required	The Domain to let go.
`reason`	`text`	required	Why it is released, recorded as a Decision.

Outputs

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

Effects

Emits Domain.released.
Performed by the Legal Lead.
One-way (customer, brand): it waits out its delay window, and runs in the send and do modes.
Refuses a Domain whose carriedIdentity is true: it received mail, hosted a Mailbox or verified an outside account.
Refuses a canonical Domain while the Startup is Live.
Runs when a Tenant ends or loses its Entitlement, for each name that Tenant connected.

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.release
A Domain whose `carriedIdentity` is true: it received mail, hosted a Mailbox or verified an outside account	`refused`	Clear what the check names, then call it again.	Domain.release
A canonical Domain while the Startup is Live	`refused`	Clear what the check names, then call it again.	Domain.release

When it waits

Gate	Default
Decision class	High: one-way, broad (customer, brand)
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.register

Previous Page

Domain.renew

Next Page