POST/api/v4/social/connections/disconnect

Putuskan koneksi

Segera menonaktifkan akun media sosial terhubung; slotnya dalam kumpulan slot seluruh akun dicadangkan hingga akhir periode penagihan.

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.socialProfileConnectedChannelIdstringwajibUUID of the connection to remove, the `id` of a row from GET /social/brands/{brandId}/connections.

Contoh permintaan

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

Request body
{  "input": {    "socialProfileConnectedChannelId": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7"  }}

Respons

200Connection removed.
Response
{  "data": {    "disconnectSocialConnectedChannel": {      "success": true,      "error": null    }  }}
200The connection could not be removed, most often because it belongs to a different brand (`SY95052`) or has already been disconnected. The status is still 200: read `success`.
Response
{  "data": {    "disconnectSocialConnectedChannel": {      "success": false,      "error": {        "message": "SY95052: Connected channel does not belong to this brand",        "code": "SY95052",        "contextInfo": null      }    }  }}
401Unauthenticated, missing or invalid API key.

Menghapus satu akun media sosial yang terhubung dari mereknya. Merek tidak ditentukan secara langsung: ID koneksi mengidentifikasi keduanya. Operasi ini bersifat satu arah, tanpa tenggang waktu pembatalan dan tidak dapat diurungkan. Untuk memulihkan kanal, buat tautan koneksi baru dan minta pengguna memberikan otorisasi ulang.

Kasus penggunaan: klien mencabut akses ke satu kanal. Ketika pelanggan menghapus Halaman dari pengelolaan Anda, putuskan koneksi kanal tersebut agar postingan terjadwal berhenti mencoba dipublikasikan ke sana. Baca id dari koneksi merek tersebut, putuskan koneksinya, lalu baca kembali daftar untuk memastikan.

Catatan.

  • Body permintaan harus dibungkus dalam objek input. Field yang digunakan adalah socialProfileConnectedChannelId — UUID milik koneksi itu sendiri, bukan connectedAccountId milik platform dan bukan ID merek.
  • Periksa success, bukan status HTTP. Permintaan untuk koneksi yang merupakan milik merek lain atau sudah tidak ada akan mengembalikan HTTP 200 dengan success: false. Payload tidak memuat ID, jadi simpan catatan Anda sendiri tentang koneksi yang Anda minta untuk dihapus.
  • Perhatikan nama yang hampir sama. Field dalam body ini adalah socialProfileConnectedChannelId, dengan Profile di tengahnya. Endpoint insights di sebelahnya menerima socialConnectedChannelId — ID yang sama, dengan nama yang lebih pendek satu kata. Keduanya berbeda satu kata dan masing-masing tidak menerima nama yang digunakan oleh yang lain.
  • Postingan terjadwal tidak dibatalkan. Postingan yang dijadwalkan untuk kanal ini akan gagal pada waktu publikasi dengan SY95045 alih-alih dihapus dari jadwal. Batalkan terlebih dahulu dengan POST /social/posts/cancel jika Anda tidak menginginkan kegagalan tersebut.
  • Postingan yang sudah dipublikasikan tetap tayang. Memutuskan koneksi menghilangkan kemampuan listingsAPI untuk memublikasikan dan membaca insights; tindakan ini tidak menghapus apa pun dari platform.
  • Slot kembali ke kumpulan slot saat perpanjangan, bukan saat operasi berhasil. GET /social/limits langsung menunjukkan hal ini melalui nilai usage.connectionsActive yang lebih rendah dan nilai usage.connectionsReleased yang lebih tinggi, sementara usage.connections — jumlah yang ditagihkan dan dikenai batas maksimum — tetap tidak berubah hingga periode penagihan berganti. usage.connectionsReleased menunjukkan besarnya kapasitas yang kembali tersedia saat perpanjangan. Lihat Paket dan tambahan.
  • Menautkan kembali akun yang sama ke merek yang sama tidak dikenai biaya. Menghubungkan kembali akun media sosial yang sebelumnya Anda putuskan dari merek tersebut dalam periode yang sama akan menggunakan kembali slot yang sudah ada: slot tersebut berpindah kembali dari connectionsReleased ke connectionsActive dan connections yang ditagihkan tidak berubah. Slot dicadangkan per pasangan merek dan akun, sehingga akun media sosial yang berbeda memerlukan slot baru, begitu pula akun yang sama pada merek yang berbeda.
  • Mengarsipkan merek akan memutuskan semua koneksi pada merek tersebut, jadi Anda tidak perlu melakukan panggilan ini terlebih dahulu saat mengarsipkan. Slot juga tetap dicadangkan hingga akhir periode dalam kasus tersebut — cara pelepasannya tidak memengaruhi hal ini.

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/connections/disconnect' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialProfileConnectedChannelId": "b81d5b3c-4a90-4f6a-9c11-71e0dd2fa4a7"    }  }'