API reference

API reference · Organizations

Prove a domain, or switch auto approve

PATCH/api/orgs/{id}/domainsSigned in session

members.manage. action check_dns looks up the TXT record now; send_email sends a one time link to admin, administrator, hostmaster, postmaster, webmaster at the domain (503 email_off unless email is configured; a mailbox takes 2 links a day and a domain 5, whoever asks); auto_approve lets a proven address at the domain join as a member without a review. An email proof lapses after 30 days; a DNS proof does not, and it takes a domain back from a team that proved it by email.

Parameters

Path and query parameters
FieldTypeWhat it is
id (path)requiredintegerThe crew's id.

Request body

application/json, required

Request body fields
FieldTypeWhat it is
idrequiredinteger
actionrequiredstringOne of "check_dns", "send_email", "auto_approve".
mailboxstringOne of "admin", "administrator", "hostmaster", "postmaster", "webmaster".
autoApproveboolean

Example

{
  "id": 0,
  "action": "check_dns",
  "mailbox": "admin",
  "autoApprove": false
}

Answer 200

The domain.

Fields of the 200 answer
FieldTypeWhat it is
domainobject
domain.idinteger
domain.domainstring
domain.verifiedAtinteger or null
domain.verifiedMethodstring or nullOne of "dns", "email", null.
domain.autoApproveboolean
domain.createdAtinteger
domain.lastCheckedAtinteger or null
domain.dnsobject
domain.dns.hoststring
domain.dns.type"TXT"
domain.dns.valuestring
domain.emailPendingTostring or null
domain.verifiedUntilinteger or nullWhen an email proof lapses (it lasts 30 days); null for DNS, which does not.

Errors

  • 400OpenAI shaped error.
  • 401OpenAI shaped error.
  • 403OpenAI shaped error.
  • 404OpenAI shaped error.
  • 409OpenAI shaped error.
  • 429OpenAI shaped error.
  • 503OpenAI shaped error.

Every error answers in one shape, with its type, code and the field it names. The whole list is in the docs' Errors section.

Antimatter