> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hybridbox.io/llms.txt
> Use this file to discover all available pages before exploring further.

# Encaminhamento

> Referência gerada para pontos de extremidade de Encaminhamento.

# Encaminhamento

Referência gerada para pontos de extremidade de Encaminhamento.

Esta página gerada agrupa todas as operações da API pública na categoria Encaminhamento.

## Pontos de extremidade

* [GET /v1/public/accounts/\{account\_id}/forwarding](/pt-br/api/v1/public/accounts/account_id/forwarding/get) - Listar encaminhamentos
* [POST /v1/public/accounts/\{account\_id}/forwarding](/pt-br/api/v1/public/accounts/account_id/forwarding/post) - Criar encaminhamento
* [POST /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}/verification/confirm](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/verification/confirm/post) - Confirmar verificação de encaminhamento
* [POST /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}/verification/send](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/verification/send/post) - Enviar verificação de encaminhamento
* [POST /v1/public/forwarding/verify](/pt-br/api/v1/public/forwarding/verify/post) - Verificar destinatário de encaminhamento
* [PATCH /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/patch) - Atualizar encaminhamento
* [PATCH /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}/active](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/active/patch) - Definir encaminhamento como ativo
* [DELETE /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/delete) - Excluir encaminhamento

## Listar encaminhamentos

**GET** `/v1/public/accounts/{account_id}/forwarding`

Listar encaminhamentos

Lista regras de encaminhamento sob a conta no caminho.

Referência completa: [GET /v1/public/accounts/\{account\_id}/forwarding](/pt-br/api/v1/public/accounts/account_id/forwarding/get)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json GET /v1/public/accounts/{account_id}/forwarding`
</Note>

## Criar encaminhamento

**POST** `/v1/public/accounts/{account_id}/forwarding`

Criar encaminhamento

Cria uma regra de encaminhamento sob a conta no caminho.

Referência completa: [POST /v1/public/accounts/\{account\_id}/forwarding](/pt-br/api/v1/public/accounts/account_id/forwarding/post)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json POST /v1/public/accounts/{account_id}/forwarding`
</Note>

## Confirmar verificação de encaminhamento

**POST** `/v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/confirm`

Confirmar verificação de encaminhamento

Confirma a verificação do destinatário com um código informado pelo cliente.

Referência completa: [POST /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}/verification/confirm](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/verification/confirm/post)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/confirm`
</Note>

## Enviar verificação de encaminhamento

**POST** `/v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/send`

Enviar verificação de encaminhamento

Envia ou reenvia a verificação do destinatário para uma regra de encaminhamento de cliente.

Referência completa: [POST /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}/verification/send](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/verification/send/post)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/send`
</Note>

## Verificar destinatário de encaminhamento

**POST** `/v1/public/forwarding/verify`

Verificar destinatário de encaminhamento

Confirma um destinatário de encaminhamento usando um token público.

Referência completa: [POST /v1/public/forwarding/verify](/pt-br/api/v1/public/forwarding/verify/post)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json POST /v1/public/forwarding/verify`
</Note>

## Atualizar encaminhamento

**PATCH** `/v1/public/accounts/{account_id}/forwarding/{forwarding_id}`

Atualizar encaminhamento

Atualiza uma regra de encaminhamento de cliente sob a conta no caminho.

Referência completa: [PATCH /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/patch)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}`
</Note>

## Definir encaminhamento como ativo

**PATCH** `/v1/public/accounts/{account_id}/forwarding/{forwarding_id}/active`

Definir encaminhamento como ativo

Pausa ou retoma uma regra de encaminhamento de cliente.

Referência completa: [PATCH /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}/active](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/active/patch)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/active`
</Note>

## Excluir encaminhamento

**DELETE** `/v1/public/accounts/{account_id}/forwarding/{forwarding_id}`

Excluir encaminhamento

Exclui uma regra de encaminhamento de cliente sob a conta no caminho.

Referência completa: [DELETE /v1/public/accounts/\{account\_id}/forwarding/\{forwarding\_id}](/pt-br/api/v1/public/accounts/account_id/forwarding/forwarding_id/delete)

<Note>
  Referência OpenAPI: `/openapi.pt-br.json DELETE /v1/public/accounts/{account_id}/forwarding/{forwarding_id}`
</Note>

<script src="/locale-bridge.js" />