Creates a new record for a custom CRM object.
Pass attribute values as a flat object using attribute slugs as keys.
Required scope: crm:write
curl --request POST \
--url https://api.zeeg.me/v2/crm/{objectSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sku": "DRESS-001",
"price": 29,
"inventory_count": 150
}
'{
"success": true,
"status": 201,
"record": {
"id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
"objectSlug": "products",
"attributes": {
"sku": "DRESS-001",
"price": 29,
"inventory_count": 150
},
"createdAt": "2025-06-01T10:00:00+00:00",
"updatedAt": "2025-06-01T12:00:00+00:00"
}
}Creates a new record for a custom CRM object and returns it with a generated UUID.Documentation Index
Fetch the complete documentation index at: https://developer.zeeg.me/llms.txt
Use this file to discover all available pages before exploring further.
| Parameter | Type | Description |
|---|---|---|
objectSlug | string | The slug of the custom CRM object to create a record in (e.g. products, deals). The object must exist. |
null.
{
"sku": "DRESS-001",
"price": 29,
"inventory_count": 150,
"in_stock": true,
"launched_at": "2025-06-01",
"category": { "id": "opt_abc123" }
}
GET /v2/crm/objects/{slug} to discover the available attribute slugs and their types before writing records.
400 error.
| Type | Expected value | Example |
|---|---|---|
text | String, max 255 characters | "DRESS-001" |
number | Integer | 29 |
checkbox | Boolean | true or false |
date | ISO 8601 date string | "2025-06-01" |
select | Object with an id key matching a valid option ID | { "id": "opt_abc123" } |
multiselect | Array of objects, each with an id key | [{ "id": "opt_abc" }, { "id": "opt_def" }] |
relation | Array of record UUIDs from the related object | ["c1d2e3f4-...", "a2b3c4d5-..."] |
user | Array of organization member UUIDs | ["member-uuid-1"] |
select and multiselect attributes are returned when you fetch the object schema via GET /v2/crm/objects/{slug}.
isUnique, submitting a value that already exists on another record returns a 400 error. Check for uniqueness constraints in the object schema before creating records in bulk.
{}
Slug of the custom CRM object.
Flat object of attribute slug → value pairs.
Created
true
201
A record for a custom CRM object.
Hide child attributes
Unique identifier for the record.
"c1d2e3f4-a5b6-7890-cdef-123456789012"
Slug of the CRM object this record belongs to.
"products"
Key/value pairs for the custom attributes defined on the object. Keys are attribute slugs.
{
"sku": "DRESS-001",
"price": 29,
"inventory_count": 150
}ISO 8601 timestamp when the record was created.
"2025-06-01T10:00:00+00:00"
ISO 8601 timestamp when the record was last updated.
"2025-06-01T12:00:00+00:00"
curl --request POST \
--url https://api.zeeg.me/v2/crm/{objectSlug} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"sku": "DRESS-001",
"price": 29,
"inventory_count": 150
}
'{
"success": true,
"status": 201,
"record": {
"id": "c1d2e3f4-a5b6-7890-cdef-123456789012",
"objectSlug": "products",
"attributes": {
"sku": "DRESS-001",
"price": 29,
"inventory_count": 150
},
"createdAt": "2025-06-01T10:00:00+00:00",
"updatedAt": "2025-06-01T12:00:00+00:00"
}
}