Synupv1
Créer une clé
v1Ressources/Clients/postCréer un client

Créer un client

Crée un nouveau client dans votre agence, ainsi qu'un premier établissement lorsque les coordonnées correspondent à un lieu réel.

post/api/v1/clients
clients:write
Corps de la requête
businessNamestringobligatoire
Le nom commercial du nouveau client.
primaryContactEmailstringobligatoire
Adresse e-mail du contact principal du client.
primaryRepresentativeIdstringobligatoire
ID du membre de l'équipe responsable de ce client — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.
websitestringfacultatif
L'URL du site web du client.
industrystringfacultatif
Le secteur d'activité du client.
goalstring (improve_rankings | get_reviews | fix_listings)facultatif
L'objectif principal du client : improve_rankings, get_reviews ou fix_listings.
gbpLinkstringfacultatif
L'URL du profil d'établissement Google du client.
placeIdstringfacultatif
L'identifiant de lieu Google du client, provenant de l'API Places de Google — Synup ne propose pas de recherche de lieux propre. Crée également le premier établissement du client — n'effectuez pas ensuite une création d'établissement distincte pour la même entreprise.
latitudenumberfacultatif
La latitude de l'établissement du client. Requise avec placeId et longitude pour suivre aussi un mot-clé.
longitudenumberfacultatif
La longitude de l'établissement du client.
googleRatingnumberfacultatif
La note Google actuelle du client, si connue.
googleReviewCountnumberfacultatif
Le nombre actuel d'avis Google du client, si connu.
trackingKeywordstringfacultatif
Un mot-clé pour suivre le classement local du client. Nécessite que placeId, latitude et longitude soient également définis.
clientPlanIdstringfacultatif
Quel plan de portail client assigner. Par défaut, le plan par défaut de votre agence. Il n'existe aucun endpoint listant les plans — récupérez un identifiant valide depuis le clientPlan.id d'un client existant, ou depuis les paramètres de plan de votre agence dans Synup.
notesstringfacultatif
Une note interne sur le client — visible uniquement par votre équipe, jamais par le client.
Réponse
dataobjectfacultatif
clientobjectfacultatif
Des champs internes supplémentaires peuvent être présents mais ne font pas partie du contrat stable — ne vous fiez qu'aux champs documentés ici.
idstringfacultatif
Identifiant unique du client.
businessNamestringfacultatif
Le nom commercial du client.
websitestringfacultatif
L'URL du site web du client.
industrystringfacultatif
Le secteur d'activité du client.
primaryContactEmailstringfacultatif
Adresse e-mail du contact principal du client.
primaryRepresentativeIdstringfacultatif
ID du membre de l'équipe responsable de ce client — voir GET /api/v1/team/members pour les identifiants de membres de votre agence.
visibilitystring (public | private)facultatif
Si le client est public ou private au sein de votre agence.
goalstring (improve_rankings | get_reviews | fix_listings)facultatif
L'objectif principal du client, ou null.
notesstringfacultatif
Une note interne sur le client — visible uniquement par votre équipe, jamais par le client.
gbpLinkstringfacultatif
L'URL du profil d'établissement Google du client, ou null.
trackingKeywordstringfacultatif
Un mot-clé suivi pour le classement local de ce client, ou null.
healthScorenumberfacultatif
Un score de 0 à 100 résumant la santé du compte du client, ou null si non encore calculé.
planNamestringfacultatif
Nom du plan de ce client, le cas échéant.
archivedbooleanfacultatif
Si le client est archivé.
archivedAtstringfacultatif
Date d'archivage du client, au format horodatage ISO 8601, ou null.
scheduledArchiveAtstringfacultatif
Date à laquelle l'archivage a été demandé (aussi le jeton de cohorte pour l'annuler), au format horodatage ISO 8601, ou null si aucun n'est en attente.
createdAtstringfacultatif
Date de création du client, au format horodatage ISO 8601.
updatedAtstringfacultatif
Date de la dernière mise à jour du client, au format horodatage ISO 8601.
locationIdstringfacultatif
ID du premier établissement créé avec ce client, ou null si aucun n'a encore pu être créé.
locationSkippedstring (place_not_found | missing_country | location_limit | missing_category | failed)facultatif
Pourquoi aucun premier établissement n'a été créé, lorsqu'un placeId a été fourni mais qu'aucun établissement n'en a résulté — par exemple, location_limit signifie que l'agence a atteint la limite d'établissements de son plan. Null si non applicable.
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.
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/clients
Votre clé API
Corps de la requête*
{
  "data": {
    "client": {
      "id": "cli_123",
      "businessName": "Acme Dental",
      "website": null,
      "industry": null,
      "primaryContactEmail": "owner@acmedental.com",
      "primaryRepresentativeId": "usr_123",
      "visibility": "public",
      "goal": null,
      "notes": null,
      "gbpLink": null,
      "trackingKeyword": null,
      "healthScore": null,
      "planName": null,
      "archived": false,
      "archivedAt": null,
      "scheduledArchiveAt": null,
      "createdAt": "2026-01-15T10:00:00.000Z",
      "updatedAt": "2026-01-15T10:00:00.000Z"
    },
    "locationId": "loc_456",
    "locationSkipped": null
  }
}