Skip to main content
POST
/
objects
Create Custom Object
curl --request POST \
  --url https://services.leadconnectorhq.com/objects \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Version: <version>' \
  --data '
{
  "labels": {
    "singular": "Pet",
    "plural": "Pets"
  },
  "key": "custom_objects.pet",
  "locationId": "ve9EPM428h8vShlRW1KT",
  "primaryDisplayPropertyDetails": {
    "key": "custom_objects.pet.name",
    "name": "Pet name",
    "dataType": "TEXT"
  },
  "description": "These are non vaccinated pets"
}
'
{
  "object": {
    "id": "661c06b4ffde146bdb469442",
    "standard": false,
    "key": "custom_objects.pet",
    "labels": {
      "singular": "Pet",
      "plural": "Pets"
    },
    "locationId": "Q9DT3OAqEXDLYuob1G32",
    "primaryDisplayProperty": "custom_objects.pet.name",
    "dateAdded": "2023-11-07T05:31:56Z",
    "dateUpdated": "2023-11-07T05:31:56Z",
    "description": "These are non vaccinated pets",
    "type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
  }
}

Authorizations

Authorization
string
header
required

Use the Access Token generated with user type as Agency (OR) Private Integration Token of Agency.

Headers

Version
enum<string>
required

API Version

Available options:
2021-07-28

Body

application/json
labels
object
required
Example:
{ "singular": "Pet", "plural": "Pets" }
key
string
required

key that would be used to refer the Custom Object internally (lowercase + underscore_separated). 'custom_objects.' would be added as prefix by default

Example:

"custom_objects.pet"

locationId
string
required

Location Id

Example:

"ve9EPM428h8vShlRW1KT"

primaryDisplayPropertyDetails
object
required
description
string

Pet Object`s description

Example:

"These are non vaccinated pets"

Response

Successful response

object
object
Last modified on March 4, 2026