POST/api/v4/social/posts/cancel

Annullare un post programmato

Annulla un post social programmato prima che venga pubblicato, lasciando invariati i post già pubblicati.

Richiede una chiave API. Consulta Autenticazione per il formato dell’header e la rotazione delle chiavi.

Parametri

Corpo

NomeTipoObbligatorioDescrizione
inputobjectobbligatorioWrapper object. The entire request body must be nested under `input`.
input.socialPostIdstringobbligatorioUUID of the scheduled post to cancel.

Richiesta di esempio

Corpo pronto da incollare. Sostituisci gli ID e i valori segnaposto con i tuoi.

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

Risposte

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.

Annulla un post ancora in attesa di pubblicazione. Il post passa a ARCHIVED e la pipeline di pubblicazione lo esclude. Le bozze possono essere annullate allo stesso modo; i post già pubblicati no.

Caso d'uso: un cliente ritira una campagna all'ultimo minuto. Il tuo calendario mostra un post programmato, il cliente cambia idea e tu lo annulli dalla tua interfaccia. Prendi il id del post direttamente da l'elenco dei post del brand e chiama questo endpoint; la riga passa a ARCHIVED e alla lettura successiva non compare più nei risultati di un filtro {"status":["SCHEDULED"]}.

Caso d'uso: fare pulizia prima di scollegare un canale. Scollegare una connessione non annulla i post già in coda per quella connessione: la loro pubblicazione fallisce invece con SY95045. Annulla prima i post programmati, poi scollega la connessione, e il cliente non vedrà alcun errore.

Note.

  • Il corpo della richiesta deve essere racchiuso in un oggetto input.
  • Controlla success, non lo stato HTTP. Per un post già pubblicato o già annullato, l'endpoint restituisce HTTP 200 con success: false.
  • Questa operazione non è un'eliminazione. Non viene rimosso nulla da nessuna piattaforma. Un post già pubblicato rimane online e questa chiamata si limita a restituire success: false per quel post. Non esiste un endpoint che rimuova dalla pubblicazione un post social; la rimozione va effettuata sulla piattaforma stessa.
  • L'annullamento si applica a tutti i canali del post oppure a nessuno. Non è possibile annullare un post programmato su una piattaforma lasciando che venga pubblicato su un'altra; crea post separati se ne hai bisogno.
  • Il post rimane leggibile anche dopo l'annullamento tramite GET /social/posts/{postId}, con post.status pari a ARCHIVED.

Operazione di scrittura: non eseguita sull'account reale. La richiesta e la risposta mostrate sono costruite a partire dallo schema dell'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"    }  }'