PUT https://app.alaaqat.com/api/companies/properties/{_id}
حيث _id هو قيمة _id للخاصية. تغيّر هذه النقطة اسم خاصية من خصائص الشركات أو وصفها أو مجموعتها أو خياراتها أو إعداد المفتاح الفريد فيها. يحتاج مفتاح واجهة التطبيق البرمجية إلى الإمكانية company-property-update، ويحتاج عضو الفريق الذي أنشأ المفتاح إلى صلاحية تعديل حقل مخصص.
{
"Accept": "application/json",
"Content-Type": "application/json"
}
{
name: {
en?: string,
ar?: string
},
desc?: {
en?: string,
ar?: string
},
group_id: string,
enum?: [
{
en?: string,
ar?: string,
internal_name: string
}
],
is_unique_key?: boolean
}
| الحقل | مطلوب | التحققات | الوصف |
|---|---|---|---|
| name | مطلوب | كائن يضم لغة واحدة على الأقل، وقيمة كل لغة نص | اسم الخاصية بالإنجليزية en أو بالعربية ar أو بكلتيهما. |
| desc | اختياري | كائن من اللغات، وقيمة كل لغة نص أو null |
وصف الخاصية بالإنجليزية أو بالعربية أو بكلتيهما. |
| group_id | مطلوب | قيمة _id لمجموعة من مجموعات خصائص الشركات، مدمجة أو من إنشائك |
المجموعة التي تظهر الخاصية ضمنها. |
| enum | اختياري | مصفوفة من الخيارات، لكل خيار internal_name لا يتكرر داخل المصفوفة |
خيارات الخاصية من نوع single_select. تحلّ القائمة المرسلة محل القائمة الحالية، فأرسل كل خيار تريد إبقاءه. |
| is_unique_key | اختياري | true أو false |
يفعّل المفتاح الفريد أو يلغيه. يُرفض التفعيل ما دام سجلان أو أكثر يتشاركان قيمة في الخاصية، راجع المفاتيح الفريدة. أما الإلغاء فيُقبل دائماً. |
لا يمكن تغيير type وinternal_name بعد إنشاء الخاصية، ويُرفض بالرمز 422 الطلب الذي يرسل أياً منهما، فلا ترسلهما.
إضافة خيار إلى خاصية من نوع single_select:
{
"name": {
"en": "Customer tier",
"ar": "فئة العميل"
},
"desc": {
"en": "Set by the sales team",
"ar": "يحدده فريق المبيعات"
},
"group_id": "6653c0d1e2f3a4b5c6d7e821",
"enum": [
{
"en": "Gold",
"ar": "ذهبية",
"internal_name": "gold"
},
{
"en": "Silver",
"ar": "فضية",
"internal_name": "silver"
},
{
"en": "Bronze",
"ar": "برونزية",
"internal_name": "bronze"
},
{
"en": "Platinum",
"ar": "بلاتينية",
"internal_name": "platinum"
}
]
}
يمكنك أيضاً تعديل خاصية مدمجة من خصائص الشركات. يحفظ نظام علاقات تعديلاتك نسخةً خاصة بحسابك من تلك الخاصية: تحمل الاستجابة قيمة _id للنسخة، وتظهر النسخة في قائمة الخصائص من ذلك الحين. والتعديلات اللاحقة، المرسلة إلى أيٍّ من القيمتين، تغيّر النسخة نفسها.
الخاصية التي تحمل "system_only": true يملأ نظام علاقات قيمها بنفسه، فلا يمكن تعديلها، ويُرفض الطلب بالرمز 403.
200 OK، وتأتي الخاصية بعد التعديل ضمن data.
{
"data": {
"_id": "6654d0e1f2a3b4c5d6e7f812",
"type": "single_select",
"name": {
"en": "Customer tier",
"ar": "فئة العميل"
},
"desc": {
"en": "Set by the sales team",
"ar": "يحدده فريق المبيعات"
},
"group_id": "6653c0d1e2f3a4b5c6d7e821",
"enum": [
{
"en": "Gold",
"ar": "ذهبية",
"internal_name": "gold"
},
{
"en": "Silver",
"ar": "فضية",
"internal_name": "silver"
},
{
"en": "Bronze",
"ar": "برونزية",
"internal_name": "bronze"
},
{
"en": "Platinum",
"ar": "بلاتينية",
"internal_name": "platinum"
}
],
"internal_name": "customer_tier",
"is_unique_key": false,
"account_id": 1024,
"made_by": 12,
"updated_at": "2026-10-21T08:40:12.000000Z",
"created_at": "2026-10-20T09:15:00.000000Z",
"user": {
"id": 12,
"email": "sara.haddad@example.com",
"firstname": "Sara",
"lastname": "Haddad",
"image": null,
"locale": "en",
"created_at": "2026-03-02T08:00:00.000000Z",
"updated_at": "2026-10-01T07:30:00.000000Z",
"fullname": "Sara Haddad"
},
"group": {
"_id": "6653c0d1e2f3a4b5c6d7e821",
"internal_name": "company_information",
"name": {
"en": "Company Information",
"ar": "معلومات الشركة"
},
"desc": [],
"account_id": null,
"made_by": null,
"updated_at": "2026-01-10T00:00:00.000000Z",
"created_at": "2026-01-10T00:00:00.000000Z"
}
},
"message": "Entity was modified successfully."
}
| الرمز | المعنى |
|---|---|
| 403 | الخاصية تحمل "system_only": true. |
| 422 | فشل أحد الحقول في التحقق. مثلاً: أُرسل type أو internal_name، أو المجموعة غير موجودة، أو is_unique_key يساوي true بينما تتشارك سجلات قيمة واحدة. |