POST/api/v4/social/posts/cancel

Zamanlanmış bir gönderiyi iptal etme

Zamanlanmış bir sosyal medya gönderisini yayımlanmadan önce iptal eder, daha önce yayımlanmış gönderileri değiştirmez.

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.socialPostIdstringzorunluUUID of the scheduled post to cancel.

Örnek istek

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

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

Yanıtlar

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.

Henüz yayımlanmayı bekleyen bir gönderiyi iptal eder. Gönderi ARCHIVED durumuna geçer ve yayımlama süreci gönderiyi işleme almayı bırakır. Taslaklar da aynı şekilde iptal edilebilir; daha önce yayımlanmış gönderiler iptal edilemez.

Kullanım senaryosu: bir müşteri son anda bir kampanyadan vazgeçer. Takviminizde zamanlanmış bir gönderi görünür, müşteri fikrini değiştirir ve siz de gönderiyi kendi kullanıcı arayüzünüzden iptal edersiniz. Gönderinin id değerini doğrudan markanın gönderi listesinden alın ve bu endpoint'i çağırın; satır ARCHIVED durumuna geçer ve bir sonraki okuma işleminde {"status":["SCHEDULED"]} filtresinin sonuçlarından çıkar.

Kullanım senaryosu: bir kanalın bağlantısını kesmeden önce temizlik yapma. Bir bağlantının kesilmesi, o bağlantı için zaten sıraya alınmış gönderileri iptal etmez; bunun yerine gönderiler yayımlama sırasında SY95045 hatasıyla başarısız olur. Önce zamanlanmış gönderileri iptal edin, ardından bağlantıyı kesin; böylece müşteri hiçbir başarısızlık görmez.

Notlar.

  • İstek gövdesi bir input nesnesi içine alınmalıdır.
  • HTTP durumunu değil, success değerini kontrol edin. Daha önce yayımlanmış veya iptal edilmiş bir gönderi için success: false ile birlikte HTTP 200 döndürülür.
  • Bu bir silme işlemi değildir. Hiçbir platformdan hiçbir şey kaldırılmaz. Daha önce yayımlanmış bir gönderi yayında kalır ve bu çağrı, söz konusu gönderi için yalnızca success: false bildirir. Bir sosyal medya gönderisini yayından kaldıran bir endpoint yoktur; kaldırma işlemi platformun kendisinde yapılır.
  • İptal işlemi, gönderinin tüm kanallarına uygulanır veya hiçbirine uygulanmaz. Zamanlanmış bir gönderiyi bir platformda iptal ederken başka bir platformda yayımlanmasına izin vermenin bir yolu yoktur; buna ihtiyacınız varsa ayrı gönderiler oluşturun.
  • Gönderi, işlemden sonra da post.status değeri ARCHIVED olacak şekilde GET /social/posts/{postId} ile okunabilir.

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/posts/cancel' \  -H "Authorization: API $LISTINGSAPI_KEY" \  -H 'Content-Type: application/json' \  -d '{    "input": {      "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345"    }  }'