v1Recursos/Connections/postCrear un enlace de conexión

Crear un enlace de conexión

Crea un enlace de un solo uso que conecta una cuenta de marca de un cliente en Facebook, Instagram, LinkedIn, X, Pinterest o YouTube. Envía la url a alguien con acceso al cliente en Synup: la abre con su sesión iniciada y aprueba la conexión en su propio navegador. El enlace funciona una vez y caduca al cabo de una hora si nadie lo abre. Este endpoint nunca completa la conexión por sí mismo; consulta el estado del enlace para saber cuándo termina. YouTube debe estar habilitado para el espacio de trabajo (403 en caso contrario).

post/api/v1/connections/connect-links
connections:write
Cuerpo de la solicitud
clientIdstringobligatorio
El cliente cuya cuenta se va a conectar.
platformstring (facebook | instagram | linkedin | x | pinterest | youtube)obligatorio
La red que se va a conectar: facebook, instagram, linkedin, x, pinterest o youtube.
reconnectConnectionIdstringopcional
Una conexión existente de este cliente que se reconecta en lugar de añadir una nueva. Solo Facebook y YouTube.
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.
urlstringopcional
El enlace que hay que enviar. Se abre en un navegador, no lleva credenciales y funciona una vez.
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.
post/api/v1/connections/connect-links
Su clave de API
Cuerpo de la solicitud*
{}

Guías que usan este recurso