v1Recursos/Connections
Connections
Gestione las cuentas conectadas de publishers y redes sociales de su agencia, sus cuentas publicitarias, las plantillas de configuración de promoción y las aplicaciones de negocio conectadas.
Devuelve las cuentas conectadas de publishers/redes sociales de su agencia (Google, Facebook, Instagram, LinkedIn, TikTok y otras), opcionalmente filtradas por cliente o plataforma.
Listar cuentas conectadas
get
connections:read/api/v1/connectionsParámetros de consulta
clientIdstringopcional
Restringe los resultados a un cliente. Cuando su clave está limitada a clientes específicos, los resultados siempre se prefiltran a esos clientes aunque se omita esto.
platformstringopcional
Restringe los resultados a una plataforma, p. ej. facebook, google.
credentialsValidbooleanopcional
Restringe a cuentas cuyas credenciales almacenadas son (true) o no son (false) válidas actualmente.
fetchStatusstringopcional
Restringe a cuentas con este estado de sincronización.
cursorstringopcional
Cursor de paginación tomado del nextCursor de una respuesta anterior.
limitintegeropcional
Máximo de cuentas a devolver, de 1 a 100. El valor predeterminado es 20.
Respuesta
dataobjectopcional
accountsarray of objectopcional
Las cuentas conectadas que coinciden.
idstringopcional
Identificador único de la cuenta conectada.
platformstringopcional
La plataforma a la que se conecta esta cuenta, p. ej. google, facebook, instagram.
displayNamestringopcional
Nombre visible de la cuenta conectada.
providerAccountIdstringopcional
El identificador propio de la plataforma para esta cuenta.
credentialsValidbooleanopcional
Si las credenciales almacenadas son válidas actualmente.
fetchStatusstringopcional
Estado de sincronización actual de esta cuenta, p. ej. idle, fetching.
fetchErrorstringopcional
El último mensaje de error de sincronización, o null.
errorTagstringopcional
Un código de error breve legible por máquina, o null.
gmbGroupIdsarray of stringopcional
IDs de grupo de Google Business Profile asociados a esta cuenta, si los hay.
expiresAtstringopcional
Cuándo expira el token de acceso de esta cuenta, como marca de tiempo ISO 8601, o null.
dataAccessExpiresAtstringopcional
Cuándo expira la ventana de acceso a datos de Meta para esta cuenta, como marca de tiempo ISO 8601, o null.
channelstringopcional
El canal a través del cual se hizo esta conexión.
clientIdstringopcional
ID del cliente al que pertenece esta cuenta, o null para una conexión de toda la agencia.
synupLocationIdstringopcional
Identificador de ubicación heredado. Obsoleto — prefiera clientLocationId.
clientLocationIdstringopcional
ID de la ubicación a la que está vinculada esta cuenta, o null. Prefiera este a synupLocationId.
fetchedListingsCountnumberopcional
Número de listados que ha sincronizado esta cuenta.
lastFetchedAtstringopcional
Cuándo completó esta cuenta su última sincronización, como marca de tiempo ISO 8601, o null.
connectionStatusstring (CONNECTED | MISSING | RENEW | DISCONNECTED | SUSPENDED | SUGGESTED_MATCH)opcional
Estado general de esta conexión: CONNECTED, MISSING, RENEW, DISCONNECTED, SUSPENDED o SUGGESTED_MATCH.
createdAtstringopcional
Cuándo se conectó esta cuenta, como marca de tiempo ISO 8601.
updatedAtstringopcional
Cuándo se actualizó por última vez esta cuenta, como marca de tiempo ISO 8601.
nextCursorstringopcional
Cursor de paginación para la siguiente página, o null cuando no hay más resultados.
totalCountnumberopcional
Número total de cuentas que coinciden con la solicitud.
Errores
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/connections
Su clave de API
clientId
platform
credentialsValid
fetchStatus
cursor
limit
{
"data": {
"accounts": [
{
"id": "conn_1",
"platform": "google",
"displayName": "Acme Dental — Google",
"providerAccountId": "112233445566",
"credentialsValid": true,
"fetchStatus": "ok",
"fetchError": null,
"errorTag": null,
"gmbGroupIds": [],
"expiresAt": null,
"dataAccessExpiresAt": "2026-05-01T00:00:00.000Z",
"channel": "local",
"clientId": "cli_123",
"synupLocationId": null,
"clientLocationId": "loc_456"
}
],
"nextCursor": null,
"totalCount": 1
}
}v1Recursos/Connections/getObtener un resumen de cuentas conectadas
Cuántas ubicaciones de este cliente (o de toda la agencia) tienen Google/Facebook conectado o no. Limite el alcance con tags.
Obtener un resumen de cuentas conectadas
get
connections:read/api/v1/connections/summaryParámetros de consulta
clientIdstringopcional
Limitar a las ubicaciones de un cliente.
tagsstringopcional
Nombres de tags de ubicación separados por comas — solo se cuentan las ubicaciones con al menos uno de estos.
Respuesta
dataobjectopcional
totalnumberopcional
Total de ubicaciones en el alcance.
googleobjectopcional
connectednumberopcional
Ubicaciones con este publisher conectado.
notConnectednumberopcional
Ubicaciones sin este publisher conectado.
facebookobjectopcional
connectednumberopcional
Ubicaciones con este publisher conectado.
notConnectednumberopcional
Ubicaciones sin este publisher conectado.
Errores
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/connections/summary
Su clave de API
clientId
tags
{
"data": {
"total": 5,
"google": {
"connected": 3,
"notConnected": 2
},
"facebook": {
"connected": 1,
"notConnected": 4
}
}
}v1Recursos/Connections/getObtener una URL de conexión de Google
Devuelve una URL de autorización de OAuth de Google para abrir en un navegador y conectar el Perfil de Negocio de Google de esta ubicación. Este endpoint no puede completar la conexión por sí mismo — la pantalla de consentimiento de Google requiere un humano interactivo.
Obtener una URL de conexión de Google
get
connections:write/api/v1/connections/google/connect-urlParámetros de consulta
locationIdstringobligatorio
La ubicación a conectar.
clientIdstringopcional
El cliente de la ubicación. Solo necesario para desambiguar cuando su clave está limitada a clientes específicos.
returnUrlstringopcional
Ruta interna de la app donde aterrizar después de que el humano complete la pantalla de consentimiento. Por defecto, "/".
Respuesta
dataobjectopcional
providerstring (google | facebook)opcional
Qué publisher conecta esta URL.
locationIdstringopcional
La ubicación a la que se emparejará esta conexión una vez aprobada.
urlstringopcional
La URL de autorización — ábrala en un navegador bajo el control del propietario de la cuenta.
notestringopcional
Explica que no hay retorno de llamada a su integración; consulte GET /api/v1/connections después.
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/connections/google/connect-url
Su clave de API
locationId *
clientId
returnUrl
{
"data": {
"provider": "google",
"locationId": "loc_456",
"url": "https://accounts.google.com/o/oauth2/v2/auth?client_id=...&redirect_uri=...&response_type=code&scope=...&state=...",
"note": "Open this URL in a browser under the account owner's control. There is no callback to your integration — once approved, poll GET /api/v1/connections to see the new connection."
}
}v1Recursos/Connections/getObtener una URL de conexión de Facebook
Devuelve una URL de autorización de OAuth de Facebook para abrir en un navegador y conectar la Página de Facebook de esta ubicación. Este endpoint no puede completar la conexión por sí mismo — la pantalla de consentimiento de Facebook requiere un humano interactivo.
Obtener una URL de conexión de Facebook
get
connections:write/api/v1/connections/facebook/connect-urlParámetros de consulta
locationIdstringobligatorio
La ubicación a conectar.
clientIdstringopcional
El cliente de la ubicación. Solo necesario para desambiguar cuando su clave está limitada a clientes específicos.
returnUrlstringopcional
Ruta interna de la app donde aterrizar después de que el humano complete la pantalla de consentimiento. Por defecto, "/".
Respuesta
dataobjectopcional
providerstring (google | facebook)opcional
Qué publisher conecta esta URL.
locationIdstringopcional
La ubicación a la que se emparejará esta conexión una vez aprobada.
urlstringopcional
La URL de autorización — ábrala en un navegador bajo el control del propietario de la cuenta.
notestringopcional
Explica que no hay retorno de llamada a su integración; consulte GET /api/v1/connections después.
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/connections/facebook/connect-url
Su clave de API
locationId *
clientId
returnUrl
{
"data": {
"provider": "facebook",
"locationId": "loc_456",
"url": "https://www.facebook.com/v19.0/dialog/oauth?client_id=...&redirect_uri=...&scope=...&state=...&response_type=code",
"note": "Open this URL in a browser under the account owner's control. There is no callback to your integration — once approved, poll GET /api/v1/connections to see the new connection."
}
}v1Recursos/Connections/getListar cuentas publicitarias
Devuelve las cuentas publicitarias de social pagado disponibles en una cuenta conectada (Facebook, Instagram, LinkedIn o TikTok).
Listar cuentas publicitarias
get
connections:read/api/v1/connections/ad-accountsParámetros de consulta
connectionIdstringobligatorio
La cuenta conectada a consultar. Obligatorio. Búsquelo con GET /api/v1/connections.
Respuesta
dataobjectopcional
adAccountsarray of objectopcional
Las cuentas publicitarias disponibles en esta cuenta conectada.
idstringopcional
Identificador único de la cuenta publicitaria.
connectionIdstringopcional
ID de la cuenta conectada a la que pertenece esta cuenta publicitaria.
platformAccountIdstringopcional
El identificador propio de la plataforma para esta cuenta publicitaria, p. ej. act_226123609900306 para Meta.
namestringopcional
Nombre visible de la cuenta publicitaria.
platformstringopcional
Plataforma a la que pertenece esta cuenta publicitaria: facebook, instagram, linkedin o tiktok.
statusstring (active | disabled | unsettled | pending_review)opcional
Estado informado por la plataforma: active, disabled, unsettled o pending_review.
isSelectedbooleanopcional
Si esta es la cuenta publicitaria actualmente seleccionada para promocionar en esta conexión.
currencystringopcional
Moneda en la que factura esta cuenta publicitaria, o null.
archivedbooleanopcional
Si esta cuenta publicitaria ha sido archivada.
createdAtstringopcional
Cuándo se sincronizó por primera vez esta cuenta publicitaria, como marca de tiempo ISO 8601.
updatedAtstringopcional
Cuándo se sincronizó por última vez esta cuenta publicitaria, como marca de tiempo ISO 8601.
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.
get/api/v1/connections/ad-accounts
Su clave de API
connectionId *
{
"data": {
"adAccounts": [
{
"id": "adacct_1",
"connectionId": "conn_1",
"platformAccountId": "act_549988676430053",
"name": "Acme Dental Ads",
"platform": "facebook",
"status": "active",
"isSelected": true,
"currency": "USD",
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
}
]
}
}v1Recursos/Connections/postSincronizar cuentas publicitarias
Fuerza una nueva sincronización inmediata de las cuentas publicitarias de una cuenta conectada desde la plataforma, en lugar de esperar la sincronización diaria en segundo plano. Devuelve la lista actualizada.
Sincronizar cuentas publicitarias
post
connections:write/api/v1/connections/ad-accounts/syncCuerpo de la solicitud
connectionIdstringobligatorio
La cuenta conectada a sincronizar. Obligatorio. Búsquelo con GET /api/v1/connections.
Respuesta
dataobjectopcional
adAccountsarray of objectopcional
Las cuentas publicitarias disponibles en esta cuenta conectada.
idstringopcional
Identificador único de la cuenta publicitaria.
connectionIdstringopcional
ID de la cuenta conectada a la que pertenece esta cuenta publicitaria.
platformAccountIdstringopcional
El identificador propio de la plataforma para esta cuenta publicitaria, p. ej. act_226123609900306 para Meta.
namestringopcional
Nombre visible de la cuenta publicitaria.
platformstringopcional
Plataforma a la que pertenece esta cuenta publicitaria: facebook, instagram, linkedin o tiktok.
statusstring (active | disabled | unsettled | pending_review)opcional
Estado informado por la plataforma: active, disabled, unsettled o pending_review.
isSelectedbooleanopcional
Si esta es la cuenta publicitaria actualmente seleccionada para promocionar en esta conexión.
currencystringopcional
Moneda en la que factura esta cuenta publicitaria, o null.
archivedbooleanopcional
Si esta cuenta publicitaria ha sido archivada.
createdAtstringopcional
Cuándo se sincronizó por primera vez esta cuenta publicitaria, como marca de tiempo ISO 8601.
updatedAtstringopcional
Cuándo se sincronizó por última vez esta cuenta publicitaria, como marca de tiempo ISO 8601.
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.
422A la solicitud le falta un parámetro obligatorio o es inválida de otra forma.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/connections/ad-accounts/sync
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"adAccounts": [
{
"id": "adacct_1",
"connectionId": "conn_1",
"platformAccountId": "act_549988676430053",
"name": "Acme Dental Ads",
"platform": "facebook",
"status": "active",
"isSelected": false,
"currency": "USD",
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-02-01T09:00:00.000Z"
}
]
}
}v1Recursos/Connections/postSeleccionar una cuenta publicitaria
Elige cuál de las cuentas publicitarias de una cuenta conectada se usa al promocionar publicaciones. Solo se puede seleccionar una cuenta publicitaria por cuenta conectada a la vez.
Seleccionar una cuenta publicitaria
post
connections:write/api/v1/connections/ad-accounts/selectCuerpo de la solicitud
connectionIdstringobligatorio
La cuenta conectada propietaria de la cuenta publicitaria. Obligatorio. Búsquelo con GET /api/v1/connections.
adAccountIdstringobligatorio
La cuenta publicitaria a seleccionar. Debe pertenecer a connectionId. Obligatorio.
Respuesta
dataobjectopcional
selectedbooleanopcional
Siempre true en caso de éxito.
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/ad-accounts/select
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"selected": true
}
}v1Recursos/Connections/postAsignar un listado a una ubicación
Empareja un listado ya obtenido de una cuenta ya conectada con una ubicación que aún no tiene conexión propia. No es una nueva autorización OAuth — caId debe ser ya una cuenta conectada; esto simplemente reutiliza ese inicio de sesión. Solo Google y Facebook.
Asignar un listado a una ubicación
post
connections:write/api/v1/connections/locations/assignCuerpo de la solicitud
platformstring (google | facebook)obligatorio
La plataforma: google o facebook. Obligatorio.
caIdstringobligatorio
La cuenta ya conectada a emparejar. Obligatorio.
locationIdstringobligatorio
La ubicación a la que asignar este listado. Obligatorio.
platformResourceNamestringobligatorio
El nombre/id de recurso del listado en la plataforma. Obligatorio.
platformPageNamestringobligatorio
El nombre visible del listado en la plataforma. Obligatorio.
Respuesta
dataobjectopcional
idstringopcional
Identificador único de la conexión resultante.
platformstring (google | facebook)opcional
La plataforma en la que se emparejó el listado.
synupLocationIdstringopcional
El id heredado de Synup de la ubicación, o null para una ubicación nativa.
clientLocationIdstringopcional
El id de la ubicación.
platformResourceNamestringopcional
El nombre/id de recurso del listado en la plataforma.
platformPageNamestringopcional
El nombre visible del listado en la plataforma.
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/locations/assign
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"id": "listing_1",
"platform": "google",
"synupLocationId": null,
"clientLocationId": "loc_456",
"platformResourceName": "accounts/123/locations/456",
"platformPageName": "Acme Dental — Downtown"
}
}v1Recursos/Connections/postConfirmar una coincidencia sugerida
Confirma una sugerencia de la puntuación NAP, creando una conexión a nivel de ubicación a partir de un listado obtenido ya emparejado con una ubicación de Synup. Falla si el listado no tiene una ubicación emparejada (400), ya está conectado (409), o la ubicación ya tiene una conexión en esa plataforma (409).
Confirmar una coincidencia sugerida
post
connections:write/api/v1/connections/locations/confirm-matchCuerpo de la solicitud
fetchedListingIdstringobligatorio
El listado obtenido a confirmar. Obligatorio.
Respuesta
dataobjectopcional
idstringopcional
Identificador único de la conexión resultante.
platformstring (google | facebook)opcional
La plataforma en la que se emparejó el listado.
synupLocationIdstringopcional
El id heredado de Synup de la ubicación, o null para una ubicación nativa.
clientLocationIdstringopcional
El id de la ubicación.
platformResourceNamestringopcional
El nombre/id de recurso del listado en la plataforma.
platformPageNamestringopcional
El nombre visible del listado en la plataforma.
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.
409La solicitud entra en conflicto con el estado actual del recurso — por ejemplo, cambiar el correo electrónico o el teléfono de un destinatario al que ya se le ha enviado un mensaje, o una invitación de equipo que ya fue aceptada (o que aún no ha sido aceptada).
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
post/api/v1/connections/locations/confirm-match
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"id": "listing_1",
"platform": "google",
"synupLocationId": null,
"clientLocationId": "loc_456",
"platformResourceName": "accounts/123/locations/456",
"platformPageName": "Acme Dental — Downtown"
}
}v1Recursos/Connections/postSolicitar nuevas sugerencias de coincidencia
Vuelve a ejecutar la puntuación NAP (nombre/dirección/teléfono) sobre los listados ya obtenidos de una cuenta conectada. No vuelve a extraer desde la plataforma — para eso use POST /api/v1/connections/fetch-listings. Limitado a una vez cada 24 horas por cuenta; una llamada dentro de esa ventana devuelve 429 con una marca de tiempo retryAt.
Solicitar nuevas sugerencias de coincidencia
post
connections:write/api/v1/connections/request-matchesCuerpo de la solicitud
connectionIdstringobligatorio
La cuenta conectada a puntuar de nuevo. Obligatorio. Búsquelo con GET /api/v1/connections.
Respuesta
dataobjectopcional
scorednumberopcional
Número de listados vueltos a puntuar.
messagestringopcional
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/request-matches
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"scored": 4,
"message": null
}
}v1Recursos/Connections/postForzar una nueva extracción de los listados de una cuenta
Fuerza una nueva extracción inmediata de los listados de una cuenta conectada directamente desde la plataforma — no solo una nueva puntuación de lo ya almacenado, que es POST /api/v1/connections/request-matches. Se ejecuta de forma síncrona; la respuesta confirma que la extracción ya se completó.
Forzar una nueva extracción de los listados de una cuenta
post
connections:write/api/v1/connections/fetch-listingsCuerpo de la solicitud
connectionIdstringobligatorio
La cuenta conectada a volver a extraer. Obligatorio. Búsquelo con GET /api/v1/connections.
Respuesta
dataobjectopcional
statusstringopcional
countnumberopcional
Número de listados extraídos.
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/fetch-listings
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"status": "completed",
"count": 4
}
}v1Recursos/Connections/getListar configuraciones de promoción
Devuelve las configuraciones de promoción guardadas (plantillas reutilizables de segmentación y presupuesto para promocionar una publicación) de una cuenta conectada.
Listar configuraciones de promoción
get
connections:read/api/v1/connections/boost-configsParámetros de consulta
connectionIdstringobligatorio
La cuenta conectada a consultar. Obligatorio. Búsquelo con GET /api/v1/connections.
Respuesta
dataobjectopcional
boostConfigsarray of objectopcional
Las configuraciones de promoción guardadas en esta cuenta conectada.
idstringopcional
Identificador único de la configuración de promoción.
connectionIdstringopcional
ID de la cuenta conectada a la que pertenece esta configuración de promoción.
adAccountIdstringopcional
ID de la cuenta publicitaria de la que gasta esta configuración de promoción.
namestringopcional
Nombre de esta plantilla.
platformstringopcional
Plataforma en la que se ejecuta esta configuración de promoción, coincidente con su cuenta conectada.
targetingobjectopcional
Configuración de segmentación de esta plantilla.
ageMinnumberopcional
Edad mínima de la audiencia.
ageMaxnumberopcional
Edad máxima de la audiencia.
gendersarray of numberopcional
Géneros de audiencia a segmentar: 1 para masculino, 2 para femenino.
geoLocationsobjectopcional
Segmentación geográfica: países, regiones, ciudades y/o códigos postales.
interestsarray of objectopcional
Categorías de interés a segmentar.
publisherPlatformsarray of stringopcional
Qué superficies de plataforma segmentar, p. ej. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)opcional
Restringe la audiencia a las personas a las que les gusta la página (fans) o también a sus amigos (fans_of_fans).
dailyBudgetnumberopcional
Presupuesto diario, en la unidad monetaria menor de la plataforma (p. ej. centavos).
durationDaysnumberopcional
Cuántos días se ejecuta la promoción una vez aplicada.
delayHoursnumberopcional
Horas a esperar después de publicar una publicación antes de promocionarla.
publisherPlatformsarray of stringopcional
En qué superficies de plataforma promociona esta plantilla.
archivedbooleanopcional
Si esta plantilla ha sido archivada.
createdAtstringopcional
Cuándo se creó esta plantilla, como marca de tiempo ISO 8601.
updatedAtstringopcional
Cuándo se actualizó por última vez esta plantilla, como marca de tiempo ISO 8601.
adAccountobjectopcional
Un resumen breve de la cuenta publicitaria de la que gasta esta plantilla, o null.
platformAccountIdstringopcional
El identificador propio de la plataforma para esa cuenta publicitaria.
namestringopcional
Nombre visible de esa cuenta publicitaria.
currencystringopcional
Moneda en la que factura esa cuenta publicitaria, o 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.
get/api/v1/connections/boost-configs
Su clave de API
connectionId *
{
"data": {
"boostConfigs": [
{
"id": "boost_1",
"connectionId": "conn_1",
"adAccountId": "adacct_1",
"name": "Local awareness — $10/day",
"platform": "facebook",
"targeting": {
"ageMin": 25,
"ageMax": 55,
"genders": [],
"geoLocations": {
"countries": [],
"regions": [],
"cities": [],
"zips": []
},
"interests": [],
"publisherPlatforms": [
"facebook"
]
},
"dailyBudget": 10,
"durationDays": 7,
"delayHours": 0,
"publisherPlatforms": [
"facebook"
],
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
}
]
}
}v1Recursos/Connections/postCrear una configuración de promoción
Guarda una nueva configuración de promoción reutilizable (segmentación, presupuesto diario y duración) en la cuenta publicitaria de una cuenta conectada. Esto solo almacena una plantilla para usarla más adelante — no promociona una publicación por sí sola, no envía nada a la plataforma publicitaria, ni gasta dinero. El dinero solo se gasta cuando esta configuración guardada se aplica más adelante para promocionar una publicación específica.
Crear una configuración de promoción
post
connections:write/api/v1/connections/boost-configsCuerpo de la solicitud
connectionIdstringobligatorio
La cuenta conectada a la que asociar esta configuración de promoción. Obligatorio. Búsquelo con GET /api/v1/connections.
adAccountIdstringobligatorio
La cuenta publicitaria de la que se gastará cuando se use esta configuración. Debe pertenecer a connectionId. Obligatorio.
namestringobligatorio
Un nombre para esta plantilla, que se muestra al elegirla más adelante. Obligatorio.
targetingobjectopcional
Todos los campos son opcionales. Un objeto vacío segmenta la audiencia predeterminada más amplia de la plataforma.
ageMinnumberopcional
Edad mínima de la audiencia.
ageMaxnumberopcional
Edad máxima de la audiencia.
gendersarray of numberopcional
Géneros de audiencia a segmentar: 1 para masculino, 2 para femenino.
geoLocationsobjectopcional
Segmentación geográfica: países, regiones, ciudades y/o códigos postales.
countriesarray of stringopcional
regionsarray of objectopcional
keystringopcional
namestringopcional
citiesarray of objectopcional
keystringopcional
namestringopcional
radiusnumberopcional
distanceUnitstringopcional
zipsarray of objectopcional
keystringopcional
namestringopcional
interestsarray of objectopcional
Categorías de interés a segmentar.
idstringopcional
namestringopcional
publisherPlatformsarray of stringopcional
Qué superficies de plataforma segmentar, p. ej. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)opcional
Restringe la audiencia a las personas a las que les gusta la página (fans) o también a sus amigos (fans_of_fans).
dailyBudgetnumberobligatorio
Presupuesto diario, en la unidad monetaria menor de la plataforma (p. ej. centavos). Debe ser positivo. Obligatorio.
durationDaysnumberobligatorio
Cuántos días debe ejecutarse la promoción una vez aplicada. Debe ser positivo. Obligatorio.
delayHoursnumberopcional
Horas a esperar después de publicar una publicación antes de promocionarla. El valor predeterminado es 0.
publisherPlatformsarray of stringopcional
En qué superficies de plataforma promocionar, p. ej. ["facebook", "instagram"].
Respuesta
dataobjectopcional
boostConfigobjectopcional
idstringopcional
Identificador único de la configuración de promoción.
connectionIdstringopcional
ID de la cuenta conectada a la que pertenece esta configuración de promoción.
adAccountIdstringopcional
ID de la cuenta publicitaria de la que gasta esta configuración de promoción.
namestringopcional
Nombre de esta plantilla.
platformstringopcional
Plataforma en la que se ejecuta esta configuración de promoción, coincidente con su cuenta conectada.
targetingobjectopcional
Configuración de segmentación de esta plantilla.
ageMinnumberopcional
Edad mínima de la audiencia.
ageMaxnumberopcional
Edad máxima de la audiencia.
gendersarray of numberopcional
Géneros de audiencia a segmentar: 1 para masculino, 2 para femenino.
geoLocationsobjectopcional
Segmentación geográfica: países, regiones, ciudades y/o códigos postales.
interestsarray of objectopcional
Categorías de interés a segmentar.
publisherPlatformsarray of stringopcional
Qué superficies de plataforma segmentar, p. ej. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)opcional
Restringe la audiencia a las personas a las que les gusta la página (fans) o también a sus amigos (fans_of_fans).
dailyBudgetnumberopcional
Presupuesto diario, en la unidad monetaria menor de la plataforma (p. ej. centavos).
durationDaysnumberopcional
Cuántos días se ejecuta la promoción una vez aplicada.
delayHoursnumberopcional
Horas a esperar después de publicar una publicación antes de promocionarla.
publisherPlatformsarray of stringopcional
En qué superficies de plataforma promociona esta plantilla.
archivedbooleanopcional
Si esta plantilla ha sido archivada.
createdAtstringopcional
Cuándo se creó esta plantilla, como marca de tiempo ISO 8601.
updatedAtstringopcional
Cuándo se actualizó por última vez esta plantilla, como marca de tiempo ISO 8601.
adAccountobjectopcional
Un resumen breve de la cuenta publicitaria de la que gasta esta plantilla, o null.
platformAccountIdstringopcional
El identificador propio de la plataforma para esa cuenta publicitaria.
namestringopcional
Nombre visible de esa cuenta publicitaria.
currencystringopcional
Moneda en la que factura esa cuenta publicitaria, o 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.
post/api/v1/connections/boost-configs
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"boostConfig": {
"id": "boost_1",
"connectionId": "conn_1",
"adAccountId": "adacct_1",
"name": "Local awareness — $10/day",
"platform": "facebook",
"targeting": {
"ageMin": 25,
"ageMax": 55,
"genders": [],
"publisherPlatforms": [
"facebook"
]
},
"dailyBudget": 10,
"durationDays": 7,
"delayHours": 0,
"publisherPlatforms": [
"facebook"
],
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-01-15T10:00:00.000Z"
}
}
}v1Recursos/Connections/postActualizar una configuración de promoción
Edita una configuración de promoción existente y no archivada. Solo se modifican los campos que usted indique.
Actualizar una configuración de promoción
post
connections:write/api/v1/connections/boost-configs/updateCuerpo de la solicitud
connectionIdstringobligatorio
La cuenta conectada propietaria de la configuración de promoción. Obligatorio. Búsquelo con GET /api/v1/connections.
configIdstringobligatorio
La configuración de promoción a actualizar. Debe pertenecer a connectionId y no estar archivada. Obligatorio.
adAccountIdstringopcional
Nueva cuenta publicitaria de la que gastar, si se cambia.
namestringopcional
Nuevo nombre para esta plantilla, si se cambia.
targetingobjectopcional
Todos los campos son opcionales. Un objeto vacío segmenta la audiencia predeterminada más amplia de la plataforma.
ageMinnumberopcional
Edad mínima de la audiencia.
ageMaxnumberopcional
Edad máxima de la audiencia.
gendersarray of numberopcional
Géneros de audiencia a segmentar: 1 para masculino, 2 para femenino.
geoLocationsobjectopcional
Segmentación geográfica: países, regiones, ciudades y/o códigos postales.
countriesarray of stringopcional
regionsarray of objectopcional
keystringopcional
namestringopcional
citiesarray of objectopcional
keystringopcional
namestringopcional
radiusnumberopcional
distanceUnitstringopcional
zipsarray of objectopcional
keystringopcional
namestringopcional
interestsarray of objectopcional
Categorías de interés a segmentar.
idstringopcional
namestringopcional
publisherPlatformsarray of stringopcional
Qué superficies de plataforma segmentar, p. ej. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)opcional
Restringe la audiencia a las personas a las que les gusta la página (fans) o también a sus amigos (fans_of_fans).
dailyBudgetnumberopcional
Nuevo presupuesto diario, en la unidad monetaria menor de la plataforma, si se cambia.
durationDaysnumberopcional
Nueva duración en días, si se cambia.
delayHoursnumberopcional
Nuevo retraso en horas antes de promocionar, si se cambia.
publisherPlatformsarray of stringopcional
Nueva lista de superficies de plataforma en las que promocionar, si se cambia.
Respuesta
dataobjectopcional
boostConfigobjectopcional
idstringopcional
Identificador único de la configuración de promoción.
connectionIdstringopcional
ID de la cuenta conectada a la que pertenece esta configuración de promoción.
adAccountIdstringopcional
ID de la cuenta publicitaria de la que gasta esta configuración de promoción.
namestringopcional
Nombre de esta plantilla.
platformstringopcional
Plataforma en la que se ejecuta esta configuración de promoción, coincidente con su cuenta conectada.
targetingobjectopcional
Configuración de segmentación de esta plantilla.
ageMinnumberopcional
Edad mínima de la audiencia.
ageMaxnumberopcional
Edad máxima de la audiencia.
gendersarray of numberopcional
Géneros de audiencia a segmentar: 1 para masculino, 2 para femenino.
geoLocationsobjectopcional
Segmentación geográfica: países, regiones, ciudades y/o códigos postales.
interestsarray of objectopcional
Categorías de interés a segmentar.
publisherPlatformsarray of stringopcional
Qué superficies de plataforma segmentar, p. ej. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)opcional
Restringe la audiencia a las personas a las que les gusta la página (fans) o también a sus amigos (fans_of_fans).
dailyBudgetnumberopcional
Presupuesto diario, en la unidad monetaria menor de la plataforma (p. ej. centavos).
durationDaysnumberopcional
Cuántos días se ejecuta la promoción una vez aplicada.
delayHoursnumberopcional
Horas a esperar después de publicar una publicación antes de promocionarla.
publisherPlatformsarray of stringopcional
En qué superficies de plataforma promociona esta plantilla.
archivedbooleanopcional
Si esta plantilla ha sido archivada.
createdAtstringopcional
Cuándo se creó esta plantilla, como marca de tiempo ISO 8601.
updatedAtstringopcional
Cuándo se actualizó por última vez esta plantilla, como marca de tiempo ISO 8601.
adAccountobjectopcional
Un resumen breve de la cuenta publicitaria de la que gasta esta plantilla, o null.
platformAccountIdstringopcional
El identificador propio de la plataforma para esa cuenta publicitaria.
namestringopcional
Nombre visible de esa cuenta publicitaria.
currencystringopcional
Moneda en la que factura esa cuenta publicitaria, o 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.
post/api/v1/connections/boost-configs/update
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"boostConfig": {
"id": "boost_1",
"connectionId": "conn_1",
"adAccountId": "adacct_1",
"name": "Local awareness — $15/day",
"platform": "facebook",
"targeting": {
"ageMin": 25,
"ageMax": 55,
"genders": [],
"publisherPlatforms": [
"facebook"
]
},
"dailyBudget": 15,
"durationDays": 7,
"delayHours": 0,
"publisherPlatforms": [
"facebook"
],
"archived": false,
"createdAt": "2026-01-15T10:00:00.000Z",
"updatedAt": "2026-02-01T09:00:00.000Z"
}
}
}v1Recursos/Connections/postArchivar una configuración de promoción
Archiva una configuración de promoción guardada para que deje de aparecer como plantilla reutilizable. No afecta a ninguna promoción ya en curso que se haya creado a partir de ella.
Archivar una configuración de promoción
post
connections:write/api/v1/connections/boost-configs/archiveCuerpo de la solicitud
connectionIdstringobligatorio
La cuenta conectada propietaria de la configuración de promoción. Obligatorio. Búsquelo con GET /api/v1/connections.
configIdstringobligatorio
La configuración de promoción a archivar. Debe pertenecer a connectionId. Obligatorio.
Respuesta
dataobjectopcional
archivedbooleanopcional
Siempre true en caso de éxito.
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/boost-configs/archive
Su clave de API
Cuerpo de la solicitud*
{
"data": {
"archived": true
}
}v1Recursos/Connections/getListar aplicaciones conectadas
Devuelve las aplicaciones de negocio (CRMs y otras herramientas de terceros) que su agencia ha conectado a través de Pipedream. Estas son de toda la agencia — una clave limitada a clientes específicos igual ve la lista completa, ya que no existe una propiedad por cliente de una conexión de aplicación.
Listar aplicaciones conectadas
get
connections:read/api/v1/connections/appsParámetros de consulta
appSlugstringopcional
Restringe los resultados a una aplicación, por su slug.
Respuesta
dataobjectopcional
connectionsarray of objectopcional
Las aplicaciones de negocio conectadas a través de Pipedream.
appstringopcional
El slug identificador de la aplicación.
appNamestringopcional
Nombre visible de la aplicación.
accountstringopcional
Etiqueta de la cuenta conectada dentro de esa aplicación, o null.
statusstringopcional
Estado de conexión actual.
errorstringopcional
El último error de conexión, o null.
connectedAtstringopcional
Cuándo se conectó esta aplicación, como marca de tiempo ISO 8601.
lastCheckedAtstringopcional
Cuándo se comprobó por última vez el estado de esta conexión, como marca de tiempo ISO 8601, o null.
countnumberopcional
Número total de aplicaciones conectadas que coinciden con la solicitud.
Errores
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.
429Demasiadas solicitudes. Reintente tras el número de segundos indicado en el encabezado Retry-After.
get/api/v1/connections/apps
Su clave de API
appSlug
{
"data": {
"connections": [],
"count": 0
}
}