Skip to main content
POST
/
crm
/
objects
Create a custom CRM object
curl --request POST \
  --url https://api.zeeg.me/v2/crm/objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "products",
  "singularName": "Product",
  "pluralName": "Products",
  "isActive": true
}
'
import requests

url = "https://api.zeeg.me/v2/crm/objects"

payload = {
"slug": "products",
"singularName": "Product",
"pluralName": "Products",
"isActive": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
slug: 'products',
singularName: 'Product',
pluralName: 'Products',
isActive: true
})
};

fetch('https://api.zeeg.me/v2/crm/objects', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zeeg.me/v2/crm/objects",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'slug' => 'products',
'singularName' => 'Product',
'pluralName' => 'Products',
'isActive' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://api.zeeg.me/v2/crm/objects"

payload := strings.NewReader("{\n \"slug\": \"products\",\n \"singularName\": \"Product\",\n \"pluralName\": \"Products\",\n \"isActive\": true\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.zeeg.me/v2/crm/objects")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"slug\": \"products\",\n \"singularName\": \"Product\",\n \"pluralName\": \"Products\",\n \"isActive\": true\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.zeeg.me/v2/crm/objects")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"slug\": \"products\",\n \"singularName\": \"Product\",\n \"pluralName\": \"Products\",\n \"isActive\": true\n}"

response = http.request(request)
puts response.read_body
{
  "success": true,
  "status": 201,
  "object": {
    "slug": "products",
    "singularName": "Product",
    "pluralName": "Products",
    "isStandard": false,
    "isActive": true,
    "attributes": [
      {
        "key": "id",
        "label": "ID",
        "type": "text",
        "isRequired": true,
        "isStandard": true
      },
      {
        "key": "created_at",
        "label": "Created At",
        "type": "datetime",
        "isRequired": true,
        "isStandard": true
      },
      {
        "key": "updated_at",
        "label": "Updated At",
        "type": "datetime",
        "isRequired": false,
        "isStandard": true
      }
    ],
    "createdAt": "2025-06-01T10:00:00+00:00",
    "updatedAt": "2025-06-01T10:00:00+00:00"
  }
}
{
"success": false,
"message": "Slug already exists or forbidden.",
"status": 400
}
{
"message": "Unauthenticated."
}
{
"success": true,
"message": "<string>",
"status": 123
}
{
"message": "The given data was invalid.",
"errors": {
"field_name": [
"The field_name field is required."
]
}
}

Slug rules

  • 3–60 characters, lowercase letters, numbers, hyphens, and underscores only
  • Must be unique within your workspace
  • Immutable after creation — the slug cannot be renamed
The slugs people and companies are reserved for standard objects and cannot be used.

Auto-created attributes

Every new object automatically receives three system attributes that cannot be removed:
KeyTypeDescription
idtextUnique record identifier (UUID)
created_atdatetimeRecord creation timestamp
updated_atdatetimeLast modification timestamp
Add custom attributes to the object using POST /crm/objects/{slug}/attributes after creation.

Authorizations

Authorization
string
header
required

Body

application/json
slug
string
required

Unique identifier for the object. Must be 3–60 characters, alphanumeric with dots or hyphens. Cannot use reserved slugs (people, companies, etc.).

Required string length: 3 - 60
Pattern: ^(?=.{1,60}$)[\w]+((\.|-)[\w]+)*$
Example:

"products"

singularName
string
required

Singular display name shown in the UI.

Maximum string length: 255
Example:

"Product"

pluralName
string
required

Plural display name shown in the UI.

Maximum string length: 255
Example:

"Products"

isActive
boolean
default:true

Whether the object is enabled. Defaults to true.

Response

Created

success
boolean
Example:

true

status
integer
Example:

201

object
object

A CRM object definition including its full attribute schema.

Last modified on June 11, 2026