Listings APIListings API
Masuk
POST/api/v4/social/posts/cancel

Membatalkan postingan terjadwal

Membatalkan postingan media sosial terjadwal sebelum dipublikasikan, tanpa mengubah postingan yang sudah dipublikasikan.

Memerlukan kunci API. Lihat Autentikasi untuk format header dan rotasi kunci.

Parameter

Body

NamaTipeWajibDeskripsi
inputobjectwajibWrapper object. The entire request body must be nested under `input`.
input.socialPostIdstringwajibUUID of the scheduled post to cancel.

Contoh permintaan

Body siap tempel. Ganti ID dan nilai placeholder dengan milik Anda.

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

Respons

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.

Membatalkan postingan yang masih menunggu untuk dipublikasikan. Postingan berpindah ke ARCHIVED dan dikeluarkan dari alur publikasi. Draf dapat dibatalkan dengan cara yang sama; postingan yang sudah dipublikasikan tidak dapat dibatalkan.

Kasus penggunaan: klien menarik kampanye pada saat terakhir. Kalender Anda menampilkan postingan terjadwal, klien berubah pikiran, lalu Anda membatalkannya dari antarmuka Anda sendiri. Ambil id postingan langsung dari daftar postingan merek dan panggil endpoint ini; baris tersebut berpindah ke ARCHIVED dan tidak lagi muncul dalam hasil filter {"status":["SCHEDULED"]} pada pembacaan berikutnya.

Kasus penggunaan: merapikan postingan sebelum memutuskan koneksi saluran. Memutuskan koneksi tidak membatalkan postingan yang sudah diantrekan untuk koneksi tersebut — postingan itu justru gagal saat dipublikasikan dengan SY95045. Batalkan postingan terjadwal terlebih dahulu, lalu putuskan koneksi, sehingga pelanggan tidak melihat kegagalan apa pun.

Catatan.

  • Isi permintaan harus dibungkus dalam objek input.
  • Periksa success, bukan status HTTP. Untuk postingan yang sudah dipublikasikan atau sudah dibatalkan, endpoint mengembalikan HTTP 200 dengan success: false.
  • Ini bukan penghapusan. Tidak ada yang dihapus dari platform mana pun. Postingan yang sudah dipublikasikan tetap tayang, dan pemanggilan ini hanya melaporkan success: false untuk postingan tersebut. Tidak ada endpoint yang menarik postingan media sosial dari publikasi; penghapusannya dilakukan langsung di platform tersebut.
  • Pembatalan berlaku untuk semua saluran postingan sekaligus atau tidak sama sekali. Tidak ada cara untuk membatalkan postingan terjadwal di satu platform sambil tetap membiarkannya dipublikasikan di platform lain; buat postingan terpisah jika Anda membutuhkannya.
  • Postingan tetap dapat dibaca setelahnya melalui GET /social/posts/{postId}, dengan post.status bernilai ARCHIVED.

Operasi tulis: tidak dijalankan pada akun aktif. Permintaan dan respons yang ditampilkan dibuat berdasarkan skema 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