organisation
Declare an email domain
/api/v1/organisation/domains
Declare a domain. It is inactive until the TXT record given by record_name and record_value is published and its check asked for.
key
Required scope: org:admin
Request body application/json
-
domainstring · requiredThe domain name.
Response
201
Domain
-
idintegerId of the domain.
-
domainstringThe domain name.
-
statusstringinactive: declared, its check not asked for yet.pending: check asked for.verified: checked; every account verified on the domain is then a root reader of the organisation. -
record_namestringName of the DNS TXT record to publish.
-
record_valuestringValue of the DNS TXT record to publish.
Errors
-
401
No valid credential.
-
403
The credential lacks the required scope, or the account may not do this.
-
409
The current state of the content forbids the request.
-
422
A value is missing or malformed.
-
429
Too many requests;
Retry-Aftergives the seconds to wait.