v1Recursos/Connections/deleteCancelar un enlace de conexión

Cancelar un enlace de conexión

Cancela un enlace de conexión que no se ha completado, para que ya no se pueda usar. Cancelar un enlace ya cancelado funciona sin error. Un enlace ya completado devuelve 400.

delete/api/v1/connections/connect-links/{id}
connections:write
Parámetros de consulta
idstringobligatorio
El id del enlace de conexión, de la respuesta de creación.
Respuesta
dataobjectopcional
idstringopcional
El id del enlace. Úsalo para consultar el estado o cancelar el enlace.
platformstringopcional
La red que conecta el enlace.
clientIdstringopcional
El cliente para el que es el enlace.
statusstring (pending | started | completed | abandoned | cancelled | expired)opcional
En qué punto está el enlace: pending (aún no abierto), started (abierto, a la espera de que la persona termine), completed (la cuenta está conectada), abandoned (abierto pero no terminado en una hora), cancelled o expired (no abierto antes de expiresAt).
expiresAtstringopcional
Cuándo deja de funcionar el enlace si nadie lo ha abierto.
startedAtstringopcional
Cuándo se abrió el enlace, o null si aún no se ha abierto.
connectionIdstringopcional
La conexión que produjo el enlace, una vez completado. Null hasta entonces.
reconnectConnectionIdstringopcional
La conexión que se reconecta, cuando el enlace se creó para reconectar una. Solo la devuelve la respuesta de creación; las consultas de estado devuelven null.
Errores
400A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
401La clave de API falta, es inválida, expiró o fue revocada.
403A la clave le falta el permiso requerido, o no está autorizada para este cliente/ubicación.
404El recurso no se encontró, o no pertenece a su agencia.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
delete/api/v1/connections/connect-links/{id}
Su clave de API
id *
{}

Guías que usan este recurso