API reference

API reference · Organizations

Claim an email domain

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

members.manage. Public mail providers are refused, and a domain another crew proved is refused. At most 10 per crew. Prove it by publishing antimatter-verify=<token> as a TXT record at _antimatter.<domain> (or the domain itself).

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
domainrequiredstring

Example

{
  "domain": "string"
}

Answer 201

Claimed.

Fields of the 201 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.

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