POST/api/v4/social/connections/disconnect

Bir bağlantıyı kesin

Bağlı bir sosyal hesabı hemen çevrimdışı bırakır; hesap genelindeki havuzda bu hesaba ayrılan yuva, faturalandırma döneminin sonuna kadar 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.socialProfileConnectedChannelIdstringzorunluUUID of the connection to remove, the `id` of a row from GET /social/brands/{brandId}/connections.

Örnek istek

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

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

Yanıtlar

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.

Bağlı bir sosyal hesabı markasından kaldırır. Marka doğrudan belirtilmez: bağlantı kimliği her ikisini de tanımlar. Bu, iptal süresi ve geri alma olanağı olmayan tek yönlü bir işlemdir. Kanalı yeniden bağlamak için yeni bir bağlantı kurma bağlantısı oluşturun ve kullanıcının yeniden yetki vermesini sağlayın.

Kullanım örneği: bir müşteri bir kanala erişimi iptal eder. Bir müşteri bir Sayfayı kontrolünüzden çıkardığında, zamanlanmış gönderilerin o kanalda yayımlanmaya çalışmasını durdurmak için kanalın bağlantısını kesin. Markanın bağlantılarından id değerini okuyun, bağlantıyı kesin ve ardından doğrulamak için listeyi yeniden okuyun.

Notlar.

  • İstek gövdesi bir input nesnesi içinde yer almalıdır. Alan socialProfileConnectedChannelId şeklindedir; bu, bağlantının kendi UUID değeridir, platformun connectedAccountId değeri veya marka kimliği değildir.
  • HTTP durumunu değil, success değerini kontrol edin. Farklı bir markaya ait olan veya artık mevcut olmayan bir bağlantı için success: false ile birlikte HTTP 200 döndürülür. Yanıt gövdesi herhangi bir kimlik içermez, bu nedenle hangi bağlantının kaldırılmasını istediğinizi kendi kayıtlarınızda tutun.
  • Benzer adlara dikkat edin. Bu gövde alanı socialProfileConnectedChannelId şeklindedir ve ortasında Profile bulunur. Yanındaki insights uç noktası, aynı kimliği bir kelime daha kısa olan socialConnectedChannelId alanıyla alır. Aralarında bir kelime fark vardır ve hiçbiri diğerinin adını kabul etmez.
  • Zamanlanmış gönderiler iptal edilmez. Bu kanalda yayımlanmak üzere zamanlanmış bir gönderi, işlemden çıkarılmak yerine yayımlanma zamanı geldiğinde SY95045 hatasıyla başarısız olur. Bu hatanın oluşmasını istemiyorsanız önce POST /social/posts/cancel ile gönderiyi iptal edin.
  • Daha önce yayımlanmış gönderiler yayında kalır. Bağlantının kesilmesi, listingsAPI'nin gönderi yayımlama ve istatistikleri okuma yetkisini kaldırır; platformdan hiçbir şey silmez.
  • Yuva, işlem başarılı olduğunda değil, yenileme sırasında havuza döner. GET /social/limits bunu hemen daha düşük bir usage.connectionsActive ve daha yüksek bir usage.connectionsReleased değeriyle gösterir; üst sınırın uygulandığı faturalandırılabilir sayı olan usage.connections ise yeni faturalandırma dönemi başlayana kadar değişmez. usage.connectionsReleased, yenileme sırasında geri kazanılan kapasite miktarıdır. Planlar ve eklentiler bölümüne bakın.
  • Aynı hesabı aynı markaya yeniden bağlamak ücretsizdir. Aynı dönem içinde daha önce o markadan bağlantısını kestiğiniz bir sosyal hesabı yeniden bağlamak, mevcut yuvasını yeniden kullanır: yuva connectionsReleased kapsamından çıkarak yeniden connectionsActive kapsamına girer ve faturalandırılabilir connections değeri değişmez. Her marka ve hesap çifti için bir yuva tutulur; bu nedenle farklı bir sosyal hesap yeni bir yuva gerektirir ve aynı hesabın farklı bir markaya bağlanması da yeni bir yuva gerektirir.
  • Bir markayı arşivlemek, markaya ait tüm bağlantıları keser; dolayısıyla arşivleme sırasında önce bu çağrıyı yapmanız gerekmez. Bu durumda da yuvalar dönem sonuna kadar tutulur; serbest bırakma yöntemi fark yaratmaz.

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