custom-object-types

Written for: ＋ Written for
Deprecated: ＋ Deprecated
Applies to: ＋ Applies to

AdminUpdated Sep 19, 2026

GEThttps://api.chatlychat.com/v1/custom-object-types

Parameters

Name	In	Type	Required	Description
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X GET "https://api.chatlychat.com/v1/custom-object-types" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/custom-object-types', {
  method: 'GET',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.chatlychat.com/v1/custom-object-types",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/custom-object-types", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/custom-object-types');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/custom-object-types')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/custom-object-types"))
    .header("Idempotency-Key", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

POSThttps://api.chatlychat.com/v1/custom-object-types

Parameters

Name	In	Type	Required	Description
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Request body application/json

{
  "key": "string",
  "name": "string",
  "plural": "string",
  "description": "string",
  "icon": "string",
  "color": "string",
  "schema": {
    "fields": [
      {
        "name": "string",
        "type": "string",
        "required": true,
        "description": "string",
        "options": [
          null
        ],
        "referenceTypeKey": "string"
      }
    ]
  }
}

Responses

201

Code samples

cURL

curl -X POST "https://api.chatlychat.com/v1/custom-object-types" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"key":"string","name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}'

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/custom-object-types', {
  method: 'POST',
  headers: {
    'Idempotency-Key': '<value>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"key":"string","name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "POST",
    "https://api.chatlychat.com/v1/custom-object-types",
    headers={
    "Idempotency-Key": "<value>",
    "Content-Type": "application/json",
    },
    json={"key": "string", "name": "string", "plural": "string", "description": "string", "icon": "string", "color": "string", "schema": {"fields": [{"name": "string", "type": "string", "required": True, "description": "string", "options": [None], "referenceTypeKey": "string"}]}},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("POST", "https://api.chatlychat.com/v1/custom-object-types", strings.NewReader(`{"key":"string","name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}`))
	req.Header.Set("Idempotency-Key", "<value>")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/custom-object-types');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"key":"string","name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/custom-object-types')
req = Net::HTTP::Post.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"key":"string","name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/custom-object-types"))
    .header("Idempotency-Key", "<value>")
    .header("Content-Type", "application/json")
    .method("POST", BodyPublishers.ofString("{\"key\":\"string\",\"name\":\"string\",\"plural\":\"string\",\"description\":\"string\",\"icon\":\"string\",\"color\":\"string\",\"schema\":{\"fields\":[{\"name\":\"string\",\"type\":\"string\",\"required\":true,\"description\":\"string\",\"options\":[null],\"referenceTypeKey\":\"string\"}]}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

GEThttps://api.chatlychat.com/v1/custom-object-types/{key}

Parameters

Name	In	Type	Required	Description
`key`	path	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X GET "https://api.chatlychat.com/v1/custom-object-types/{key}" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/custom-object-types/{key}', {
  method: 'GET',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "GET",
    "https://api.chatlychat.com/v1/custom-object-types/{key}",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("GET", "https://api.chatlychat.com/v1/custom-object-types/{key}", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/custom-object-types/{key}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'GET');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/custom-object-types/{key}')
req = Net::HTTP::Get.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/custom-object-types/{key}"))
    .header("Idempotency-Key", "<value>")
    .GET()
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

DELETEhttps://api.chatlychat.com/v1/custom-object-types/{key}

Parameters

Name	In	Type	Required	Description
`key`	path	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Responses

200

Code samples

cURL

curl -X DELETE "https://api.chatlychat.com/v1/custom-object-types/{key}" \
  -H "Idempotency-Key: <value>"

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/custom-object-types/{key}', {
  method: 'DELETE',
  headers: {
    'Idempotency-Key': '<value>',
  },
});
const data = await res.json();

Python

import requests

res = requests.request(
    "DELETE",
    "https://api.chatlychat.com/v1/custom-object-types/{key}",
    headers={
    "Idempotency-Key": "<value>",
    },
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("DELETE", "https://api.chatlychat.com/v1/custom-object-types/{key}", nil)
	req.Header.Set("Idempotency-Key", "<value>")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/custom-object-types/{key}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'DELETE');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>']);
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/custom-object-types/{key}')
req = Net::HTTP::Delete.new(uri)
req['Idempotency-Key'] = '<value>'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/custom-object-types/{key}"))
    .header("Idempotency-Key", "<value>")
    .method("DELETE", BodyPublishers.noBody())
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

PATCHhttps://api.chatlychat.com/v1/custom-object-types/{key}

Parameters

Name	In	Type	Required	Description
`key`	path	string	yes
`Idempotency-Key`	header	string	no	UUIDv4 or 16-128 char opaque token. Required on write endpoints in production. Replays return the cached response with `Idempotency-Replay: true`; reusing the key with a different body returns 409 idempotency_conflict.

Request body application/json

{
  "name": "string",
  "plural": "string",
  "description": "string",
  "icon": "string",
  "color": "string",
  "schema": {
    "fields": [
      {
        "name": "string",
        "type": "string",
        "required": true,
        "description": "string",
        "options": [
          null
        ],
        "referenceTypeKey": "string"
      }
    ]
  }
}

Responses

200

Code samples

cURL

curl -X PATCH "https://api.chatlychat.com/v1/custom-object-types/{key}" \
  -H "Idempotency-Key: <value>" \
  -H "Content-Type: application/json" \
  -d '{"name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}'

TypeScript

const res = await fetch('https://api.chatlychat.com/v1/custom-object-types/{key}', {
  method: 'PATCH',
  headers: {
    'Idempotency-Key': '<value>',
    'Content-Type': 'application/json',
  },
  body: JSON.stringify({"name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}),
});
const data = await res.json();

Python

import requests

res = requests.request(
    "PATCH",
    "https://api.chatlychat.com/v1/custom-object-types/{key}",
    headers={
    "Idempotency-Key": "<value>",
    "Content-Type": "application/json",
    },
    json={"name": "string", "plural": "string", "description": "string", "icon": "string", "color": "string", "schema": {"fields": [{"name": "string", "type": "string", "required": True, "description": "string", "options": [None], "referenceTypeKey": "string"}]}},
)
data = res.json()

package main

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

func main() {
	req, _ := http.NewRequest("PATCH", "https://api.chatlychat.com/v1/custom-object-types/{key}", strings.NewReader(`{"name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}`))
	req.Header.Set("Idempotency-Key", "<value>")
	req.Header.Set("Content-Type", "application/json")
	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)
	fmt.Println(string(body))
}

PHP

<?php
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, 'https://api.chatlychat.com/v1/custom-object-types/{key}');
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, 'PATCH');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ['Idempotency-Key: <value>', 'Content-Type: application/json']);
curl_setopt($ch, CURLOPT_POSTFIELDS, '{"name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}');
$response = curl_exec($ch);
curl_close($ch);
echo $response;

Ruby

require 'net/http'
require 'uri'

uri = URI('https://api.chatlychat.com/v1/custom-object-types/{key}')
req = Net::HTTP::Patch.new(uri)
req['Idempotency-Key'] = '<value>'
req['Content-Type'] = 'application/json'
req.body = '{"name":"string","plural":"string","description":"string","icon":"string","color":"string","schema":{"fields":[{"name":"string","type":"string","required":true,"description":"string","options":[null],"referenceTypeKey":"string"}]}}'
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == 'https') do |http|
  http.request(req)
end
puts res.body

Java

import java.net.URI;
import java.net.http.*;
import java.net.http.HttpRequest.BodyPublishers;

HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://api.chatlychat.com/v1/custom-object-types/{key}"))
    .header("Idempotency-Key", "<value>")
    .header("Content-Type", "application/json")
    .method("PATCH", BodyPublishers.ofString("{\"name\":\"string\",\"plural\":\"string\",\"description\":\"string\",\"icon\":\"string\",\"color\":\"string\",\"schema\":{\"fields\":[{\"name\":\"string\",\"type\":\"string\",\"required\":true,\"description\":\"string\",\"options\":[null],\"referenceTypeKey\":\"string\"}]}}"))
    .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Was this page helpful?