Create a Deal

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

Creates a deal, and can link it to contacts in the same request. Your API key needs the deal-create ability.

Header

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

Body

The body is a flat object of property values. Each key is the internal_name of a deal property, built in or yours, and each value must match that property's type. Read Properties for the types.

{
    deal_name: string,
    contact_ids?: string[],
    [internal_name: string]: any
}
Field Required Validation Description
deal_name Required Text of at least 3 characters The deal's name.
contact_ids Optional An array of contact IDs from your account The contacts to link to the deal.
Any other property Optional Must match the property's type Use the property's internal_name as the key.

Alaaqat sets _id itself. A request that sends it is rejected.

A single_select property such as deal_stage takes the internal_name of one of its options:

{
    "deal_name": "Annual support contract",
    "amount": 1200,
    "deal_stage": "appointment_scheduled",
    "contact_ids": [
        "6650f1a2b3c4d5e6f7a8b901"
    ]
}

To link contacts to an existing deal, use Attach or detach contacts.

Unique keys

Deals have no unique keys by default. If you make a deal property a unique key, a deal cannot take a value that another deal already holds for it: the deal is not created, and the request is refused with 422 with the error reported on that field.

Response

201 Created, with the new deal under data. The linked contacts are not part of the response.

{
    "data": {
        "properties": {
            "deal_name": "Annual support contract",
            "amount": 1200,
            "deal_stage": "appointment_scheduled",
            "created_by": 12,
            "updated_at": "2026-10-20T10:05:00.000000Z",
            "created_at": "2026-10-20T10:05:00.000000Z",
            "_id": "6651a0b1c2d3e4f5a6b7c801"
        }
    },
    "message": "Entity was created successfully."
}

Errors

Status Meaning
422 deal_name is missing or shorter than 3 characters, a contact ID is not in your account, a value does not match its property's type, or a unique key value is already taken.