DELETE/api/v4/posts/{postId}

Supprimer une publication

Supprime définitivement une campagne de publication sur les réseaux sociaux et la retire de tous les sites sur lesquels elle a été publiée.

Nécessite une clé API. Consultez Authentification pour le format de l’en-tête et la rotation des clés.

Paramètres

Chemin

NomTypeObligatoireDescription
postIdstringobligatoireBase64-encoded social post ID to delete (the `id` from a posts list or the create response).

Corps

NomTypeObligatoireDescription
clientMutationIdstringfacultatifOptional client-supplied token returned unchanged in the response, for correlating the request.

Exemple de requête

Corps prêt à coller. Remplacez les identifiants et valeurs d’exemple par les vôtres.

Request body
{  "clientMutationId": "delete-44122-req-1"}

Réponses

200Post deleted. `socialPostId` returns the deleted post's ID.
Response
{  "data": {    "deleteSocialPost": {      "success": true,      "socialPostId": "U29jaWFsUG9zdDo0NDEyMg=="    }  }}
401Unauthenticated, missing or invalid API key.

Supprime la campagne de publication spécifiée. Cette action est définitive : la publication est supprimée de Listings API et retirée de tous les sites sur lesquels elle a été diffusée (Google, Facebook). La suppression d’une publication en ligne la retire des profils connectés ; cette action est irréversible.

Cas d’utilisation : retirer une annonce erronée. Si une annonce a été diffusée avec des horaires incorrects, supprimez-la avec DELETE /posts/{postId} (en utilisant id provenant de la liste des publications), confirmez success: true, puis publiez une annonce corrigée avec POST /posts. Pour retirer une campagne de tous les magasins en une seule fois, supprimez plutôt la campagne groupée à l’aide de son identifiant de campagne groupée.

Remarques.

  • Le corps de la requête est facultatif. Envoyez clientMutationId uniquement si vous souhaitez que la valeur soit renvoyée telle quelle pour permettre la corrélation des requêtes ; l’extrait généré l’inclut à titre d’exemple.
  • Une publication dont la période de diffusion prévue est déjà terminée peut afficher status: EXPIRED et ne plus être en ligne sur les différents sites, mais sa suppression la retire tout de même de Listings API.
  • La suppression d’une publication déjà supprimée ou inconnue renvoie une réponse d’erreur ({"data":null,"errors":[...]}) plutôt que success: true.

Opération d’écriture : non exécutée sur le compte réel. La requête et la réponse présentées sont construites à partir du schéma de l’API.

Request
curl -X DELETE 'https://listingsapi.com/api/v4/posts/<postId>' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "clientMutationId": "delete-44122-req-1"  }'