v1Recursos/Connections/deleteCancelar um link de conexão

Cancelar um link de conexão

Cancela um link de conexão que não foi concluído, para que não possa mais ser usado. Cancelar um link já cancelado funciona normalmente. Um link já concluído retorna 400.

delete/api/v1/connections/connect-links/{id}
connections:write
Parâmetros de consulta
idstringobrigatório
O id do link de conexão, da resposta de criação.
Resposta
dataobjectopcional
idstringopcional
O id do link. Use-o para consultar o status ou cancelar o link.
platformstringopcional
A rede que o link conecta.
clientIdstringopcional
O cliente a que o link se destina.
statusstring (pending | started | completed | abandoned | cancelled | expired)opcional
Em que ponto está o link: pending (ainda não aberto), started (aberto, aguardando a pessoa terminar), completed (a conta está conectada), abandoned (aberto, mas não concluído em uma hora), cancelled ou expired (não aberto antes de expiresAt).
expiresAtstringopcional
Quando o link deixa de funcionar se ninguém o abriu.
startedAtstringopcional
Quando o link foi aberto, ou null se ainda não foi.
connectionIdstringopcional
A conexão gerada pelo link, depois de concluído. Null até lá.
reconnectConnectionIdstringopcional
A conexão sendo reconectada, quando o link foi criado para reconectar uma. Somente a resposta de criação a retorna; as consultas de status retornam null.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
delete/api/v1/connections/connect-links/{id}
Sua chave de API
id *
{}

Guias que usam este recurso