إنشاء جهة اتصال

POST https://app.alaaqat.com/api/contacts

تُنشئ هذه النقطة جهة اتصال جديدة. يحتاج مفتاح واجهة التطبيق البرمجية إلى الإمكانية contact-create.

ترويسة الطلب

{
    "Accept": "application/json",
    "Content-Type": "application/json"
}

محتوى الطلب

محتوى الطلب كائن مسطّح من قيم الخصائص: كل مفتاح فيه هو internal_name لإحدى خصائص جهات الاتصال، مدمجة أو من إنشائك، ويجب أن تطابق كل قيمة نوع خاصيتها. راجع صفحة الخصائص لمعرفة الأنواع.

{
    firstname: string,
    lastname?: string,
    email?: string,
    phone?: string,
    [internal_name: string]: any
}
الحقل مطلوب التحققات الوصف
firstname مطلوب نص الاسم الأول لجهة الاتصال.
lastname اختياري نص اسم العائلة لجهة الاتصال.
email اختياري بريد إلكتروني صالح البريد الإلكتروني لجهة الاتصال، وهو مفتاح فريد افتراضياً.
phone اختياري نص رقم هاتف جهة الاتصال، وهو مفتاح فريد افتراضياً.
أي خاصية أخرى اختياري يطابق نوع الخاصية استخدم internal_name للخاصية مفتاحاً.

يضع نظام علاقات قيمة _id بنفسه، ويُرفض الطلب الذي يرسلها.

{
    "firstname": "Layla",
    "lastname": "Nasser",
    "email": "layla.nasser@example.com",
    "phone": "+962790000000",
    "membership_number": "LC-20417"
}

المفاتيح الفريدة

لا يمكن أن تأخذ جهة الاتصال قيمة تحملها جهة اتصال أخرى في خاصية تعمل مفتاحاً فريداً. الخصائص email وphone وwhatsapp_number مفاتيح فريدة لجهات الاتصال افتراضياً، ويمكنك أن تجعل خصائصك أنت مفاتيح فريدة أيضاً، راجع المفاتيح الفريدة.

إذا كانت القيمة مستخدمة مسبقاً، لا تُنشأ جهة الاتصال، ويُرفض الطلب بالرمز 422 مع خطأ على ذلك الحقل:

{
    "message": "The email has already been taken.",
    "errors": {
        "email": [
            "The email has already been taken."
        ]
    }
}

ابحث عن جهة الاتصال الموجودة عبر عرض جهات الاتصال، ثم حدّثها بدلاً من إنشاء جهة جديدة.

الإستجابة

201 Created، وتأتي جهة الاتصال الجديدة ضمن data.

{
    "data": {
        "properties": {
            "firstname": "Layla",
            "lastname": "Nasser",
            "email": "layla.nasser@example.com",
            "phone": "+962790000000",
            "membership_number": "LC-20417",
            "account_id": 1024,
            "created_by": 12,
            "updated_at": "2026-10-20T09:30:00.000000Z",
            "created_at": "2026-10-20T09:30:00.000000Z",
            "_id": "6650f1a2b3c4d5e6f7a8b901",
            "fullname": "Layla Nasser",
            "image": null
        },
        "channels": []
    },
    "message": "Entity was created successfully."
}

الأخطاء

الرمز المعنى
422 الحقل firstname غير موجود، أو قيمة لا تطابق نوع خاصيتها، أو قيمة مفتاح فريد مستخدمة مسبقاً.