تعديل إعدادات شركة

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

تعديل إعدادات شركة

يمكنك تعديل إعدادات أي شركة في مركز المساعدة باستخدام نقطة الاتصال companies/ وفق التالي:

• عنوان URL لنقطة الاتصال:
  https://{your_subdomain}/api/agent/v1/companies.
• نوع الطلب: PUT.
• متغيرات المسار Path Parameters: متغير واحد هو "id" الرقم التعريفي للشركة المطلوب تعديلها، وهو مُعامِل إجباري من نوع عدد صحيح integer.
• جسم الطلب Body: يُكتب بصيغة JSON ويتضمن المعاملات التالية:
• • name: معامل إجباري، نوعه سلسلة نصية string، يُحَدِّد اسم الشركة.
  • logo: نوعه سلسلة نصية string، يُحَدِّد شعار الشركة إذ تُمَرِّر ضمنه ترميز base64 لصورة الشعار.
  • status: معامل إجباري، نوعه سلسلة نصية string، يُحَدِّد حالة الشركة ويقبل حصرًا إحدى القيم التالية:
  • • active فعَّالة.
    • inactive غير فعَّالة.
    • banned محظورة.
    • deleted محذوفة.
  • tags: نوعه مصفوفة من السلاسل النصية array، يساعدك على تعديل الوسوم الخاصة بالشركة.
  • fields:نوعه مصفوفة array، وهو خاص بتعديل الروابط URLs لمواقع الويب المتعلقة بالشركة، تتألف المصفوفة fields من عدة عناصر objects، يمثل كل عنصر منها رابط معين ويتضمن ما يلي:
  • • key اسم الرابط.
    • value الرابط.
    • type نوع الحقل وهو دائمًا "url".
  • numbers: نوعه مصفوفة من العناصر array، يمثل كل عنصر object منها رقم جوال خاص بالشركة مكون من جزأين: رمز الدولة country_code والرقم number ويساعدك على تعديل أرقام الجوال الخاصة بالشركة أو الإضافة عليها.
  • emails: نوعه مصفوفة من السلاسل النصية array، خاص بتعديل عناوين البريد الإلكتروني للشركة.
  • custom_fields: نوعه عنصر object مركب من عدة عناصر، يمثل كل عنصر أحد الحقول المخصصة الخاصة بتعريف الشركات (في حال استخدامك لها) ويساعدك على تعديل قيمها سواء كانت نصوص أو ملفات أو صناديق تأشير (يمكنك الرجوع لأمثلتها الموجودة في الفقرة السابقة).
  • assign_to: نوعه عدد صحيح integer، تُمَرِر ضمنه الرقم التعريفي id للمستخدم أو موظف مركز المساعدة الذي تود إسناد الشركة إليه.
  • segment_ids: نوعه مصفوفة array، تُكتب ضمنه الأرقام التعريفية للفئات segments التي ترغب بإضافة الشركة إليها.

مثال

يبين المثال التالي إجراء التعديلات التالية على الشركة رقم "272" في مركز مساعدة "المناسب":

1. إضافة وسم جديد إلى وسوم الشركة هو "it".
2. إضافة عنوان بريد إلكتروني جديد إلى عناوين البريد الإلكتروني للشركة.
3. إضافة رابط Linkedin للشركة.

curl -X PUT --header 'Authorization: Bearer your_token' 'Content-Type: application/json' --data '{
"name": "company_name",
"status": "active",
"tags": ["new","it"],
"fields": [
    {
    "key": "linkedin",
    "value": "https://www.linkedin.com/exampel/",
    "type": "url"
    }
],
"emails":["info@exampel.com", "new-info@exampel.com"]
}' 'https://al-munasib.zaetoon.com/api/agent/v1/companies/272'