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 - Listar encaminhamentos
- POST /v1/public/accounts/{account_id}/forwarding - Criar encaminhamento
- POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/confirm - Confirmar verificação de encaminhamento
- POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/send - Enviar verificação de encaminhamento
- POST /v1/public/forwarding/verify - Verificar destinatário de encaminhamento
- PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id} - Atualizar encaminhamento
- PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/active - Definir encaminhamento como ativo
- DELETE /v1/public/accounts/{account_id}/forwarding/{forwarding_id} - 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
Referência OpenAPI:
/openapi.pt-br.json GET /v1/public/accounts/{account_id}/forwardingCriar 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
Referência OpenAPI:
/openapi.pt-br.json POST /v1/public/accounts/{account_id}/forwardingConfirmar 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
Referência OpenAPI:
/openapi.pt-br.json POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/confirmEnviar 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
Referência OpenAPI:
/openapi.pt-br.json POST /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/verification/sendVerificar 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
Referência OpenAPI:
/openapi.pt-br.json POST /v1/public/forwarding/verifyAtualizar 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}
Referência OpenAPI:
/openapi.pt-br.json PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}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
Referência OpenAPI:
/openapi.pt-br.json PATCH /v1/public/accounts/{account_id}/forwarding/{forwarding_id}/activeExcluir 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}
Referência OpenAPI:
/openapi.pt-br.json DELETE /v1/public/accounts/{account_id}/forwarding/{forwarding_id}