v1Ressources/Posts/postCréer un post
Créer un post
Crée un post pour un établissement ou un client et le soumet aux plateformes sélectionnées. Ceci publie du contenu réel : sauf si scheduledFor est défini ou si draft vaut true, le post est immédiatement mis en ligne sur ses plateformes cibles. Une plateforme demandée sans connexion active, ou un post à qui manque un champ requis pour être mis en ligne, ne fait jamais échouer l'appel — le contenu est plutôt enregistré comme brouillon ; voir le schéma de réponse pour savoir comment cela est signalé.
post
posts:write/api/v1/postsCorps de la requête
locationIdstringfacultatif
L'établissement pour lequel publier. Fournissez ceci ou clientId.
clientIdstringfacultatif
Le client pour lequel publier au niveau marque. Fournissez ceci ou locationId.
namestringobligatoire
Nom/étiquette interne du post. Obligatoire, non vide.
postTypestring (announcement | event | offer)obligatoire
Type de post. event et offer sont réservés à Google.
platformsarray of string (google | facebook | instagram | x | linkedin | pinterest | mastodon | bluesky | threads | tiktok)obligatoire
Plateformes cibles. Au moins une est requise.
connectionIdsarray of stringfacultatif
IDs de connexion explicites par lesquels publier, au lieu de résoudre les plateformes vers des connexions.
messageGooglestringfacultatif
Légende pour Google. Requise quand google est sélectionné, sauf en brouillon.
messageFacebookstringfacultatif
Légende sociale partagée pour chaque plateforme non-Google sélectionnée. Requise sauf en brouillon.
ctaTypestring (learn_more | sign_up | order_online | book | buy | call_now)facultatif
Type d'appel à l'action.
ctaUrlstringfacultatif
URL de destination de l'appel à l'action.
mediaUrlsarray of objectfacultatif
Médias à joindre, une entrée par pièce jointe de plateforme.
urlstringfacultatif
platformstringfacultatif
typestring (image | video)facultatif
eventTitlestringfacultatif
Titre de l'événement ou de l'offre. Requis pour un événement/une offre Google, sauf en brouillon.
eventStartAtstringfacultatif
Date/heure de début de l'événement ou de l'offre, au format horodatage ISO 8601. Requise pour un événement/une offre Google, sauf en brouillon.
eventEndAtstringfacultatif
Date/heure de fin de l'événement ou de l'offre, au format horodatage ISO 8601. Doit être après le début.
offerTermsstringfacultatif
Conditions de l'offre.
offerCouponCodestringfacultatif
Code promo de l'offre.
offerRedeemUrlstringfacultatif
URL d'utilisation de l'offre.
scheduledForstringfacultatif
Publier à ce futur horodatage ISO 8601 au lieu d'immédiatement.
draftbooleanfacultatif
Enregistrer sans publier. Ignore les vérifications de champs requis ; les vérifications structurelles (limites, règles de médias) s'appliquent toujours.
Réponse
dataobjectfacultatif
Une plateforme demandée sans connexion active, ou un champ requis manquant avant que le post puisse être publié, ne fait jamais échouer cet appel — le post est quand même enregistré. Quand l'un de ces cas se présente, status vaut "no_connection" ou "incomplete" et le post est niché dessous sous la forme post.{id,status} ; en cas de publication propre, l'id/status de premier niveau décrivent directement le post.
idstringfacultatif
Identifiant unique du post.
statusstringfacultatif
Statut du cycle de vie du post : draft, scheduled, active ou error.
missingFieldsarray of stringfacultatif
Champs encore nécessaires avant que ce post puisse être mis en ligne, le cas échéant.
missingPlatformsarray of stringfacultatif
Plateformes demandées sans connexion active, le cas échéant.
scopestring (location | client)facultatif
Si l'écart de connexion/champ s'applique au niveau de l'établissement ou du client.
postobjectfacultatif
Le post qui a été créé ou mis à jour.
idstringfacultatif
Identifiant unique du post.
statusstringfacultatif
Statut du cycle de vie du post : draft, scheduled, active ou error.
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.
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/posts
Votre clé API
Corps de la requête*
{
"data": {
"id": "cm_post_abc123",
"status": "scheduled"
}
}