Skip to content

Objects.md

Latest commit

 

History

History
1786 lines (1153 loc) · 35.8 KB

Objects.md

File metadata and controls

1786 lines (1153 loc) · 35.8 KB

Objects API

Source: HighLevel API 2.0 Documentation Crawled: 2026-03-25

Table of Contents

Create Object Record

Source: https://marketplace.gohighlevel.com/docs/ghl/objects/create-object-record/index.html

Skip to main content

Create Record

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

Create a Custom Object Record. Supported Objects business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

Requirements

Scope(s)

objects/record.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

Example: custom_objects.pet or business.email (for company's email)

  • application/json

Body required

object

Responses ​

  • 201
  • 400
  • 401

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

record object

id stringrequired

id of the record

Example:661c06b4ffde146bdb469442

owner string[]required

Owner (User's id). Limited to 1 for now. Only Supported with custom objects

Example:["sx6wyHhbFdRXh302Lunr"]

followers string[]required

Follower (User's ids). Limited to 10 for now

Example:["sx6wyHhbFdRXh302Lunr","v5cEPM428h8vShlRW1KT"]

properties stringrequired

Properties of the record

Example:{"customer_number":1424,"ticket_name":"Customer not able login","phone_number":"+917000000000","money":{"currency":"default","value":100},"type_of_ticket":"doubt","section_of_app":["contacts","smartlist"],"recieved_on":"2024-07-11","my_files":[{"url":"---url_of_file---"}],"my_textbox_list.option_a":"Value 1","my_textbox_list.option_b":"Value 2"}

dateAdded date-timerequired

Date and time when the object was added

dateUpdated date-timerequired

Date and time when the object was last updated

{
  "record": {
    "id": "661c06b4ffde146bdb469442",
    "owner": [\
      "sx6wyHhbFdRXh302Lunr"\
    ],
    "followers": [\
      "sx6wyHhbFdRXh302Lunr",\
      "v5cEPM428h8vShlRW1KT"\
    ],
    "properties": {
      "customer_number": 1424,
      "ticket_name": "Customer not able login",
      "phone_number": "+917000000000",
      "money": {
        "currency": "default",
        "value": 100
      },
      "type_of_ticket": "doubt",
      "section_of_app": [\
        "contacts",\
        "smartlist"\
      ],
      "recieved_on": "2024-07-11",
      "my_files": [\
        {\
          "url": "---url_of_file---"\
        }\
      ],
      "my_textbox_list.option_a": "Value 1",
      "my_textbox_list.option_b": "Value 2"
    },
    "dateAdded": "2024-07-29T15:51:28.071Z",
    "dateUpdated": "2024-07-29T15:51:28.071Z"
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: objects/record.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/objects/:schemaKey/records' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

schemaKey — pathrequired

Version — headerrequired

---2021-07-28

Body required

{}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Delete Object Record

Source: https://marketplace.gohighlevel.com/docs/ghl/objects/delete-object-record/index.html

Skip to main content

Delete Record

DELETE https://services.leadconnectorhq.com/objects/:schemaKey/records/:id

Delete Record By Id . Supported Objects are business and custom objects.

Requirements

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

Example: custom_objects.pet or business.email (for company's email)

id stringrequired

id of the record to be updated. Available on the Record details page under the 3 dots or in the url

Example: 632c34b4c9b7da3358ac9891

Responses ​

  • 200
  • 400
  • 401

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

id string

id of the deleted object

Example:661c06b4ffde146bdb469442

success boolean

boolean that defines if the operation was a success or not

Example:true

{
  "id": "661c06b4ffde146bdb469442",
  "success": true
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Authorization: Authorization

name: Authorizationtype: httpscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X DELETE 'https://services.leadconnectorhq.com/objects/:schemaKey/records/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

schemaKey — pathrequired

id — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Object Schema By Key

Source: https://marketplace.gohighlevel.com/docs/ghl/objects/get-object-schema-by-key/index.html

Skip to main content

Get Object Schema by key / id

GET https://services.leadconnectorhq.com/objects/:key

Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Requirements

Scope(s)

objects/schema.readonly

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

key stringrequired

key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI.

Example: custom_objects.pet

Query Parameters

locationId stringrequired

location id of the sub account

Example: 632c34b4c9b7da3358ac9891

fetchProperties string

Fetch Properties , Fetches all the standard / custom fields of the object when set to true

Example:

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

object object

id stringrequired

id of the custom / standard object schema

Example:661c06b4ffde146bdb469442

standard booleanrequired

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

Example:false

key stringrequired

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

Example:custom_objects.pet

labels object

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

singular stringrequired

Singular name of the custom object

Example:Pet

plural stringrequired

Plural name of the custom object

Example:Pets

description string

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

Example:These are non vaccinated pets

locationId stringrequired

location's id

Example:Q9DT3OAqEXDLYuob1G32

primaryDisplayProperty stringrequired

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

Example:custom_objects.pet.name

dateAdded date-timerequired

Date and time when the object was added

dateUpdated date-timerequired

Date and time when the object was last updated

type object

Object`s Type

Example:The Object type can either USER_DEFINED or SYSTEM_DEFINED

cache booleanrequired

Is the response served from cache

Example:true

fields object[]

Array [

locationId stringrequired

Location Id

Example:ve9EPM428h8vShlRW1KT

name string

Field name

Example:Name

description string

Description of the field

placeholder string

Placeholder text for the field

showInForms booleanrequired

Whether the field should be shown in forms

options object[]

Options for the field (Optional, valid only for SINGLE_OPTIONS, MULTIPLE_OPTIONS, RADIO, CHECKBOX, TEXTBOX_LIST type)

Array [

key stringrequired

Key of the option (Included in Create and Response, excluded in Update)

label stringrequired

Value of the option

url string

URL associated with the option (Optional, valid only for RADIO type)

]

acceptedFormats string

Allowed file formats for uploads. Options include: .pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all

Possible values: [.pdf, .docx, .doc, .jpg, .jpeg, .png, .gif, .csv, .xlsx, .xls, all]

id stringrequired

Unique identifier of the object

objectKey stringrequired

The key for your custom / standard object. This key uniquely identifies the custom object. Example: "custom_object.pet" for a custom object related to pets.

Example:custom_object.pet

dataType stringrequired

Type of field that you are trying to create

Possible values: [TEXT, LARGE_TEXT, NUMERICAL, PHONE, MONETORY, CHECKBOX, SINGLE_OPTIONS, MULTIPLE_OPTIONS, DATE, TEXTBOX_LIST, FILE_UPLOAD, RADIO]

parentId stringrequired

ID of the parent folder

Example:3v34PM428h8vShlRW1KT

fieldKey stringrequired

Field key. For Custom Object it's formatted as "custom_object.{objectKey}.{fieldKey}". "custom_object" is a fixed prefix, "{objectKey}" is your custom object's identifier, and "{fieldName}" is the unique field name within that object. Example: "custom_object.pet.name" for a "name" field in a "pet" custom object.

Example:custom_object.pet.name

allowCustomOption boolean

Determines if users can add a custom option value different from the predefined options in records for RADIO type fields. A custom value added in one record does not automatically become an option and will not appear as an option for other records.

Example:true

maxFileLimit number

Maximum file limit for uploads

Example:2

dateAdded date-timerequired

Date and time when the object was added

dateUpdated date-timerequired

Date and time when the object was last updated

]

{
  "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-07-29T15:51:28.071Z",
    "dateUpdated": "2024-07-29T15:51:28.071Z",
    "type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
  },
  "cache": true,
  "fields": [\
    {\
      "locationId": "ve9EPM428h8vShlRW1KT",\
      "name": "Name",\
      "description": "string",\
      "placeholder": "string",\
      "showInForms": true,\
      "options": [\
        {\
          "key": "string",\
          "label": "string",\
          "url": "string"\
        }\
      ],\
      "acceptedFormats": ".pdf",\
      "id": "string",\
      "objectKey": "custom_object.pet",\
      "dataType": "TEXT",\
      "parentId": "3v34PM428h8vShlRW1KT",\
      "fieldKey": "custom_object.pet.name",\
      "allowCustomOption": true,\
      "maxFileLimit": 2,\
      "dateAdded": "2024-07-29T15:51:28.071Z",\
      "dateUpdated": "2024-07-29T15:51:28.071Z"\
    }\
  ]
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: objects/schema.readonlyscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/objects/:key' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

key — pathrequired

locationId — queryrequired

Version — headerrequired

---2021-07-28

Show optional parameters

fetchProperties — query

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Get Record By Id

Source: https://marketplace.gohighlevel.com/docs/ghl/objects/get-record-by-id/index.html

Skip to main content

Get Record By Id

GET https://services.leadconnectorhq.com/objects/:schemaKey/records/:id

Allows you to get a Standard Object like business and custom object record by Id

Requirements

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

Example: custom_objects.pet or business.email (for company's email)

id stringrequired

id of the record to be updated. Available on the Record details page under the 3 dots or in the url

Example: 632c34b4c9b7da3358ac9891

Responses ​

  • 200
  • 400
  • 401

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

record object

id stringrequired

id of the record

Example:661c06b4ffde146bdb469442

owner string[]required

Owner (User's id). Limited to 1 for now. Only Supported with custom objects

Example:["sx6wyHhbFdRXh302Lunr"]

followers string[]required

Follower (User's ids). Limited to 10 for now

Example:["sx6wyHhbFdRXh302Lunr","v5cEPM428h8vShlRW1KT"]

properties stringrequired

Properties of the record

Example:{"customer_number":1424,"ticket_name":"Customer not able login","phone_number":"+917000000000","money":{"currency":"default","value":100},"type_of_ticket":"doubt","section_of_app":["contacts","smartlist"],"recieved_on":"2024-07-11","my_files":[{"url":"---url_of_file---"}],"my_textbox_list.option_a":"Value 1","my_textbox_list.option_b":"Value 2"}

dateAdded date-timerequired

Date and time when the object was added

dateUpdated date-timerequired

Date and time when the object was last updated

{
  "record": {
    "id": "661c06b4ffde146bdb469442",
    "owner": [\
      "sx6wyHhbFdRXh302Lunr"\
    ],
    "followers": [\
      "sx6wyHhbFdRXh302Lunr",\
      "v5cEPM428h8vShlRW1KT"\
    ],
    "properties": {
      "customer_number": 1424,
      "ticket_name": "Customer not able login",
      "phone_number": "+917000000000",
      "money": {
        "currency": "default",
        "value": 100
      },
      "type_of_ticket": "doubt",
      "section_of_app": [\
        "contacts",\
        "smartlist"\
      ],
      "recieved_on": "2024-07-11",
      "my_files": [\
        {\
          "url": "---url_of_file---"\
        }\
      ],
      "my_textbox_list.option_a": "Value 1",
      "my_textbox_list.option_b": "Value 2"
    },
    "dateAdded": "2024-07-29T15:51:28.071Z",
    "dateUpdated": "2024-07-29T15:51:28.071Z"
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Authorization: Authorization

name: Authorizationtype: httpscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L 'https://services.leadconnectorhq.com/objects/:schemaKey/records/:id' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

schemaKey — pathrequired

id — pathrequired

Version — headerrequired

---2021-07-28

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Object Schema

Source: https://marketplace.gohighlevel.com/docs/ghl/objects/object-schema/index.html

Skip to main content

Custom objects are completely customizable objects that allow you to store and manage information tailored to your unique business needs. With custom objects, you can create custom fields, establish relationships, and integrate them into workflows, providing flexibility beyond standard objects like Contacts, Opportunities or Companies.

📄️ Get Object Schema by key / id \ Retrieve Object Schema by key or ID. This will return the schema of the custom object, including all its fields and properties. Supported objects include contact, opportunity, business and custom objects.To understand objects and records, please have a look the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0📄️ Update Object Schema By Key / Id \ Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0📄️ Get all objects for a location \ Get all objects for a location. Supported Objects are contact, opportunity, business and custom objects.To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0📄️ 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

Update Custom Object

Source: https://marketplace.gohighlevel.com/docs/ghl/objects/update-custom-object/index.html

Skip to main content

Update Object Schema By Key / Id

PUT https://services.leadconnectorhq.com/objects/:key

Update Custom Object Schema or standard object's like contact, opportunity, business searchable fields. To understand objects and records, please have a look at the documentation here : https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0

Requirements

Scope(s)

objects/schema.write

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

key stringrequired

key of the custom or standard object. For custom objects, the key must include the prefix “custom_objects.”. This key can be found on the Object Details page under Settings in the UI.

Example: custom_objects.pet

  • application/json

Body required

labels object

This is how your custom object will be displayed

singular string

Singular name of the custom object

Example:Car

plural string

Plural name of the custom object

Example:Cars

description stringnullable

Pet Object`s description

Example:These are non vaccinated pets

locationId stringrequired

location id

Example:632c34b4c9b7da3358ac9891

searchableProperties string[]required

Searchable Fields: Provide the field key of your object that you want to search on, using the format (custom_object.<object_name>.<field_key>).

Example:["custom_objects.mad.mad","custom_objects.mad.record_1","custom_objects.mad.nn"]

Responses ​

  • 200
  • 400
  • 401
  • 422

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

object object

id stringrequired

id of the custom / standard object schema

Example:661c06b4ffde146bdb469442

standard booleanrequired

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

Example:false

key stringrequired

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

Example:custom_objects.pet

labels object

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

singular stringrequired

Singular name of the custom object

Example:Pet

plural stringrequired

Plural name of the custom object

Example:Pets

description string

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

Example:These are non vaccinated pets

locationId stringrequired

location's id

Example:Q9DT3OAqEXDLYuob1G32

primaryDisplayProperty stringrequired

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

Example:custom_objects.pet.name

dateAdded date-timerequired

Date and time when the object was added

dateUpdated date-timerequired

Date and time when the object was last updated

type object

Object`s Type

Example:The Object type can either USER_DEFINED or SYSTEM_DEFINED

{
  "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-07-29T15:51:28.071Z",
    "dateUpdated": "2024-07-29T15:51:28.071Z",
    "type": "The Object type can either USER_DEFINED or SYSTEM_DEFINED"
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Unprocessable Entity

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:422

message string[]

Example:["Unprocessable Entity"]

error string

Example:Unprocessable Entity

{
  "statusCode": 422,
  "message": [\
    "Unprocessable Entity"\
  ],
  "error": "Unprocessable Entity"
}

Authorization: Authorization

name: Authorizationtype: httpscopes: objects/schema.writescheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X PUT 'https://services.leadconnectorhq.com/objects/:key' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
  "labels": {
    "singular": "Pet",
    "plural": "Pets"
  },
  "description": "These are non vaccinated pets",
  "locationId": "632c34b4c9b7da3358ac9891",
  "searchableProperties": [\
    "custom_objects.mad.mad",\
    "custom_objects.mad.record_1",\
    "custom_objects.mad.nn"\
  ]
}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

key — pathrequired

Version — headerrequired

---2021-07-28

Body required

{
  "labels": {
    "singular": "Pet",
    "plural": "Pets"
  },
  "description": "These are non vaccinated pets",
  "locationId": "632c34b4c9b7da3358ac9891",
  "searchableProperties": [\
    "custom_objects.mad.mad",\
    "custom_objects.mad.record_1",\
    "custom_objects.mad.nn"\
  ]
}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!

Update Object Record

Source: https://marketplace.gohighlevel.com/docs/ghl/objects/update-object-record/index.html

Skip to main content

Update Record

PUT https://services.leadconnectorhq.com/objects/:schemaKey/records/:id

Update a Custom Object Record by Id. Supported Objects are business and custom objects. Documentation Link - https://doc.clickup.com/8631005/d/h/87cpx-277156/93bf0c2e23177b0/87cpx-376296

Requirements

Auth Method(s)

OAuth Access Token``Private Integration Token

Token Type(s)

Sub-Account Token

Request ​

Header Parameters

Version stringrequired

Possible values: [2021-07-28]

API Version

Path Parameters

schemaKey stringrequired

The key of the Custom Object / Standard Object Schema. For custom objects, the key must include the “custom_objects.” prefix, while standard objects use their respective object keys. This information is available on the Custom Objects Details page under Settings.

Example: custom_objects.pet or business.email (for company's email)

id stringrequired

id of the record to be updated. Available on the Record details page under the 3 dots or in the url

Example: 632c34b4c9b7da3358ac9891

Query Parameters

locationId stringrequired

  • application/json

Body required

object

Responses ​

  • 200
  • 400
  • 401

Successful response

  • application/json

  • Schema

  • Example (auto)

Schema

record object

id stringrequired

id of the record

Example:661c06b4ffde146bdb469442

owner string[]required

Owner (User's id). Limited to 1 for now. Only Supported with custom objects

Example:["sx6wyHhbFdRXh302Lunr"]

followers string[]required

Follower (User's ids). Limited to 10 for now

Example:["sx6wyHhbFdRXh302Lunr","v5cEPM428h8vShlRW1KT"]

properties stringrequired

Properties of the record

Example:{"customer_number":1424,"ticket_name":"Customer not able login","phone_number":"+917000000000","money":{"currency":"default","value":100},"type_of_ticket":"doubt","section_of_app":["contacts","smartlist"],"recieved_on":"2024-07-11","my_files":[{"url":"---url_of_file---"}],"my_textbox_list.option_a":"Value 1","my_textbox_list.option_b":"Value 2"}

dateAdded date-timerequired

Date and time when the object was added

dateUpdated date-timerequired

Date and time when the object was last updated

{
  "record": {
    "id": "661c06b4ffde146bdb469442",
    "owner": [\
      "sx6wyHhbFdRXh302Lunr"\
    ],
    "followers": [\
      "sx6wyHhbFdRXh302Lunr",\
      "v5cEPM428h8vShlRW1KT"\
    ],
    "properties": {
      "customer_number": 1424,
      "ticket_name": "Customer not able login",
      "phone_number": "+917000000000",
      "money": {
        "currency": "default",
        "value": 100
      },
      "type_of_ticket": "doubt",
      "section_of_app": [\
        "contacts",\
        "smartlist"\
      ],
      "recieved_on": "2024-07-11",
      "my_files": [\
        {\
          "url": "---url_of_file---"\
        }\
      ],
      "my_textbox_list.option_a": "Value 1",
      "my_textbox_list.option_b": "Value 2"
    },
    "dateAdded": "2024-07-29T15:51:28.071Z",
    "dateUpdated": "2024-07-29T15:51:28.071Z"
  }
}

Bad Request

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:400

message string

Example:Bad Request

{
  "statusCode": 400,
  "message": "Bad Request"
}

Unauthorized

  • application/json

  • Schema

  • Example (auto)

Schema

statusCode number

Example:401

message string

Example:Invalid token: access token is invalid

error string

Example:Unauthorized

{
  "statusCode": 401,
  "message": "Invalid token: access token is invalid",
  "error": "Unauthorized"
}

Authorization: Authorization

name: Authorizationtype: httpscheme: bearerbearerFormat: JWTin: headerdescription: Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.

  • curl

  • nodejs

  • python

  • php

  • java

  • go

  • ruby

  • powershell

  • CURL

curl -L -X PUT 'https://services.leadconnectorhq.com/objects/:schemaKey/records/:id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{}'

Request Collapse all

Base URL

Edit

https://services.leadconnectorhq.com

Auth

Bearer Token

Parameters

schemaKey — pathrequired

id — pathrequired

locationId — queryrequired

Version — headerrequired

---2021-07-28

Body required

{}

Send API Request

ResponseClear

Click the Send API Request button above and see the response here!