Pular para o conteúdo principal
POST
/
v1
/
public
/
accounts
/
{account_id}
/
forwarding
Criar encaminhamento
curl --request POST \
  --url https://api.hybridbox.io/v1/public/accounts/{account_id}/forwarding \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "target_email": "jsmith@example.com",
  "domain": "<string>",
  "workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "active": true,
  "created_at": "<string>",
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "scope_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "target_email": "<string>",
  "updated_at": "<string>",
  "verification_required": true,
  "verification_expires_at": "<string>",
  "verification_sent_at": "<string>",
  "verification_verified_at": "<string>"
}

Autorizações

​
Authorization
string
header
obrigatório

Public API bearer credential sent as Authorization: Bearer <token>. Use either an OAuth access token or a Hybridbox Service account token.

Parâmetros de caminho

​
account_id
string<uuid>
obrigatório

Corpo

application/json

Solicitação para criar uma regra de encaminhamento sob o escopo do caminho da conta.

​
target_email
string<email>
obrigatório

Endereço de e-mail de destino de encaminhamento

​
domain
string | null

Escopo da regra de encaminhamento como UUID do dominio ou nome do dominio

​
workspace_id
string<uuid> | null

Escopo do espaço de trabalho UUID para a regra de encaminhamento

Resposta

​
active
boolean
obrigatório

Se o encaminhamento está ativo

​
created_at
string
obrigatório

Carimbo de data e hora de criação da regra de encaminhamento

​
id
string<uuid>
obrigatório

Regra de encaminhamento UUID

​
scope_id
string<uuid>
obrigatório

Recurso UUID para o escopo de encaminhamento

​
scope_type
enum<string>
obrigatório

Tipo de escopo de recurso para a regra de encaminhamento

Opções disponíveis:
account,
workspace,
domain
​
target_email
string
obrigatório

Endereço de e-mail de destino de encaminhamento

​
updated_at
string
obrigatório

Carimbo de data e hora da última atualização da regra de encaminhamento

​
verification_required
boolean
obrigatório

Se a verificação do destinatário é necessária

​
verification_state
enum<string>
obrigatório

Estado de verificação do destinatário

Opções disponíveis:
internal,
pending,
verified,
expired
​
verification_expires_at
string | null

Carimbo de data e hora de expiração da verificação

​
verification_sent_at
string | null

E-mail de verificação enviado com data e hora

​
verification_verified_at
string | null

Carimbo de data e hora de conclusão da verificação