إدارة وسوم الشركات

تُعَدّ الوسوم tags وسيلةً مناسبة لتصفية الشركات تبعًا لأهميتها أو حجم تعاملاتها مع نشاطك التجاري أو غير ذلك، ويمكنك إضافة الوسوم للشركة أو إزالتها منها بسهولة باستخدام الواجهة البرمجية لزيتون.

إضافة وسم للشركة

يمكنك إضافة وسم معين للشركة بإرسال طلب POST إلى نقطة الاتصال companies/{company_id}/tags/ وفق التالي:

  • عنوان URL لنقطة الاتصال:
    https://{your_subdomain}/api/agent/v1/companies/{company_id}/tags.
  • نوع الطلب: POST.
  • معاملات المسار Path Parameters: معامل واحد هو company_id، يُحَدِّد الرقم التعريفي للشركة، وهو معامل إجباري.
  • جسم الطلب Body: يكتب بصيغة JSON ويتضمن معامل وحيد هو اسم الوسم name، وهو معامل إجباري من نوع سلسلة نصية string.

مثال

ألقِ نظرة على المثال التالي لإضافة الوسم "test" إلى الشركة رقم "267" في مركز مساعدة "المناسب" له النطاق الفرعي al-munasib.zaetoon.com:

curl -X POST --header 'Authorization: Bearer your_token' --header 'Content-Type: application/json'  --data '{
"name": "test"
}' 'https://al-munasib.zaetoon.com/api/agent/v1/companies/267/tags'

حذف وسم من الشركة

أرسل طلب من نوع DELETE إلى نقطة الاتصال

{companies/{company_id}/tags/{tag_id/ إذا رغبت بحذف وسم من شركة معينة في مركز المساعدة.

يحتوي الطلب كل من الرقم التعريفي للشركة company_id، والرقم التعريفي للوسم tag_id كمتغيرات مسار ضمن عنوان URL للطلب.

مثال

لاحظ المثال التالي الذي يحذف الوسم "test" ذو رقم "901" من وسوم الشركة رقم "267" في مركز المساعدة التجريبي "المناسب":

curl -X DELETE --header 'Authorization: Bearer your_token' 'https://al-munasib.zaetoon.com/api/agent/v1/companies/267/tags/901'

علمًا أنك تستطيع الحصول على الأرقام التعريفية للوسوم بإرسال طلب GET إلى نقطة الاتصال tags/.