/api/v4/social/brands/archiveأرشفة علامة تجارية
يؤرشف علامة تجارية على وسائل التواصل ويوقف اتصالاتها فورًا بعد استيفاء شرط بقائها 90 يومًا؛ وتظل خانات الاتصالات محجوزة حتى نهاية فترة الفوترة.
المعلمات
النص الأساسي
| الاسم | النوع | مطلوب | الوصف |
|---|---|---|---|
| input | object | مطلوب | Wrapper object. The entire request body must be nested under `input`. |
| input.socialProfileId | string | مطلوب | UUID of the brand to archive. Same value as the `brandId` path token used elsewhere. |
مثال على الطلب
نص جاهز للصق. استبدل المعرّفات والقيم النموذجية بقيمك.
{ "input": { "socialProfileId": "6f2c9a41-7b0e-4d55-9a2f-3c8e1d47b902" }}الاستجابات
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.
{ "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`.
{ "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`).
يؤرشف علامة تجارية. الأرشفة فورية: بمجرد مرور 90 يومًا على الأقل على إضافة العلامة التجارية إلى الحساب، يؤرشف هذا الاستدعاء العلامة التجارية وكل حساب على وسائل التواصل الاجتماعي متصل بها ضمن الطلب نفسه، وتتوقف تلك الحسابات عن النشر مباشرةً.
حالة استخدام: التخطيط لسعة الدورة التالية. لا يوجد حد لعدد العلامات التجارية نفسها، ولا تُحتسب رسوم بحسب عددها، لذا فالأرشفة لا تتعلق بعدد العلامات التجارية — بل بالاتصالات. إذا توقف عميل عن استخدام الخدمة، فإن أرشفة علامته التجارية توقف قنواته اليوم وتُدرج خاناته لتصبح متاحة مجددًا عند التجديد، وهو ما يوضحه usage.connectionsReleased في GET /social/limits. إذا كنت بحاجة إلى السعة قبل ذلك، فاشترِ حزمة اتصالات — فهذا هو التغيير الوحيد الذي يسري فورًا.
قيم الحالة في الاستجابة:
ARCHIVED: تمت أرشفة العلامة التجارية واتصالاتها. هذه هي نتيجة النجاح الوحيدة.TENURE_NOT_MET: لم يمضِ على إضافة العلامة التجارية 90 يومًا، ولا يمكن أرشفتها بعد. تكون قيمةsuccessهيfalse، وقيمةerror.codeهيSY95051، وتبقى العلامة التجارية دون تغيير.
ملاحظات.
- يجب تغليف جسم الطلب داخل كائن
input، واسم الحقل هوsocialProfileId، وليسbrandId. - تحقّق من
success، وليس من حالة HTTP. عند عدم استيفاء شرط المدة، تكون النتيجةHTTP 200معsuccess: falseوstatus: "TENURE_NOT_MET"وSY95051ضمنerror. - يجب أن يكون قد مضى على إضافة العلامة التجارية 90 يومًا على الأقل حتى يمكن أرشفتها. هذه هي القاعدة نفسها التي تخضع لها المواقع؛ راجع الخطط والإضافات. أعد المحاولة بعد اليوم 90 للعلامة التجارية؛ ولا توجد طريقة للإعفاء من هذا الشرط عبر API.
- تؤدي أرشفة علامة تجارية إلى أرشفة اتصالاتها. يُفصل كل حساب على وسائل التواصل الاجتماعي مرتبط بالعلامة التجارية ضمن العملية نفسها، ويعكس
GET /social/limitsذلك عند القراءة التالية بانخفاضusage.connectionsActiveوارتفاعusage.connectionsReleased. تظل قيمةusage.connectionsالخاضعة للفوترة دون تغيير حتى تبدأ الفترة التالية. - لا يوجد شيء يمكن إلغاؤه على مستوى العلامة التجارية. لا تنتظر الأرشفة نفسها نهاية دورة الفوترة، لذلك لا توجد لها حالة مجدولة ولا استدعاء لإلغائها. ما يُؤجَّل هو أثرها على الفوترة: تصبح خانات الاتصالات المحرَّرة متاحة مجددًا عند انتهاء الدورة، كما هو الحال مع حزمة إضافية أُلغيت.
عملية كتابة: لم تُنفَّذ على الحساب الفعلي. أُنشئ الطلب والاستجابة المعروضان استنادًا إلى مخطط API.
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" } }'