DELETE/api/v4/posts/{postId}

Elimina un post

Elimina definitivamente una campagna di post sui social e la rimuove da ogni sito su cui è stata pubblicata.

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

Parametri

Percorso

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

Corpo

NomeTipoObbligatorioDescrizione
clientMutationIdstringfacoltativoOptional client-supplied token returned unchanged in the response, for correlating the request.

Richiesta di esempio

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

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

Risposte

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

Elimina la campagna di post specificata. L'operazione è definitiva: il post viene rimosso da Listings API e ritirato da ogni sito su cui è stato pubblicato (Google, Facebook). Eliminare un post attivo lo rimuove dai profili collegati; l'operazione non può essere annullata.

Caso d'uso: ritirare un annuncio errato. Se un annuncio è stato pubblicato con orari errati, eliminalo con DELETE /posts/{postId} (usando id dall'elenco dei post), conferma success: true, quindi pubblicane uno corretto con POST /posts. Per rimuovere una campagna da tutti i negozi contemporaneamente, elimina invece la campagna collettiva tramite il suo ID collettivo.

Note.

  • Il corpo della richiesta è facoltativo. Invia clientMutationId solo se vuoi che il valore venga restituito invariato per correlare la richiesta; il frammento di codice generato lo include come esempio.
  • Un post il cui periodo di pubblicazione programmato è già terminato può riportare status: EXPIRED e non essere più attivo su ciascun sito, ma eliminarlo lo rimuove comunque da Listings API.
  • L'eliminazione di un post già eliminato o sconosciuto restituisce una risposta di errore ({"data":null,"errors":[...]}) anziché success: true.

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