Descrição

Envia um convite por e-mail para um novo usuário se cadastrar na plataforma SOAR. O convite é enviado usando o serviço SendGrid.

Cabeçalhos

Corpo da Requisição

{
  "email": "jhon.doe@email.com",
  "name": "Jhon"
}

Observação: o campo name é opcional. Se não informado, será utilizado "Guest".

Respostas

Sucesso - 200

{
  "status": "success",
  "message": "Invitation successfully sent to jhon.doe@email.com"
}

Erro - 422 (E-mail inválido)

{
  "status": 422,
  "error": "Invalid or missing email."
}

Erro - 401 (Usuário não autenticado)

{
  "status": 401,
  "error": "User not authenticated."
}

Erro - 500 (Falha no envio ou processamento)

{
  "status": 500,
  "error": "Failed to send the invitation."
}

Códigos de Resposta

• 200 - Convite enviado com sucesso
• 422 - E-mail inválido
• 401 - Usuário não autenticado
• 500 - Falha ao enviar/processar convite