Listings APIListings API
Masuk
POST/api/v4/social/brands/archive

Mengarsipkan merek

Mengarsipkan merek sosial berusia minimal 90 hari dan langsung menonaktifkan koneksinya; slot koneksi ditahan 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.socialProfileIdstringwajibUUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

Contoh permintaan

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

Request body
{  "input": {    "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"  }}

Respons

200Brand archived. Its connections are archived with it and go offline at once, but their slots stay counted against `maxConnections` until the billing period ends.
Response
{  "data": {    "archiveSocialProfile": {      "success": true,      "error": null,      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "ARCHIVED"    }  }}
200The brand is less than 90 days old and cannot be archived yet. `success` is `false` and `status` is `TENURE_NOT_MET`.
Response
{  "data": {    "archiveSocialProfile": {      "success": false,      "error": {        "message": "SY95051: Brand must be at least 90 days old before it can be archived",        "code": "SY95051",        "contextInfo": null      },      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902",      "status": "TENURE_NOT_MET"    }  }}
401Unauthenticated, missing or invalid API key.
404No brand with that ID on this account (`SY95043`).

Mengarsipkan merek. Pengarsipan berlaku langsung: setelah merek berada di akun selama setidaknya 90 hari, panggilan ini mengarsipkan merek tersebut dan setiap akun sosial yang terhubung dengannya dalam permintaan yang sama, dan akun-akun tersebut langsung berhenti menerbitkan konten.

Kasus penggunaan: merencanakan kapasitas siklus berikutnya. Jumlah merek tidak dibatasi dan penggunaannya tidak diukur, jadi pengarsipan berkaitan dengan koneksi, bukan jumlah merek. Jika klien telah berhenti berlangganan, mengarsipkan mereknya akan menonaktifkan salurannya hari ini dan menjadwalkan slotnya agar tersedia kembali saat perpanjangan, sebagaimana dilaporkan oleh usage.connectionsReleased dalam GET /social/limits. Jika Anda memerlukan kapasitas sebelum itu, beli paket koneksi — itulah satu-satunya perubahan yang langsung berlaku.

Nilai status dalam respons:

  • ARCHIVED: merek dan koneksinya diarsipkan. Ini adalah satu-satunya hasil yang menandakan keberhasilan.
  • TENURE_NOT_MET: merek berusia kurang dari 90 hari dan belum dapat diarsipkan. success bernilai false, error.code bernilai SY95051, dan merek tidak berubah.

Catatan.

  • Isi permintaan harus dibungkus dalam objek input, dan field yang digunakan adalah socialProfileId, bukan brandId.
  • Periksa success, bukan status HTTP. Kegagalan memenuhi aturan masa keberadaan menghasilkan HTTP 200 dengan success: false, status: "TENURE_NOT_MET", dan SY95051 di dalam error.
  • Merek harus berusia setidaknya 90 hari agar dapat diarsipkan. Aturan yang sama berlaku untuk lokasi; lihat Paket dan add-on. Coba lagi setelah hari ke-90 merek tersebut; tidak ada cara untuk mengesampingkan aturan ini melalui API.
  • Mengarsipkan merek juga mengarsipkan koneksinya. Setiap akun sosial yang ditautkan ke merek diputus koneksinya dalam operasi yang sama, dan GET /social/limits mencerminkan perubahan ini pada pembacaan berikutnya dengan nilai usage.connectionsActive yang lebih rendah dan nilai usage.connectionsReleased yang lebih tinggi. Nilai usage.connections yang ditagihkan tidak berubah hingga periode berganti.
  • Tidak ada yang dapat dibatalkan pada merek. Pengarsipan itu sendiri tidak menunggu akhir siklus penagihan, sehingga tidak ada status terjadwal maupun panggilan pembatalan untuk pengarsipan tersebut. Yang memang ditunda adalah dampaknya terhadap penagihan: slot koneksi yang dilepas, seperti paket add-on yang dibatalkan, tersedia kembali saat siklus berakhir.

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/brands/archive' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902"    }  }'
Run in playground