Create Custom Object

Allows you to create a custom object schema. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

POST https://services.leadconnectorhq.com/objects/

Autorización

string

required

Bearer token generado desde el portal Leadway. Ver Autenticación.

string

default:"2021-07-28"

required

Versión de la API.

Body

object

required

This is what your custom object will be called. These labels will be used to display your custom object on the UI

string

default:"custom_objects.pet"

required

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

string

default:"These are non vaccinated pets"

Pet Object`s description

string

default:"ve9EPM428h8vShlRW1KT"

required

Account Id

object

required

Primary property which will be displayed on the record page

Respuestas

201 - Successful response

object

Show propiedades

string

default:"661c06b4ffde146bdb469442"

required

id of the custom / standard object schema

boolean

default:"False"

required

false in case of custom objects and true in case of standard objects like contacts and opportunities

string

default:"custom_objects.pet"

required

key that would be used to refer the custom / standard Object internally (lowercase + underscore_separated). For custom objects, ‘custom_objects.’ would be added as prefix by default

object

required

This is what your custom / standard object will be called. These labels will be used to display your custom object on the UI

string

default:"These are non vaccinated pets"

Custom / Standard Object Descriptions for example , Pet Object`s description

string

default:"Q9DT3OAqEXDLYuob1G32"

required

account’s id

string

default:"custom_objects.pet.name"

required

Primary property for the custom / standard Object. This would be used as primary data when rendering the UI. ‘custom_objects.{{object_key}} or business.{{object_key}} (for company)’ would be added as prefix by default for all the custom / standard objects

string

required

Date and time when the object was added

string

required

Date and time when the object was last updated

object

Object`s Type

{
  "object": {
    "id": "661c06b4ffde146bdb469442",
    "standard": false,
    "key": "custom_objects.pet",
    "labels": {
      "singular": "Pet",
      "plural": "Pets"
    },
    "description": "These are non vaccinated pets",
    "locationId": "Q9DT3OAqEXDLYuob1G32",
    "primaryDisplayProperty": "custom_objects.pet.name",
    "dateAdded": "2024-01-15T10:30:00Z",
    "dateUpdated": "2024-01-15T10:30:00Z",
    "type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
  }
}

400 - Bad Request

{}

401 - Unauthorized

{}

422 - Unprocessable Entity

{}

Ejemplo

curl -X POST 'https://services.leadconnectorhq.com/objects/' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Version: 2021-07-28' \
  -H 'Content-Type: application/json' \
  -d '{
  "labels": {
    "singular": "Pet",
    "plural": "Pets"
  },
  "key": "custom_objects.pet",
  "description": "These are non vaccinated pets",
  "locationId": "ve9EPM428h8vShlRW1KT"
}'

const response = await fetch('https://services.leadconnectorhq.com/objects/', {
  method: 'POST',
  headers: {
    Authorization: `Bearer ${process.env.LEADWAY_TOKEN}`,
    Version: '2021-07-28',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"labels": {"singular": "Pet", "plural": "Pets"}, "key": "custom_objects.pet", "description": "These are non vaccinated pets", "locationId": "ve9EPM428h8vShlRW1KT"}),
});
const data = await response.json();

import os, requests
response = requests.request(
    'POST',
    'https://services.leadconnectorhq.com/objects/',
    headers={
        'Authorization': f"Bearer {os.environ['LEADWAY_TOKEN']}",
        'Version': '2021-07-28',
        'Content-Type': 'application/json',
    },
    json={"labels": {"singular": "Pet", "plural": "Pets"}, "key": "custom_objects.pet", "description": "These are non vaccinated pets", "locationId": "ve9EPM428h8vShlRW1KT"},
)
data = response.json()

<?php
$ch = curl_init('https://services.leadconnectorhq.com/objects/');
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_CUSTOMREQUEST => 'POST',
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('LEADWAY_TOKEN'),
        'Version: 2021-07-28',
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => json_encode({'labels': {'singular': 'Pet', 'plural': 'Pets'}, 'key': 'custom_objects.pet', 'description': 'These are non vaccinated pets', 'locationId': 've9EPM428h8vShlRW1KT'}),
]);
$data = json_decode(curl_exec($ch), true);

Empezar

Scopes

Autorización

Body

Respuestas

Ejemplo

​Autorización

​Body

​Respuestas

​Ejemplo

Autorización

Body

Respuestas

Ejemplo