Update a Contact Property

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

Where _id is the property's _id. Changes the name, description, group, options or unique key setting of a contact property. Your API key needs the contact-property-update ability.

Header

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

Body

{
    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
}
Field Required Validation Description
name Required An object with at least one language, each value text The property name, in en, ar or both.
desc Optional An object of languages, each value text or null A description, in en, ar or both.
group_id Required The _id of a contact property group, built in or yours The group the property is listed under.
enum Optional An array of options, each with an internal_name that is unique within the array The options of a single_select property. The list you send replaces the current one, so include every option you want to keep.
is_unique_key Optional true or false Turns the unique key on or off. Turning it on is refused while two or more contacts share a value for the property, see Unique keys. Turning it off is always accepted.

type and internal_name cannot be changed once the property exists. A request that sends either one is rejected with 422, so leave them out.

Adding a third option to a single_select property:

{
    "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"
        }
    ]
}

Built-in properties

You can also update a built-in contact property, such as email. Alaaqat saves your changes as your account's own copy of that property: the response carries the _id of the copy, and the property list shows the copy from then on. Later updates, sent to either _id, change the same copy.

A property with "system_only": true holds values that Alaaqat fills in itself. It cannot be updated, and the request is refused with 403.

Response

200 OK, with the updated property under 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."
}

Errors

Status Meaning
403 The property has "system_only": true.
422 A field failed validation. For example, type or internal_name was sent, the group does not exist, or is_unique_key is true while contacts already share a value.