Synupv1
Créer une clé
v1Ressources/Connexions

Connexions

Gérez les comptes publisher et sociaux connectés de votre agence, leurs comptes publicitaires, les préréglages de configuration de boost, et les applications professionnelles connectées.

Renvoie les comptes publisher/sociaux connectés de votre agence (Google, Facebook, Instagram, LinkedIn, TikTok et autres), éventuellement filtrés par client ou plateforme.

Lister les comptes connectés

get/api/v1/connections
connections:read
Paramètres de requête
clientIdstringfacultatif
Restreint les résultats à un client. Quand votre clé est limitée à des clients spécifiques, les résultats sont toujours pré-filtrés sur ces clients même si ceci est omis.
platformstringfacultatif
Restreint les résultats à une seule plateforme, par ex. facebook, google.
credentialsValidbooleanfacultatif
Restreint aux comptes dont les identifiants stockés sont (true) ou ne sont pas (false) actuellement valides.
fetchStatusstringfacultatif
Restreint aux comptes ayant ce statut de récupération.
cursorstringfacultatif
Curseur de pagination provenant du nextCursor d'une réponse précédente.
limitintegerfacultatif
Nombre maximal de comptes à renvoyer, de 1 à 100. Par défaut 20.
Réponse
dataobjectfacultatif
accountsarray of objectfacultatif
Les comptes connectés correspondants.
idstringfacultatif
Identifiant unique du compte connecté.
platformstringfacultatif
La plateforme à laquelle ce compte se connecte, par ex. google, facebook, instagram.
displayNamestringfacultatif
Nom d'affichage du compte connecté.
providerAccountIdstringfacultatif
L'identifiant propre à la plateforme pour ce compte.
credentialsValidbooleanfacultatif
Si les identifiants stockés sont actuellement valides.
fetchStatusstringfacultatif
Statut de récupération actuel pour ce compte, par ex. idle, fetching.
fetchErrorstringfacultatif
Le dernier message d'erreur de récupération, ou null.
errorTagstringfacultatif
Un code d'erreur court lisible par une machine, ou null.
gmbGroupIdsarray of stringfacultatif
Ids de groupe Google Business Profile associés à ce compte, le cas échéant.
expiresAtstringfacultatif
Date d'expiration du jeton d'accès de ce compte, au format horodatage ISO 8601, ou null.
dataAccessExpiresAtstringfacultatif
Date d'expiration de la fenêtre d'accès aux données de Meta pour ce compte, au format horodatage ISO 8601, ou null.
channelstringfacultatif
Le canal par lequel cette connexion a été établie.
clientIdstringfacultatif
ID du client auquel appartient ce compte, ou null pour une connexion valable pour toute l'agence.
synupLocationIdstringfacultatif
Identifiant d'établissement legacy. Déprécié — préférez clientLocationId.
clientLocationIdstringfacultatif
ID de l'établissement auquel ce compte est lié, ou null. Préférez ceci à synupLocationId.
fetchedListingsCountnumberfacultatif
Nombre de fiches récupérées par ce compte.
lastFetchedAtstringfacultatif
Date de dernière récupération complétée par ce compte, au format horodatage ISO 8601, ou null.
connectionStatusstring (CONNECTED | MISSING | RENEW | DISCONNECTED | SUSPENDED | SUGGESTED_MATCH)facultatif
État de santé global de cette connexion : CONNECTED, MISSING, RENEW, DISCONNECTED, SUSPENDED ou SUGGESTED_MATCH.
createdAtstringfacultatif
Date de connexion de ce compte, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de dernière mise à jour de ce compte, au format horodatage ISO 8601.
nextCursorstringfacultatif
Curseur de pagination pour la page suivante, ou null quand il n'y a plus de résultats.
totalCountnumberfacultatif
Nombre total de comptes correspondant à la requête.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections
Votre clé 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
  }
}
v1Ressources/Connexions/getObtenir un résumé des comptes connectés

Combien d'emplacements de ce client (ou de toute l'agence) ont Google/Facebook connecté ou non. Restreindre à un sous-ensemble avec tags.

Obtenir un résumé des comptes connectés

get/api/v1/connections/summary
connections:read
Paramètres de requête
clientIdstringfacultatif
Limiter aux emplacements d'un client.
tagsstringfacultatif
Noms de tags d'emplacement séparés par des virgules — seuls les emplacements portant au moins un de ces tags sont comptés.
Réponse
dataobjectfacultatif
totalnumberfacultatif
Total des emplacements dans le périmètre.
googleobjectfacultatif
connectednumberfacultatif
Emplacements avec ce publisher connecté.
notConnectednumberfacultatif
Emplacements sans ce publisher connecté.
facebookobjectfacultatif
connectednumberfacultatif
Emplacements avec ce publisher connecté.
notConnectednumberfacultatif
Emplacements sans ce publisher connecté.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections/summary
Votre clé API
clientId
tags
{
  "data": {
    "total": 5,
    "google": {
      "connected": 3,
      "notConnected": 2
    },
    "facebook": {
      "connected": 1,
      "notConnected": 4
    }
  }
}
v1Ressources/Connexions/getObtenir une URL de connexion Google

Renvoie une URL d'autorisation OAuth Google à ouvrir dans un navigateur pour connecter le Profil d'établissement Google de cet emplacement. Cet endpoint ne peut pas terminer la connexion lui-même — l'écran de consentement Google nécessite un humain interactif.

Obtenir une URL de connexion Google

get/api/v1/connections/google/connect-url
connections:write
Paramètres de requête
locationIdstringobligatoire
L'emplacement à connecter.
clientIdstringfacultatif
Le client de l'emplacement. Nécessaire uniquement pour lever une ambiguïté lorsque votre clé est limitée à des clients spécifiques.
returnUrlstringfacultatif
Chemin interne de l'application où atterrir après que l'humain a terminé l'écran de consentement. Par défaut, "/".
Réponse
dataobjectfacultatif
providerstring (google | facebook)facultatif
Quel publisher cette URL connecte.
locationIdstringfacultatif
L'emplacement auquel cette connexion sera associée une fois approuvée.
urlstringfacultatif
L'URL d'autorisation — à ouvrir dans un navigateur sous le contrôle du titulaire du compte.
notestringfacultatif
Explique qu'il n'y a pas de rappel vers votre intégration ; interroger GET /api/v1/connections ensuite.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections/google/connect-url
Votre clé 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."
  }
}
v1Ressources/Connexions/getObtenir une URL de connexion Facebook

Renvoie une URL d'autorisation OAuth Facebook à ouvrir dans un navigateur pour connecter la Page Facebook de cet emplacement. Cet endpoint ne peut pas terminer la connexion lui-même — l'écran de consentement Facebook nécessite un humain interactif.

Obtenir une URL de connexion Facebook

get/api/v1/connections/facebook/connect-url
connections:write
Paramètres de requête
locationIdstringobligatoire
L'emplacement à connecter.
clientIdstringfacultatif
Le client de l'emplacement. Nécessaire uniquement pour lever une ambiguïté lorsque votre clé est limitée à des clients spécifiques.
returnUrlstringfacultatif
Chemin interne de l'application où atterrir après que l'humain a terminé l'écran de consentement. Par défaut, "/".
Réponse
dataobjectfacultatif
providerstring (google | facebook)facultatif
Quel publisher cette URL connecte.
locationIdstringfacultatif
L'emplacement auquel cette connexion sera associée une fois approuvée.
urlstringfacultatif
L'URL d'autorisation — à ouvrir dans un navigateur sous le contrôle du titulaire du compte.
notestringfacultatif
Explique qu'il n'y a pas de rappel vers votre intégration ; interroger GET /api/v1/connections ensuite.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections/facebook/connect-url
Votre clé 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."
  }
}
v1Ressources/Connexions/getLister les comptes publicitaires

Renvoie les comptes publicitaires payants disponibles sur un compte connecté (Facebook, Instagram, LinkedIn ou TikTok).

Lister les comptes publicitaires

get/api/v1/connections/ad-accounts
connections:read
Paramètres de requête
connectionIdstringobligatoire
Le compte connecté à consulter. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
Réponse
dataobjectfacultatif
adAccountsarray of objectfacultatif
Les comptes publicitaires disponibles sur ce compte connecté.
idstringfacultatif
Identifiant unique du compte publicitaire.
connectionIdstringfacultatif
ID du compte connecté auquel appartient ce compte publicitaire.
platformAccountIdstringfacultatif
L'identifiant propre à la plateforme pour ce compte publicitaire, par ex. act_226123609900306 pour Meta.
namestringfacultatif
Nom d'affichage du compte publicitaire.
platformstringfacultatif
Plateforme à laquelle appartient ce compte publicitaire : facebook, instagram, linkedin ou tiktok.
statusstring (active | disabled | unsettled | pending_review)facultatif
Statut signalé par la plateforme : active, disabled, unsettled ou pending_review.
isSelectedbooleanfacultatif
Si c'est le compte publicitaire actuellement sélectionné pour le boost sur cette connexion.
currencystringfacultatif
Devise de facturation de ce compte publicitaire, ou null.
archivedbooleanfacultatif
Si ce compte publicitaire a été archivé.
createdAtstringfacultatif
Date de première synchronisation de ce compte publicitaire, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de dernière synchronisation de ce compte publicitaire, au format horodatage ISO 8601.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections/ad-accounts
Votre clé 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"
      }
    ]
  }
}
v1Ressources/Connexions/postSynchroniser les comptes publicitaires

Force une nouvelle récupération immédiate des comptes publicitaires d'un compte connecté depuis la plateforme, au lieu d'attendre la synchronisation quotidienne en arrière-plan. Renvoie la liste actualisée.

Synchroniser les comptes publicitaires

post/api/v1/connections/ad-accounts/sync
connections:write
Corps de la requête
connectionIdstringobligatoire
Le compte connecté à synchroniser. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
Réponse
dataobjectfacultatif
adAccountsarray of objectfacultatif
Les comptes publicitaires disponibles sur ce compte connecté.
idstringfacultatif
Identifiant unique du compte publicitaire.
connectionIdstringfacultatif
ID du compte connecté auquel appartient ce compte publicitaire.
platformAccountIdstringfacultatif
L'identifiant propre à la plateforme pour ce compte publicitaire, par ex. act_226123609900306 pour Meta.
namestringfacultatif
Nom d'affichage du compte publicitaire.
platformstringfacultatif
Plateforme à laquelle appartient ce compte publicitaire : facebook, instagram, linkedin ou tiktok.
statusstring (active | disabled | unsettled | pending_review)facultatif
Statut signalé par la plateforme : active, disabled, unsettled ou pending_review.
isSelectedbooleanfacultatif
Si c'est le compte publicitaire actuellement sélectionné pour le boost sur cette connexion.
currencystringfacultatif
Devise de facturation de ce compte publicitaire, ou null.
archivedbooleanfacultatif
Si ce compte publicitaire a été archivé.
createdAtstringfacultatif
Date de première synchronisation de ce compte publicitaire, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de dernière synchronisation de ce compte publicitaire, au format horodatage ISO 8601.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
422Il manque un paramètre requis à la requête, ou elle est invalide.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/ad-accounts/sync
Votre clé API
Corps de la requête*
{
  "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"
      }
    ]
  }
}
v1Ressources/Connexions/postSélectionner un compte publicitaire

Choisit lequel des comptes publicitaires d'un compte connecté est utilisé lors du boost de posts. Un seul compte publicitaire peut être sélectionné par compte connecté à la fois.

Sélectionner un compte publicitaire

post/api/v1/connections/ad-accounts/select
connections:write
Corps de la requête
connectionIdstringobligatoire
Le compte connecté propriétaire du compte publicitaire. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
adAccountIdstringobligatoire
Le compte publicitaire à sélectionner. Doit appartenir à connectionId. Obligatoire.
Réponse
dataobjectfacultatif
selectedbooleanfacultatif
Toujours true en cas de succès.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/ad-accounts/select
Votre clé API
Corps de la requête*
{
  "data": {
    "selected": true
  }
}
v1Ressources/Connexions/postAttribuer une fiche à un emplacement

Associe une fiche déjà récupérée d'un compte déjà connecté à un emplacement qui n'a pas encore de connexion propre. Ce n'est pas une nouvelle autorisation OAuth — caId doit déjà être un compte connecté ; cela réutilise simplement cette connexion. Google et Facebook uniquement.

Attribuer une fiche à un emplacement

post/api/v1/connections/locations/assign
connections:write
Corps de la requête
platformstring (google | facebook)obligatoire
La plateforme : google ou facebook. Obligatoire.
caIdstringobligatoire
Le compte déjà connecté à associer. Obligatoire.
locationIdstringobligatoire
L'emplacement auquel attribuer cette fiche. Obligatoire.
platformResourceNamestringobligatoire
Le nom/id de ressource de la fiche sur la plateforme. Obligatoire.
platformPageNamestringobligatoire
Le nom d'affichage de la fiche sur la plateforme. Obligatoire.
Réponse
dataobjectfacultatif
idstringfacultatif
Identifiant unique de la connexion résultante.
platformstring (google | facebook)facultatif
La plateforme sur laquelle la fiche a été associée.
synupLocationIdstringfacultatif
L'id Synup existant de l'emplacement, ou null pour un emplacement natif.
clientLocationIdstringfacultatif
L'id de l'emplacement.
platformResourceNamestringfacultatif
Le nom/id de ressource de la fiche sur la plateforme.
platformPageNamestringfacultatif
Le nom d'affichage de la fiche sur la plateforme.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/locations/assign
Votre clé API
Corps de la requête*
{
  "data": {
    "id": "listing_1",
    "platform": "google",
    "synupLocationId": null,
    "clientLocationId": "loc_456",
    "platformResourceName": "accounts/123/locations/456",
    "platformPageName": "Acme Dental — Downtown"
  }
}
v1Ressources/Connexions/postConfirmer une correspondance suggérée

Confirme une suggestion du score NAP, créant une connexion au niveau de l'emplacement à partir d'une fiche récupérée déjà associée à un emplacement Synup. Échoue si la fiche n'a pas d'emplacement associé (400), est déjà connectée (409), ou si l'emplacement a déjà une connexion sur cette plateforme (409).

Confirmer une correspondance suggérée

post/api/v1/connections/locations/confirm-match
connections:write
Corps de la requête
fetchedListingIdstringobligatoire
La fiche récupérée à confirmer. Obligatoire.
Réponse
dataobjectfacultatif
idstringfacultatif
Identifiant unique de la connexion résultante.
platformstring (google | facebook)facultatif
La plateforme sur laquelle la fiche a été associée.
synupLocationIdstringfacultatif
L'id Synup existant de l'emplacement, ou null pour un emplacement natif.
clientLocationIdstringfacultatif
L'id de l'emplacement.
platformResourceNamestringfacultatif
Le nom/id de ressource de la fiche sur la plateforme.
platformPageNamestringfacultatif
Le nom d'affichage de la fiche sur la plateforme.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
409La requête entre en conflit avec l'état actuel de la ressource — par exemple, modifier l'e-mail ou le téléphone d'un destinataire à qui un message a déjà été envoyé, ou une invitation d'équipe déjà acceptée (ou pas encore acceptée).
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/locations/confirm-match
Votre clé API
Corps de la requête*
{
  "data": {
    "id": "listing_1",
    "platform": "google",
    "synupLocationId": null,
    "clientLocationId": "loc_456",
    "platformResourceName": "accounts/123/locations/456",
    "platformPageName": "Acme Dental — Downtown"
  }
}
v1Ressources/Connexions/postDemander de nouvelles suggestions de correspondance

Relance le score NAP (nom/adresse/téléphone) sur les fiches déjà récupérées d'un compte connecté. Ne récupère pas à nouveau depuis la plateforme — utilisez POST /api/v1/connections/fetch-listings pour cela. Limité à une fois toutes les 24 heures par compte ; un appel dans cette fenêtre renvoie 429 avec un horodatage retryAt.

Demander de nouvelles suggestions de correspondance

post/api/v1/connections/request-matches
connections:write
Corps de la requête
connectionIdstringobligatoire
Le compte connecté à noter à nouveau. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
Réponse
dataobjectfacultatif
scorednumberfacultatif
Nombre de fiches renotées.
messagestringfacultatif
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/request-matches
Votre clé API
Corps de la requête*
{
  "data": {
    "scored": 4,
    "message": null
  }
}
v1Ressources/Connexions/postForcer la récupération des fiches d'un compte

Force une récupération immédiate des fiches d'un compte connecté directement depuis la plateforme — pas seulement une nouvelle notation de ce qui est déjà stocké, ce qui est POST /api/v1/connections/request-matches. S'exécute de manière synchrone ; la réponse confirme que la récupération est déjà terminée.

Forcer la récupération des fiches d'un compte

post/api/v1/connections/fetch-listings
connections:write
Corps de la requête
connectionIdstringobligatoire
Le compte connecté à récupérer à nouveau. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
Réponse
dataobjectfacultatif
statusstringfacultatif
countnumberfacultatif
Nombre de fiches récupérées.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/fetch-listings
Votre clé API
Corps de la requête*
{
  "data": {
    "status": "completed",
    "count": 4
  }
}
v1Ressources/Connexions/getLister les configurations de boost

Renvoie les configurations de boost enregistrées (préréglages réutilisables de ciblage et de budget pour booster un post) sur un compte connecté.

Lister les configurations de boost

get/api/v1/connections/boost-configs
connections:read
Paramètres de requête
connectionIdstringobligatoire
Le compte connecté à consulter. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
Réponse
dataobjectfacultatif
boostConfigsarray of objectfacultatif
Les configurations de boost enregistrées sur ce compte connecté.
idstringfacultatif
Identifiant unique de la configuration de boost.
connectionIdstringfacultatif
ID du compte connecté auquel appartient cette configuration de boost.
adAccountIdstringfacultatif
ID du compte publicitaire duquel cette configuration de boost dépense.
namestringfacultatif
Nom de ce préréglage.
platformstringfacultatif
Plateforme sur laquelle tourne cette configuration de boost, correspondant à son compte connecté.
targetingobjectfacultatif
Réglages de ciblage pour ce préréglage.
ageMinnumberfacultatif
Âge minimal de l'audience.
ageMaxnumberfacultatif
Âge maximal de l'audience.
gendersarray of numberfacultatif
Genres d'audience à cibler : 1 pour homme, 2 pour femme.
geoLocationsobjectfacultatif
Ciblage géographique : pays, régions, villes et/ou codes postaux.
interestsarray of objectfacultatif
Catégories d'intérêt à cibler.
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme cibler, par ex. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)facultatif
Restreint l'audience aux personnes qui aiment la page (fans) ou aussi à leurs amis (fans_of_fans).
dailyBudgetnumberfacultatif
Budget quotidien, dans l'unité monétaire mineure de la plateforme (par ex. les centimes).
durationDaysnumberfacultatif
Nombre de jours pendant lesquels le boost tourne une fois appliqué.
delayHoursnumberfacultatif
Heures à attendre après la publication d'un post avant de le booster.
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme ce préréglage booste.
archivedbooleanfacultatif
Si ce préréglage a été archivé.
createdAtstringfacultatif
Date de création de ce préréglage, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de dernière mise à jour de ce préréglage, au format horodatage ISO 8601.
adAccountobjectfacultatif
Un court résumé du compte publicitaire duquel ce préréglage dépense, ou null.
platformAccountIdstringfacultatif
L'identifiant propre à la plateforme pour ce compte publicitaire.
namestringfacultatif
Nom d'affichage de ce compte publicitaire.
currencystringfacultatif
Devise de facturation de ce compte publicitaire, ou null.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections/boost-configs
Votre clé 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"
      }
    ]
  }
}
v1Ressources/Connexions/postCréer une configuration de boost

Enregistre une nouvelle configuration de boost réutilisable (ciblage, budget quotidien et durée) sur le compte publicitaire d'un compte connecté. Ceci ne fait que stocker un préréglage pour un usage ultérieur — cela ne booste pas un post en soi, ne soumet rien à la plateforme publicitaire, et ne dépense aucun argent. L'argent n'est dépensé que lorsque cette configuration enregistrée est ensuite appliquée pour booster un post spécifique.

Créer une configuration de boost

post/api/v1/connections/boost-configs
connections:write
Corps de la requête
connectionIdstringobligatoire
Le compte connecté auquel attacher cette configuration de boost. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
adAccountIdstringobligatoire
Le compte publicitaire duquel dépenser quand cette configuration est utilisée. Doit appartenir à connectionId. Obligatoire.
namestringobligatoire
Un nom pour ce préréglage, affiché lors de sa sélection ultérieure. Obligatoire.
targetingobjectfacultatif
Tous les champs sont facultatifs. Un objet vide cible l'audience par défaut la plus large de la plateforme.
ageMinnumberfacultatif
Âge minimal de l'audience.
ageMaxnumberfacultatif
Âge maximal de l'audience.
gendersarray of numberfacultatif
Genres d'audience à cibler : 1 pour homme, 2 pour femme.
geoLocationsobjectfacultatif
Ciblage géographique : pays, régions, villes et/ou codes postaux.
countriesarray of stringfacultatif
regionsarray of objectfacultatif
keystringfacultatif
namestringfacultatif
citiesarray of objectfacultatif
keystringfacultatif
namestringfacultatif
radiusnumberfacultatif
distanceUnitstringfacultatif
zipsarray of objectfacultatif
keystringfacultatif
namestringfacultatif
interestsarray of objectfacultatif
Catégories d'intérêt à cibler.
idstringfacultatif
namestringfacultatif
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme cibler, par ex. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)facultatif
Restreint l'audience aux personnes qui aiment la page (fans) ou aussi à leurs amis (fans_of_fans).
dailyBudgetnumberobligatoire
Budget quotidien, dans l'unité monétaire mineure de la plateforme (par ex. les centimes). Doit être positif. Obligatoire.
durationDaysnumberobligatoire
Nombre de jours pendant lesquels le boost doit tourner une fois appliqué. Doit être positif. Obligatoire.
delayHoursnumberfacultatif
Heures à attendre après la publication d'un post avant de le booster. Par défaut 0.
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme booster, par ex. ["facebook", "instagram"].
Réponse
dataobjectfacultatif
boostConfigobjectfacultatif
idstringfacultatif
Identifiant unique de la configuration de boost.
connectionIdstringfacultatif
ID du compte connecté auquel appartient cette configuration de boost.
adAccountIdstringfacultatif
ID du compte publicitaire duquel cette configuration de boost dépense.
namestringfacultatif
Nom de ce préréglage.
platformstringfacultatif
Plateforme sur laquelle tourne cette configuration de boost, correspondant à son compte connecté.
targetingobjectfacultatif
Réglages de ciblage pour ce préréglage.
ageMinnumberfacultatif
Âge minimal de l'audience.
ageMaxnumberfacultatif
Âge maximal de l'audience.
gendersarray of numberfacultatif
Genres d'audience à cibler : 1 pour homme, 2 pour femme.
geoLocationsobjectfacultatif
Ciblage géographique : pays, régions, villes et/ou codes postaux.
interestsarray of objectfacultatif
Catégories d'intérêt à cibler.
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme cibler, par ex. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)facultatif
Restreint l'audience aux personnes qui aiment la page (fans) ou aussi à leurs amis (fans_of_fans).
dailyBudgetnumberfacultatif
Budget quotidien, dans l'unité monétaire mineure de la plateforme (par ex. les centimes).
durationDaysnumberfacultatif
Nombre de jours pendant lesquels le boost tourne une fois appliqué.
delayHoursnumberfacultatif
Heures à attendre après la publication d'un post avant de le booster.
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme ce préréglage booste.
archivedbooleanfacultatif
Si ce préréglage a été archivé.
createdAtstringfacultatif
Date de création de ce préréglage, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de dernière mise à jour de ce préréglage, au format horodatage ISO 8601.
adAccountobjectfacultatif
Un court résumé du compte publicitaire duquel ce préréglage dépense, ou null.
platformAccountIdstringfacultatif
L'identifiant propre à la plateforme pour ce compte publicitaire.
namestringfacultatif
Nom d'affichage de ce compte publicitaire.
currencystringfacultatif
Devise de facturation de ce compte publicitaire, ou null.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/boost-configs
Votre clé API
Corps de la requête*
{
  "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"
    }
  }
}
v1Ressources/Connexions/postMettre à jour une configuration de boost

Modifie une configuration de boost existante et non archivée. Seuls les champs fournis sont modifiés.

Mettre à jour une configuration de boost

post/api/v1/connections/boost-configs/update
connections:write
Corps de la requête
connectionIdstringobligatoire
Le compte connecté propriétaire de la configuration de boost. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
configIdstringobligatoire
La configuration de boost à mettre à jour. Doit appartenir à connectionId et ne pas être archivée. Obligatoire.
adAccountIdstringfacultatif
Nouveau compte publicitaire duquel dépenser, si vous le modifiez.
namestringfacultatif
Nouveau nom pour ce préréglage, si vous le modifiez.
targetingobjectfacultatif
Tous les champs sont facultatifs. Un objet vide cible l'audience par défaut la plus large de la plateforme.
ageMinnumberfacultatif
Âge minimal de l'audience.
ageMaxnumberfacultatif
Âge maximal de l'audience.
gendersarray of numberfacultatif
Genres d'audience à cibler : 1 pour homme, 2 pour femme.
geoLocationsobjectfacultatif
Ciblage géographique : pays, régions, villes et/ou codes postaux.
countriesarray of stringfacultatif
regionsarray of objectfacultatif
keystringfacultatif
namestringfacultatif
citiesarray of objectfacultatif
keystringfacultatif
namestringfacultatif
radiusnumberfacultatif
distanceUnitstringfacultatif
zipsarray of objectfacultatif
keystringfacultatif
namestringfacultatif
interestsarray of objectfacultatif
Catégories d'intérêt à cibler.
idstringfacultatif
namestringfacultatif
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme cibler, par ex. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)facultatif
Restreint l'audience aux personnes qui aiment la page (fans) ou aussi à leurs amis (fans_of_fans).
dailyBudgetnumberfacultatif
Nouveau budget quotidien, dans l'unité monétaire mineure de la plateforme, si vous le modifiez.
durationDaysnumberfacultatif
Nouvelle durée en jours, si vous la modifiez.
delayHoursnumberfacultatif
Nouveau délai en heures avant de booster, si vous le modifiez.
publisherPlatformsarray of stringfacultatif
Nouvelle liste de surfaces de plateforme sur lesquelles booster, si vous la modifiez.
Réponse
dataobjectfacultatif
boostConfigobjectfacultatif
idstringfacultatif
Identifiant unique de la configuration de boost.
connectionIdstringfacultatif
ID du compte connecté auquel appartient cette configuration de boost.
adAccountIdstringfacultatif
ID du compte publicitaire duquel cette configuration de boost dépense.
namestringfacultatif
Nom de ce préréglage.
platformstringfacultatif
Plateforme sur laquelle tourne cette configuration de boost, correspondant à son compte connecté.
targetingobjectfacultatif
Réglages de ciblage pour ce préréglage.
ageMinnumberfacultatif
Âge minimal de l'audience.
ageMaxnumberfacultatif
Âge maximal de l'audience.
gendersarray of numberfacultatif
Genres d'audience à cibler : 1 pour homme, 2 pour femme.
geoLocationsobjectfacultatif
Ciblage géographique : pays, régions, villes et/ou codes postaux.
interestsarray of objectfacultatif
Catégories d'intérêt à cibler.
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme cibler, par ex. ["facebook", "instagram"].
pageFansstring (fans | fans_of_fans)facultatif
Restreint l'audience aux personnes qui aiment la page (fans) ou aussi à leurs amis (fans_of_fans).
dailyBudgetnumberfacultatif
Budget quotidien, dans l'unité monétaire mineure de la plateforme (par ex. les centimes).
durationDaysnumberfacultatif
Nombre de jours pendant lesquels le boost tourne une fois appliqué.
delayHoursnumberfacultatif
Heures à attendre après la publication d'un post avant de le booster.
publisherPlatformsarray of stringfacultatif
Sur quelles surfaces de plateforme ce préréglage booste.
archivedbooleanfacultatif
Si ce préréglage a été archivé.
createdAtstringfacultatif
Date de création de ce préréglage, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de dernière mise à jour de ce préréglage, au format horodatage ISO 8601.
adAccountobjectfacultatif
Un court résumé du compte publicitaire duquel ce préréglage dépense, ou null.
platformAccountIdstringfacultatif
L'identifiant propre à la plateforme pour ce compte publicitaire.
namestringfacultatif
Nom d'affichage de ce compte publicitaire.
currencystringfacultatif
Devise de facturation de ce compte publicitaire, ou null.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/boost-configs/update
Votre clé API
Corps de la requête*
{
  "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"
    }
  }
}
v1Ressources/Connexions/postArchiver une configuration de boost

Archive une configuration de boost enregistrée afin qu'elle n'apparaisse plus comme préréglage réutilisable. N'affecte aucun boost déjà en cours créé à partir d'elle.

Archiver une configuration de boost

post/api/v1/connections/boost-configs/archive
connections:write
Corps de la requête
connectionIdstringobligatoire
Le compte connecté propriétaire de la configuration de boost. Obligatoire. Retrouvez-le avec GET /api/v1/connections.
configIdstringobligatoire
La configuration de boost à archiver. Doit appartenir à connectionId. Obligatoire.
Réponse
dataobjectfacultatif
archivedbooleanfacultatif
Toujours true en cas de succès.
Erreurs
400Il manque un paramètre requis à la requête, ou elle est invalide.
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
404La ressource est introuvable, ou n'appartient pas à votre agence.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
post/api/v1/connections/boost-configs/archive
Votre clé API
Corps de la requête*
{
  "data": {
    "archived": true
  }
}
v1Ressources/Connexions/getLister les applications connectées

Renvoie les applications professionnelles (CRM et autres outils tiers) que votre agence a connectées via Pipedream. Elles sont valables pour toute l'agence — une clé limitée à des clients spécifiques voit malgré tout la liste complète, puisqu'il n'existe pas de propriété par client d'une connexion d'application.

Lister les applications connectées

get/api/v1/connections/apps
connections:read
Paramètres de requête
appSlugstringfacultatif
Restreint les résultats à une seule application, par son slug.
Réponse
dataobjectfacultatif
connectionsarray of objectfacultatif
Les applications professionnelles connectées via Pipedream.
appstringfacultatif
Le slug identifiant de l'application.
appNamestringfacultatif
Nom d'affichage de l'application.
accountstringfacultatif
Étiquette du compte connecté au sein de cette application, ou null.
statusstringfacultatif
Statut de connexion actuel.
errorstringfacultatif
La dernière erreur de connexion, ou null.
connectedAtstringfacultatif
Date de connexion de cette application, au format horodatage ISO 8601.
lastCheckedAtstringfacultatif
Date de dernière vérification de santé de cette connexion, au format horodatage ISO 8601, ou null.
countnumberfacultatif
Nombre total d'applications connectées correspondant à la requête.
Erreurs
401Clé API manquante, invalide, expirée ou révoquée.
403La clé n'a pas la permission requise, ou n'est pas autorisée pour ce client/établissement.
429Trop de requêtes. Réessayez après le nombre de secondes indiqué dans l'en-tête Retry-After.
get/api/v1/connections/apps
Votre clé API
appSlug
{
  "data": {
    "connections": [],
    "count": 0
  }
}