Skip to main content
PATCH
Atualizar encaminhamento

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
forwarding_id
string<uuid>
obrigatório

Corpo

application/json

Solicitação para atualizar um destino de encaminhamento.

target_email
string<email>
obrigatório

Endereço de e-mail de destino 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