تحديث خاصية لجهات الاتصال

PUT https://app.alaaqat.com/api/contacts/properties/{_id}

حيث _id هو معرّف الخاصية. تغيّر هذه النقطة اسم إحدى خصائص جهات الاتصال أو وصفها أو مجموعتها أو خياراتها أو إعداد المفتاح الفريد فيها. يحتاج مفتاح واجهة التطبيق البرمجية إلى الإمكانية contact-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": "Preferred branch",
        "ar": "الفرع المفضل"
    },
    "desc": {
        "en": "The branch the contact usually visits",
        "ar": "الفرع الذي تزوره جهة الاتصال عادةً"
    },
    "group_id": "6653c0d1e2f3a4b5c6d7e801",
    "enum": [
        {
            "en": "Downtown",
            "ar": "وسط البلد",
            "internal_name": "downtown"
        },
        {
            "en": "Airport Road",
            "ar": "طريق المطار",
            "internal_name": "airport_road"
        },
        {
            "en": "City Mall",
            "ar": "سيتي مول",
            "internal_name": "mall"
        }
    ]
}

الخصائص المدمجة

يمكنك كذلك تحديث إحدى خصائص جهات الاتصال المدمجة مثل email. يحفظ نظام علاقات تعديلاتك في نسخة خاصة بحسابك من تلك الخاصية: تحمل الاستجابة قيمة _id للنسخة، وتظهر النسخة في قائمة الخصائص من ذلك الحين. أي تحديث لاحق، سواء أرسلته إلى المعرّف الأصلي أم إلى معرّف النسخة، يعدّل النسخة نفسها.

الخاصية التي تحمل "system_only": true يملأ نظام علاقات قيمها بنفسه، فلا يمكن تحديثها، ويُرفض الطلب بالرمز 403.

الإستجابة

200 OK، وتأتي الخاصية المحدّثة ضمن data.

{
    "data": {
        "_id": "6654d0e1f2a3b4c5d6e7f802",
        "type": "single_select",
        "name": {
            "en": "Preferred branch",
            "ar": "الفرع المفضل"
        },
        "desc": {
            "en": "The branch the contact usually visits",
            "ar": "الفرع الذي تزوره جهة الاتصال عادةً"
        },
        "internal_name": "preferred_branch",
        "group_id": "6653c0d1e2f3a4b5c6d7e801",
        "enum": [
            {
                "en": "Downtown",
                "ar": "وسط البلد",
                "internal_name": "downtown"
            },
            {
                "en": "Airport Road",
                "ar": "طريق المطار",
                "internal_name": "airport_road"
            },
            {
                "en": "City Mall",
                "ar": "سيتي مول",
                "internal_name": "mall"
            }
        ],
        "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": "6653c0d1e2f3a4b5c6d7e801",
            "internal_name": "contact_information",
            "name": {
                "en": "Contact 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 بينما تشترك جهات الاتصال في قيمة واحدة.