DELETE/api/v4/posts/{postId}

Eliminar una publicación

Elimina permanentemente una campaña de publicaciones en redes sociales y la retira de todos los sitios donde se publicó.

Requiere una clave de API. Consulta Autenticación para conocer el formato del encabezado y la rotación de claves.

Parámetros

Ruta

NombreTipoObligatorioDescripción
postIdstringobligatorioBase64-encoded social post ID to delete (the `id` from a posts list or the create response).

Cuerpo

NombreTipoObligatorioDescripción
clientMutationIdstringopcionalOptional client-supplied token returned unchanged in the response, for correlating the request.

Solicitud de ejemplo

Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.

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

Respuestas

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

Elimina la campaña de publicaciones especificada. Esta acción es permanente: la publicación se elimina de Listings API y se retira de todos los sitios donde se publicó (Google, Facebook). Eliminar una publicación activa la retira de los perfiles conectados; no se puede deshacer.

Caso de uso: retirar un anuncio incorrecto. Si se publicó un anuncio con un horario incorrecto, elimínalo con DELETE /posts/{postId} (usando el id de la lista de publicaciones), confirma success: true y luego publica uno corregido con POST /posts. Para retirar una campaña de todas las tiendas a la vez, elimina la campaña masiva mediante su ID de campaña masiva.

Notas.

  • El cuerpo de la solicitud es opcional. Envía clientMutationId solo si quieres que el valor se devuelva sin cambios para correlacionar la solicitud; el fragmento generado lo incluye como ejemplo.
  • Una publicación cuyo período programado ya haya terminado puede indicar status: EXPIRED y haber dejado de estar activa en cada sitio, pero eliminarla también la borra de Listings API.
  • Eliminar una publicación que ya se ha eliminado o que es desconocida devuelve una respuesta de error ({"data":null,"errors":[...]}) en lugar de success: true.

Operación de escritura: no se ha ejecutado en la cuenta real. La solicitud y la respuesta mostradas se han generado a partir del esquema de la 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"  }'