Listings APIListings API
Oturum aç
POST/api/v4/social/brands/archive

Bir markayı arşivleme

90 günü dolduran sosyal medya markasını arşivler, bağlantılarını hemen çevrimdışı bırakır; bağlantı kontenjanları fatura dönemi sonuna dek tutulur.

API anahtarı gerektirir. Başlık biçimi ve anahtar yenileme için Kimlik doğrulama bölümüne bakın.

Parametreler

Gövde

AdTürZorunluAçıklama
inputobjectzorunluWrapper object. The entire request body must be nested under `input`.
input.socialProfileIdstringzorunluUUID of the brand to archive. Same value as the `brandId` path token used elsewhere.

Örnek istek

Yapıştırmaya hazır gövde. Yer tutucu kimlikleri ve değerleri kendi değerlerinizle değiştirin.

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

Yanıtlar

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`).

Bir markayı arşivler. Arşivleme hemen gerçekleşir: marka hesapta en az 90 gündür bulunuyorsa bu çağrı, markayı ve ona bağlı tüm sosyal medya hesaplarını aynı istekte arşivler ve bu hesaplar yayın yapmayı derhal durdurur.

Kullanım senaryosu: sonraki dönemin kapasitesini planlama. Markaların kendileri sınırsızdır ve kullanıma göre ölçülmez; dolayısıyla arşivleme, marka sayısıyla değil bağlantılarla ilgilidir. Bir müşteri ayrıldıysa markasını arşivlemek, kanallarını bugün çevrimdışı duruma getirir ve kontenjanlarını yenileme sırasında geri verilmek üzere sıraya alır; GET /social/limits içindeki usage.connectionsReleased da bunu bildirir. Kapasiteye o zamandan önce ihtiyacınız varsa bir bağlantı paketi satın alın; hemen yürürlüğe giren tek değişiklik budur.

Yanıttaki durum değerleri:

  • ARCHIVED: marka ve bağlantıları arşivlenmiştir. Tek başarılı sonuç budur.
  • TENURE_NOT_MET: marka henüz 90 günlük değildir ve henüz arşivlenemez. success değeri false, error.code değeri SY95051 olur ve marka değişmeden kalır.

Notlar.

  • İstek gövdesi bir input nesnesi içine alınmalıdır ve alan brandId değil, socialProfileId olmalıdır.
  • HTTP durumunu değil, success değerini kontrol edin. Asgari süre koşulu karşılanmadığında, error içinde success: false, status: "TENURE_NOT_MET" ve SY95051 içeren bir HTTP 200 döndürülür.
  • Bir markanın arşivlenebilmesi için en az 90 günlük olması gerekir. Konumlar da aynı kurala tabidir; Planlar ve ek paketler bölümüne bakın. Markanın 90. gününden sonra yeniden deneyin; API üzerinden bu koşuldan muafiyet sağlanamaz.
  • Bir markayı arşivlemek, bağlantılarını da arşivler. Markaya bağlı tüm sosyal medya hesaplarının bağlantısı aynı işlemde kesilir ve GET /social/limits, bir sonraki okumada bunu daha düşük bir usage.connectionsActive ve daha yüksek bir usage.connectionsReleased değeriyle yansıtır. Faturalandırılabilir usage.connections, yeni dönem başlayana kadar değişmez.
  • Markada iptal edilecek bir işlem yoktur. Arşivleme işleminin kendisi, faturalandırma döneminin sonunu beklemez; bu nedenle bu işlem için planlanmış bir durum veya iptal çağrısı yoktur. Ertelenen ise faturalandırma üzerindeki etkisidir: serbest bırakılan bağlantı kontenjanları, iptal edilmiş bir ek paket gibi, dönem sona erdiğinde geri gelir.

Yazma işlemi: canlı hesap üzerinde yürütülmemiştir. Gösterilen istek ve yanıt, API şemasından oluşturulmuştur.

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