Create a Product

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

Creates a product. Your API key needs the product-create ability, and the team member who created the key needs Create Products.

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 product property, built in or yours, and each value must match that property's type. Read Properties for the types, and List Product Properties for the properties your account has. No property is required.

{
    name?: string,
    sku?: string,
    price?: number,
    cost?: number,
    status?: string,
    description?: string,
    owner?: number,
    communication_team?: number,
    association_ids?: {
        [object_type: string]: string[]
    },
    [internal_name: string]: any
}
Field Required Validation Description
name Optional Text The product's name.
sku Optional Text The stock keeping unit. A unique key by default.
price Optional A number The price you sell the product at.
cost Optional A number What the product costs you.
status Optional available or unavailable Whether the product can be sold.
description Optional Text A description of the product.
owner Optional The ID of a team member The team member who owns the product.
communication_team Optional The ID of a team The team the product belongs to.
association_ids Optional An object of record types, each with an array of IDs Links the new product to existing records. See Linking records on creation.
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, and so is one that sends a property with "system_only": true.

An image property, such as the product's image, takes an image file of up to 2 MB. To set one, send the request as multipart/form-data instead of JSON, with the file under the property's internal_name.

{
    "name": "Ergonomic office chair",
    "sku": "CH-ERGO-01",
    "price": 120,
    "cost": 74.5,
    "status": "available",
    "description": "Adjustable height and lumbar support, black mesh back.",
    "owner": 12
}

Unique keys

A product cannot take a value that another product already holds for a unique key property. For products, sku is a unique key by default, and you can make your own properties unique keys too, see Unique keys.

When a value is already taken, the product is not created. The request is refused with 422, and the error is reported on the field. Look the existing product up with List Products and update it instead.

Linking records on creation

association_ids links the new product to records you already have, in the same request. Each key is a record type, contact, company, deal, ticket, product or invoice, other than product, and each value is an array of _ids of that type. An ID that isn't a record of your account is skipped.

To link records later, see Associations.

Response

201 Created, with the new product under data.

{
    "data": {
        "properties": {
            "_id": "6656b1c2d3e4f5a6b7c8d901",
            "name": "Ergonomic office chair",
            "sku": "CH-ERGO-01",
            "price": 120,
            "cost": 74.5,
            "status": "available",
            "description": "Adjustable height and lumbar support, black mesh back.",
            "owner": 12,
            "created_by": 12,
            "updated_at": "2026-10-20T09:30:00.000000Z",
            "created_at": "2026-10-20T09:30:00.000000Z"
        },
        "account_id": 1024
    },
    "message": "Entity was created successfully."
}

Errors

Status Meaning
422 A value does not match its property's type, a field that Alaaqat sets was sent, or a unique key value is already taken.