v1Ressources/SEO/patchMettre à jour la configuration de grille d'un établissement
Mettre à jour la configuration de grille d'un établissement
Met à jour la configuration de mesure de la grille d'un établissement : taille de grille, distance entre les points, points exclus, ou si les points de grille en eau comptent dans les statistiques. Ne transmettez que les champs à modifier. Les points en eau sont de toute façon toujours récupérés — includeWaterPoints contrôle seulement s'ils sont comptés et affichés. Le côté lecture est déjà couvert par GET /api/v1/seo/keywords, dont la réponse inclut déjà includeWaterPoints.
patch
seo:write/api/v1/seo/configCorps de la requête
locationIdstringobligatoire
L'établissement à configurer.
clientIdstringfacultatif
Le client de l'établissement.
gridSizeinteger (3 | 5 | 7)facultatif
Taille de grille : 3, 5 ou 7.
distanceKmnumberfacultatif
Distance en kilomètres entre points de grille adjacents.
excludedarray of objectfacultatif
Points de grille à exclure de la mesure.
rowintegerfacultatif
Index de ligne de la grille, indexé à partir de 0.
colintegerfacultatif
Index de colonne de la grille, indexé à partir de 0.
includeWaterPointsbooleanfacultatif
Si les points de grille en eau comptent dans les statistiques.
Réponse
dataobjectfacultatif
configobjectfacultatif
La configuration de grille de l'établissement après la mise à jour.
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.
patch/api/v1/seo/config
Votre clé API
Corps de la requête*
{
"data": {
"config": {
"id": "cm_cfg_abc123",
"synupLocationId": "os_9f8e7d6c",
"clientLocationId": "cm_loc_1",
"agencyId": "cm_agency_1",
"placeId": "ChIJtXC2rwgF9YgRNh1YJHlA4vQ",
"centerLat": 30.2672,
"centerLng": -97.7431,
"gridSize": 5,
"distanceKm": 1.5,
"excludedPoints": [
{
"row": 4,
"col": 4
}
],
"generationStartedAt": null,
"lastRunStatus": "complete",
"lastError": null,
"includeWaterPoints": true,
"lastGeneratedAt": "2026-02-01T06:00:00.000Z",
"createdAt": "2026-01-10T09:00:00.000Z",
"updatedAt": "2026-02-05T10:00:00.000Z"
}
}
}