Create a Company Property Group

POST https://app.alaaqat.com/api/companies/properties/groups

Creates a group to organise your company properties in. Your API key needs the company-property-group-create ability, and the team member who created the key needs Create Field Group.

Header

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

Body

{
    name: {
        en?: string,
        ar?: string
    },
    desc?: {
        en?: string,
        ar?: string
    }
}
Field Required Validation Description
name Required An object with at least one language, each value text The group name, in en, ar or both.
desc Optional An object of languages A description, in en, ar or both.

Alaaqat sets the group's internal_name from its name, and fills in account_id itself. A request that sends either one is rejected.

{
    "name": {
        "en": "Key account details",
        "ar": "تفاصيل الحسابات الرئيسية"
    },
    "desc": {
        "en": "Extra details we keep on our largest companies",
        "ar": "تفاصيل إضافية نحفظها عن أكبر شركات"
    }
}

Response

201 Created, with the new group under data. Use its _id as the group_id of the properties you create.

{
    "data": {
        "_id": "6654e0f1a2b3c4d5e6f7a901",
        "internal_name": "key_account_details",
        "name": {
            "en": "Key account details",
            "ar": "تفاصيل الحسابات الرئيسية"
        },
        "desc": {
            "en": "Extra details we keep on our largest companies",
            "ar": "تفاصيل إضافية نحفظها عن أكبر شركات"
        },
        "account_id": 1024,
        "made_by": 12,
        "updated_at": "2026-10-19T14:00:00.000000Z",
        "created_at": "2026-10-19T14:00: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"
        }
    },
    "message": "Entity was created successfully."
}