Listings APIListings API
Se connecter
POST/api/v4/social/posts/cancel

Annuler une publication programmée

Annule une publication programmée sur les réseaux sociaux avant sa diffusion, sans modifier les publications déjà diffusées.

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

Paramètres

Corps

NomTypeObligatoireDescription
inputobjectobligatoireWrapper object. The entire request body must be nested under `input`.
input.socialPostIdstringobligatoireUUID of the scheduled post to cancel.

Exemple de requête

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

Request body
{  "input": {    "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"  }}

Réponses

200The scheduled post was cancelled and will not publish.
Response
{  "data": {    "archiveScheduledPost": {      "success": true,      "error": null,      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
200The post was not in a cancellable state, most often because it has already published. The status is still 200: read `success`.
Response
{  "data": {    "archiveScheduledPost": {      "success": false,      "error": {        "message": "SY90006: Post is not scheduled and cannot be cancelled",        "code": "SY90006",        "contextInfo": null      },      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }}
401Unauthenticated, missing or invalid API key.
404No post with that ID on this account.

Annule une publication qui est encore en attente de diffusion. La publication passe à ARCHIVED et le pipeline de publication la retire de la file. Les brouillons peuvent être annulés de la même manière ; les publications déjà diffusées ne peuvent pas l'être.

Cas d'utilisation : un client retire une campagne à la dernière minute. Votre calendrier affiche une publication programmée, le client change d'avis et vous l'annulez depuis votre propre interface. Récupérez le id de la publication directement dans la liste des publications de la marque et appelez cet endpoint ; la ligne passe à ARCHIVED et n'apparaît plus dans les résultats d'un filtre {"status":["SCHEDULED"]} lors de la lecture suivante.

Cas d'utilisation : faire le ménage avant de déconnecter un canal. La déconnexion d'une connexion n'annule pas les publications déjà placées dans sa file d'attente : elles échouent à la place au moment de leur diffusion avec SY95045. Annulez d'abord les publications programmées, puis déconnectez la connexion, et le client ne verra aucun échec.

Remarques.

  • Le corps de la requête doit être encapsulé dans un objet input.
  • Vérifiez success, et non le statut HTTP. Pour une publication déjà diffusée ou déjà annulée, l'appel renvoie HTTP 200 avec success: false.
  • Il ne s'agit pas d'une suppression. Rien n'est supprimé d'aucune plateforme. Une publication déjà diffusée reste en ligne, et cet appel signale simplement success: false pour celle-ci. Aucun endpoint ne permet de retirer une publication des réseaux sociaux ; sa suppression s'effectue directement sur la plateforme.
  • L'annulation s'applique à tous les canaux de la publication ou à aucun. Il est impossible d'annuler une publication programmée sur une plateforme tout en permettant sa diffusion sur une autre ; créez des publications distinctes si vous en avez besoin.
  • La publication reste consultable ensuite avec GET /social/posts/{postId}, avec post.status défini sur ARCHIVED.

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 POST 'https://listingsapi.com/api/v4/social/posts/cancel' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }'
Run in playground