Ativar o envio de e-mail

Cria a conta de envio do workspace e o subdomínio compartilhado do período de avaliação e responde na hora, com setup.state em in_progress. A configuração no provedor (conta, identidade, registros DNS e rota de respostas) roda em segundo plano logo em seguida; consulte GET /email/setup até setup.state sair de in_progress. Se falhar, setup.state fica failed com o motivo em setup.errorCode. Pode ser repetido: cada chamada recomeça a configuração pendente, sem duplicar nada. Depois o domínio fica em verificação até o provedor confirmar. Exige plano pago ativo (activation.allowed de GET /email/setup diz antes); sem ele responde email_plan_required; uma conta já ativa não é desfeita quando o plano acaba.
O corpo é opcional: slug escolhe o nome do subdomínio de envio (o endereço fica contato@<slug>.<domínio compartilhado>). Sem ele, vale o nome sugerido em subdomain.slug de GET /email/setup. O nome precisa vir na forma final (minúsculas, números e hífens), não pode ser reservado nem estar em uso por outro workspace. Ativar de novo com outro nome troca o subdomínio enquanto nada foi enviado por ele.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

Nome do subdomínio

string
Headers
string

Workspace da requisição. Sem ele vale o workspace padrão da pessoa; um workspace do qual ela não participa responde 403 workspace_not_member.

string

Departamento que limita os dados. Quem não participa do departamento recebe 403; donos e administradores escolhem qualquer um.

Responses

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json