Synupv1
Créer une clé
v1Ressources/Clients/patchMettre à jour un client

Mettre à jour un client

Modifie les champs modifiables d'un client existant. Envoyez uniquement les champs que vous souhaitez changer. Le primaryContactEmail du client (son identifiant de connexion au portail) ne peut être défini ici que tant qu'il est encore vide — il ne peut plus jamais être modifié une fois défini.

patch/api/v1/clients/{id}
clients:write
Paramètres de requête
idstringobligatoire
Le client à mettre à jour.
Corps de la requête
businessNamestringfacultatif
Le nom commercial du nouveau client.
industrystringfacultatif
Le secteur d'activité du client.
websitestringfacultatif
L'URL du site web du client.
primaryContactNamestringfacultatif
Le nom du contact principal.
phonestringfacultatif
Le numéro de téléphone du client.
locationCountnumberfacultatif
Le nombre d'établissements déclaré par le client — à titre informatif uniquement, pas le nombre réel d'établissements créés.
citystringfacultatif
La ville du client.
phoneCountryCodestringfacultatif
Le pays au format ISO-3166-1 alpha-2 auquel appartient le numéro de téléphone du client (par ex. « US », « IN ») — la région, pas l'indicatif téléphonique.
countrystringfacultatif
Le pays du client, au format code ISO-3166-1 alpha-2.
statestringfacultatif
L'État, la province ou la région du client.
trackingKeywordstringfacultatif
Un mot-clé pour suivre le classement local du client.
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.
packageTypestringfacultatif
Le type de forfait du client.
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.
primaryRepresentativeIdstringfacultatif
L'ID utilisateur du membre de l'équipe propriétaire 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.
primaryContactEmailstringfacultatif
Adresse e-mail du contact principal du client. Modifiable uniquement tant qu'elle est vide — elle devient l'identifiant de connexion au portail et ne peut plus jamais être modifiée une fois définie.
Réponse
dataobjectfacultatif
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.
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.
patch/api/v1/clients/{id}
Votre clé API
id *
Corps de la requête
{
  "data": {
    "id": "cli_123",
    "businessName": "Acme Dental",
    "website": "https://acmedental.com",
    "industry": "Dental",
    "primaryContactEmail": "owner@acmedental.com",
    "primaryRepresentativeId": "usr_123",
    "visibility": "public",
    "goal": "get_reviews",
    "notes": null,
    "gbpLink": null,
    "trackingKeyword": "dentist near me",
    "healthScore": 82,
    "planName": null,
    "archived": false,
    "archivedAt": null,
    "scheduledArchiveAt": null,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-02-01T09:30:00.000Z"
  }
}