/api/v4/social/posts/cancelCancelar una publicación programada
Cancela una publicación programada en redes sociales antes de que se publique, sin modificar las publicaciones ya publicadas.
Parámetros
Cuerpo
| Nombre | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| input | object | obligatorio | Wrapper object. The entire request body must be nested under `input`. |
| input.socialPostId | string | obligatorio | UUID of the scheduled post to cancel. |
Solicitud de ejemplo
Cuerpo listo para pegar. Sustituye los ID y valores de ejemplo por los tuyos.
{ "input": { "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345" }}Respuestas
200The scheduled post was cancelled and will not publish.
{ "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`.
{ "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.
Cancela una publicación que aún está pendiente de publicarse. La publicación pasa a ARCHIVED y el proceso de publicación la descarta. Los borradores se pueden cancelar de la misma manera; las publicaciones que ya se han publicado no.
Caso de uso: un cliente retira una campaña en el último momento. Tu calendario muestra una publicación programada, el cliente cambia de opinión y tú la cancelas desde tu propia interfaz. Obtén el id de la publicación directamente de la lista de publicaciones de la marca y llama a este endpoint; la fila pasa a ARCHIVED y deja de aparecer al aplicar un filtro de {"status":["SCHEDULED"]} en la siguiente consulta.
Caso de uso: hacer limpieza antes de desconectar un canal. Desconectar una conexión no cancela las publicaciones que ya están en su cola; estas fallan en el momento de publicarse con SY95045. Cancela primero las publicaciones programadas y luego desconecta, y el cliente no verá ningún fallo.
Notas.
- El cuerpo de la solicitud debe estar contenido en un objeto
input. - Comprueba
success, no el estado HTTP. Una publicación que ya se ha publicado o que ya se ha cancelado devuelveHTTP 200consuccess: false. - Esto no es una eliminación. No se elimina nada de ninguna plataforma. Una publicación que ya se ha publicado sigue visible, y esta llamada simplemente devuelve
success: falsepara ella. No hay ningún endpoint que retire una publicación de redes sociales; para eliminarla, debes hacerlo en la propia plataforma. - La cancelación se aplica a todos los canales de la publicación o a ninguno. No es posible cancelar una publicación programada en una plataforma y permitir que se publique en otra; crea publicaciones independientes si necesitas hacerlo.
- Después, la publicación sigue disponible para su consulta con
GET /social/posts/{postId}, conpost.statusestablecido enARCHIVED.
Operación de escritura: no se ha ejecutado en la cuenta real. La solicitud y la respuesta que se muestran se han generado a partir del esquema de la API.
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" } }'