/api/v4/social/posts/cancelإلغاء منشور مجدول
يلغي منشورًا مجدولًا على وسائل التواصل الاجتماعي قبل نشره، مع إبقاء المنشورات التي نُشرت بالفعل دون تغيير.
المعلمات
النص الأساسي
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| input | object | مطلوب | Wrapper object. The entire request body must be nested under `input`. |
| input.socialPostId | string | مطلوب | UUID of the scheduled post to cancel. |
مثال على الطلب
نص جاهز للصق. استبدل المعرّفات والقيم النموذجية بقيمك.
{ "input": { "socialPostId": "c47a1e58-2b93-4f10-a6d7-58e0c9b12345" }}الاستجابات
200The scheduled post was cancelled and will not publish.
{ "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`.
{ "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.
يلغي منشورًا لا يزال ينتظر النشر. ينتقل المنشور إلى ARCHIVED وتستبعده عملية النشر. يمكن إلغاء المسودات بالطريقة نفسها؛ أما المنشورات التي نُشرت بالفعل فلا يمكن إلغاؤها.
حالة استخدام: عميل يسحب حملة في اللحظة الأخيرة. يعرض تقويمك منشورًا مجدولًا، ثم يغيّر العميل رأيه، فتلغيه من واجهتك. خذ id الخاص بالمنشور مباشرةً من قائمة منشورات العلامة التجارية واستدعِ نقطة النهاية هذه؛ ينتقل الصف إلى ARCHIVED ويختفي من نتائج التصفية باستخدام {"status":["SCHEDULED"]} عند القراءة التالية.
حالة استخدام: إلغاء المنشورات المعلّقة قبل قطع اتصال قناة. قطع الاتصال لا يلغي المنشورات الموجودة بالفعل في قائمة الانتظار لذلك الاتصال — بل تفشل عند حلول وقت النشر مع SY95045. ألغِ المنشورات المجدولة أولًا، ثم اقطع الاتصال، ولن يرى العميل أي حالات فشل على الإطلاق.
ملاحظات.
- يجب تغليف جسم الطلب داخل كائن
input. - تحقّق من
success، وليس من حالة HTTP. إذا كان المنشور قد نُشر بالفعل أو أُلغي بالفعل، يُرجع الاستدعاءHTTP 200معsuccess: false. - هذه ليست عملية حذف. لا يُزال أي شيء من أي منصة. يظل المنشور الذي نُشر بالفعل متاحًا، ويكتفي هذا الاستدعاء بإرجاع
success: falseله. لا توجد نقطة نهاية تلغي نشر منشور على وسائل التواصل الاجتماعي؛ بل يُزال من المنصة نفسها. - يشمل الإلغاء جميع قنوات المنشور أو لا يُنفّذ على أي منها. لا توجد طريقة لإلغاء منشور مجدول على منصة واحدة مع السماح بنشره على منصة أخرى؛ أنشئ منشورات منفصلة إذا كنت بحاجة إلى ذلك.
- يظل المنشور قابلًا للقراءة بعد ذلك باستخدام
GET /social/posts/{postId}، وتكون قيمةpost.statusهيARCHIVED.
عملية كتابة: لم تُنفّذ على الحساب الفعلي. أُنشئ الطلب والاستجابة المعروضان استنادًا إلى مخطط API.
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" } }'