cURL
curl --request POST \
--url https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"object": {
"apiName": "<string>",
"archived": true,
"displayNamePlural": "<string>",
"displayNameSingular": "<string>",
"fieldDefinitions": [
{
"allowedObjectIds": [
"<string>"
],
"apiName": "<string>",
"archived": true,
"displayName": "<string>",
"enumValues": [
{
"apiName": "<string>",
"displayColor": [
"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED",
"ENUM_VALUE_DISPLAY_COLOR_RED",
"ENUM_VALUE_DISPLAY_COLOR_ORANGE",
"ENUM_VALUE_DISPLAY_COLOR_YELLOW",
"ENUM_VALUE_DISPLAY_COLOR_GREEN",
"ENUM_VALUE_DISPLAY_COLOR_BLUE",
"ENUM_VALUE_DISPLAY_COLOR_VIOLET"
],
"displayName": "<string>"
}
],
"formula": "<string>",
"id": "<string>",
"type": [
"FIELD_DEFINITION_TYPE_UNSPECIFIED",
"FIELD_DEFINITION_TYPE_BOOLEAN",
"FIELD_DEFINITION_TYPE_NUMBER",
"FIELD_DEFINITION_TYPE_STRING",
"FIELD_DEFINITION_TYPE_TIMESTAMP",
"FIELD_DEFINITION_TYPE_USER_ID",
"FIELD_DEFINITION_TYPE_RECORD_ID",
"FIELD_DEFINITION_TYPE_ENUM"
],
"unique": true
}
],
"iconDisplayFieldDefinitionApiName": "<string>",
"id": "<string>",
"primaryDisplayFieldDefinitionApiName": "<string>",
"secondaryDisplayFieldDefinitionApiName": "<string>"
}
}
'import requests
url = "https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject"
payload = { "object": {
"apiName": "<string>",
"archived": True,
"displayNamePlural": "<string>",
"displayNameSingular": "<string>",
"fieldDefinitions": [
{
"allowedObjectIds": ["<string>"],
"apiName": "<string>",
"archived": True,
"displayName": "<string>",
"enumValues": [
{
"apiName": "<string>",
"displayColor": ["ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED", "ENUM_VALUE_DISPLAY_COLOR_RED", "ENUM_VALUE_DISPLAY_COLOR_ORANGE", "ENUM_VALUE_DISPLAY_COLOR_YELLOW", "ENUM_VALUE_DISPLAY_COLOR_GREEN", "ENUM_VALUE_DISPLAY_COLOR_BLUE", "ENUM_VALUE_DISPLAY_COLOR_VIOLET"],
"displayName": "<string>"
}
],
"formula": "<string>",
"id": "<string>",
"type": ["FIELD_DEFINITION_TYPE_UNSPECIFIED", "FIELD_DEFINITION_TYPE_BOOLEAN", "FIELD_DEFINITION_TYPE_NUMBER", "FIELD_DEFINITION_TYPE_STRING", "FIELD_DEFINITION_TYPE_TIMESTAMP", "FIELD_DEFINITION_TYPE_USER_ID", "FIELD_DEFINITION_TYPE_RECORD_ID", "FIELD_DEFINITION_TYPE_ENUM"],
"unique": True
}
],
"iconDisplayFieldDefinitionApiName": "<string>",
"id": "<string>",
"primaryDisplayFieldDefinitionApiName": "<string>",
"secondaryDisplayFieldDefinitionApiName": "<string>"
} }
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({
object: {
apiName: '<string>',
archived: true,
displayNamePlural: '<string>',
displayNameSingular: '<string>',
fieldDefinitions: [
{
allowedObjectIds: ['<string>'],
apiName: '<string>',
archived: true,
displayName: '<string>',
enumValues: [
{
apiName: '<string>',
displayColor: [
'ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED',
'ENUM_VALUE_DISPLAY_COLOR_RED',
'ENUM_VALUE_DISPLAY_COLOR_ORANGE',
'ENUM_VALUE_DISPLAY_COLOR_YELLOW',
'ENUM_VALUE_DISPLAY_COLOR_GREEN',
'ENUM_VALUE_DISPLAY_COLOR_BLUE',
'ENUM_VALUE_DISPLAY_COLOR_VIOLET'
],
displayName: '<string>'
}
],
formula: '<string>',
id: '<string>',
type: [
'FIELD_DEFINITION_TYPE_UNSPECIFIED',
'FIELD_DEFINITION_TYPE_BOOLEAN',
'FIELD_DEFINITION_TYPE_NUMBER',
'FIELD_DEFINITION_TYPE_STRING',
'FIELD_DEFINITION_TYPE_TIMESTAMP',
'FIELD_DEFINITION_TYPE_USER_ID',
'FIELD_DEFINITION_TYPE_RECORD_ID',
'FIELD_DEFINITION_TYPE_ENUM'
],
unique: true
}
],
iconDisplayFieldDefinitionApiName: '<string>',
id: '<string>',
primaryDisplayFieldDefinitionApiName: '<string>',
secondaryDisplayFieldDefinitionApiName: '<string>'
}
})
};
fetch('https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject', 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.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject",
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([
'object' => [
'apiName' => '<string>',
'archived' => true,
'displayNamePlural' => '<string>',
'displayNameSingular' => '<string>',
'fieldDefinitions' => [
[
'allowedObjectIds' => [
'<string>'
],
'apiName' => '<string>',
'archived' => true,
'displayName' => '<string>',
'enumValues' => [
[
'apiName' => '<string>',
'displayColor' => [
'ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED',
'ENUM_VALUE_DISPLAY_COLOR_RED',
'ENUM_VALUE_DISPLAY_COLOR_ORANGE',
'ENUM_VALUE_DISPLAY_COLOR_YELLOW',
'ENUM_VALUE_DISPLAY_COLOR_GREEN',
'ENUM_VALUE_DISPLAY_COLOR_BLUE',
'ENUM_VALUE_DISPLAY_COLOR_VIOLET'
],
'displayName' => '<string>'
]
],
'formula' => '<string>',
'id' => '<string>',
'type' => [
'FIELD_DEFINITION_TYPE_UNSPECIFIED',
'FIELD_DEFINITION_TYPE_BOOLEAN',
'FIELD_DEFINITION_TYPE_NUMBER',
'FIELD_DEFINITION_TYPE_STRING',
'FIELD_DEFINITION_TYPE_TIMESTAMP',
'FIELD_DEFINITION_TYPE_USER_ID',
'FIELD_DEFINITION_TYPE_RECORD_ID',
'FIELD_DEFINITION_TYPE_ENUM'
],
'unique' => true
]
],
'iconDisplayFieldDefinitionApiName' => '<string>',
'id' => '<string>',
'primaryDisplayFieldDefinitionApiName' => '<string>',
'secondaryDisplayFieldDefinitionApiName' => '<string>'
]
]),
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.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject"
payload := strings.NewReader("{\n \"object\": {\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayNamePlural\": \"<string>\",\n \"displayNameSingular\": \"<string>\",\n \"fieldDefinitions\": [\n {\n \"allowedObjectIds\": [\n \"<string>\"\n ],\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayName\": \"<string>\",\n \"enumValues\": [\n {\n \"apiName\": \"<string>\",\n \"displayColor\": [\n \"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED\",\n \"ENUM_VALUE_DISPLAY_COLOR_RED\",\n \"ENUM_VALUE_DISPLAY_COLOR_ORANGE\",\n \"ENUM_VALUE_DISPLAY_COLOR_YELLOW\",\n \"ENUM_VALUE_DISPLAY_COLOR_GREEN\",\n \"ENUM_VALUE_DISPLAY_COLOR_BLUE\",\n \"ENUM_VALUE_DISPLAY_COLOR_VIOLET\"\n ],\n \"displayName\": \"<string>\"\n }\n ],\n \"formula\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": [\n \"FIELD_DEFINITION_TYPE_UNSPECIFIED\",\n \"FIELD_DEFINITION_TYPE_BOOLEAN\",\n \"FIELD_DEFINITION_TYPE_NUMBER\",\n \"FIELD_DEFINITION_TYPE_STRING\",\n \"FIELD_DEFINITION_TYPE_TIMESTAMP\",\n \"FIELD_DEFINITION_TYPE_USER_ID\",\n \"FIELD_DEFINITION_TYPE_RECORD_ID\",\n \"FIELD_DEFINITION_TYPE_ENUM\"\n ],\n \"unique\": true\n }\n ],\n \"iconDisplayFieldDefinitionApiName\": \"<string>\",\n \"id\": \"<string>\",\n \"primaryDisplayFieldDefinitionApiName\": \"<string>\",\n \"secondaryDisplayFieldDefinitionApiName\": \"<string>\"\n }\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.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"object\": {\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayNamePlural\": \"<string>\",\n \"displayNameSingular\": \"<string>\",\n \"fieldDefinitions\": [\n {\n \"allowedObjectIds\": [\n \"<string>\"\n ],\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayName\": \"<string>\",\n \"enumValues\": [\n {\n \"apiName\": \"<string>\",\n \"displayColor\": [\n \"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED\",\n \"ENUM_VALUE_DISPLAY_COLOR_RED\",\n \"ENUM_VALUE_DISPLAY_COLOR_ORANGE\",\n \"ENUM_VALUE_DISPLAY_COLOR_YELLOW\",\n \"ENUM_VALUE_DISPLAY_COLOR_GREEN\",\n \"ENUM_VALUE_DISPLAY_COLOR_BLUE\",\n \"ENUM_VALUE_DISPLAY_COLOR_VIOLET\"\n ],\n \"displayName\": \"<string>\"\n }\n ],\n \"formula\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": [\n \"FIELD_DEFINITION_TYPE_UNSPECIFIED\",\n \"FIELD_DEFINITION_TYPE_BOOLEAN\",\n \"FIELD_DEFINITION_TYPE_NUMBER\",\n \"FIELD_DEFINITION_TYPE_STRING\",\n \"FIELD_DEFINITION_TYPE_TIMESTAMP\",\n \"FIELD_DEFINITION_TYPE_USER_ID\",\n \"FIELD_DEFINITION_TYPE_RECORD_ID\",\n \"FIELD_DEFINITION_TYPE_ENUM\"\n ],\n \"unique\": true\n }\n ],\n \"iconDisplayFieldDefinitionApiName\": \"<string>\",\n \"id\": \"<string>\",\n \"primaryDisplayFieldDefinitionApiName\": \"<string>\",\n \"secondaryDisplayFieldDefinitionApiName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject")
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 \"object\": {\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayNamePlural\": \"<string>\",\n \"displayNameSingular\": \"<string>\",\n \"fieldDefinitions\": [\n {\n \"allowedObjectIds\": [\n \"<string>\"\n ],\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayName\": \"<string>\",\n \"enumValues\": [\n {\n \"apiName\": \"<string>\",\n \"displayColor\": [\n \"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED\",\n \"ENUM_VALUE_DISPLAY_COLOR_RED\",\n \"ENUM_VALUE_DISPLAY_COLOR_ORANGE\",\n \"ENUM_VALUE_DISPLAY_COLOR_YELLOW\",\n \"ENUM_VALUE_DISPLAY_COLOR_GREEN\",\n \"ENUM_VALUE_DISPLAY_COLOR_BLUE\",\n \"ENUM_VALUE_DISPLAY_COLOR_VIOLET\"\n ],\n \"displayName\": \"<string>\"\n }\n ],\n \"formula\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": [\n \"FIELD_DEFINITION_TYPE_UNSPECIFIED\",\n \"FIELD_DEFINITION_TYPE_BOOLEAN\",\n \"FIELD_DEFINITION_TYPE_NUMBER\",\n \"FIELD_DEFINITION_TYPE_STRING\",\n \"FIELD_DEFINITION_TYPE_TIMESTAMP\",\n \"FIELD_DEFINITION_TYPE_USER_ID\",\n \"FIELD_DEFINITION_TYPE_RECORD_ID\",\n \"FIELD_DEFINITION_TYPE_ENUM\"\n ],\n \"unique\": true\n }\n ],\n \"iconDisplayFieldDefinitionApiName\": \"<string>\",\n \"id\": \"<string>\",\n \"primaryDisplayFieldDefinitionApiName\": \"<string>\",\n \"secondaryDisplayFieldDefinitionApiName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"apiName": "<string>",
"archived": true,
"displayNamePlural": "<string>",
"displayNameSingular": "<string>",
"fieldDefinitions": [
{
"allowedObjectIds": [
"<string>"
],
"apiName": "<string>",
"archived": true,
"displayName": "<string>",
"enumValues": [
{
"apiName": "<string>",
"displayColor": [
"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED",
"ENUM_VALUE_DISPLAY_COLOR_RED",
"ENUM_VALUE_DISPLAY_COLOR_ORANGE",
"ENUM_VALUE_DISPLAY_COLOR_YELLOW",
"ENUM_VALUE_DISPLAY_COLOR_GREEN",
"ENUM_VALUE_DISPLAY_COLOR_BLUE",
"ENUM_VALUE_DISPLAY_COLOR_VIOLET"
],
"displayName": "<string>"
}
],
"formula": "<string>",
"id": "<string>",
"type": [
"FIELD_DEFINITION_TYPE_UNSPECIFIED",
"FIELD_DEFINITION_TYPE_BOOLEAN",
"FIELD_DEFINITION_TYPE_NUMBER",
"FIELD_DEFINITION_TYPE_STRING",
"FIELD_DEFINITION_TYPE_TIMESTAMP",
"FIELD_DEFINITION_TYPE_USER_ID",
"FIELD_DEFINITION_TYPE_RECORD_ID",
"FIELD_DEFINITION_TYPE_ENUM"
],
"unique": true
}
],
"iconDisplayFieldDefinitionApiName": "<string>",
"id": "<string>",
"primaryDisplayFieldDefinitionApiName": "<string>",
"secondaryDisplayFieldDefinitionApiName": "<string>"
}{
"code": "CodeNotFound",
"detail": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Objects
Create
POST
/
okapicrm.v1.OkapiCRMService
/
CreateObject
cURL
curl --request POST \
--url https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"object": {
"apiName": "<string>",
"archived": true,
"displayNamePlural": "<string>",
"displayNameSingular": "<string>",
"fieldDefinitions": [
{
"allowedObjectIds": [
"<string>"
],
"apiName": "<string>",
"archived": true,
"displayName": "<string>",
"enumValues": [
{
"apiName": "<string>",
"displayColor": [
"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED",
"ENUM_VALUE_DISPLAY_COLOR_RED",
"ENUM_VALUE_DISPLAY_COLOR_ORANGE",
"ENUM_VALUE_DISPLAY_COLOR_YELLOW",
"ENUM_VALUE_DISPLAY_COLOR_GREEN",
"ENUM_VALUE_DISPLAY_COLOR_BLUE",
"ENUM_VALUE_DISPLAY_COLOR_VIOLET"
],
"displayName": "<string>"
}
],
"formula": "<string>",
"id": "<string>",
"type": [
"FIELD_DEFINITION_TYPE_UNSPECIFIED",
"FIELD_DEFINITION_TYPE_BOOLEAN",
"FIELD_DEFINITION_TYPE_NUMBER",
"FIELD_DEFINITION_TYPE_STRING",
"FIELD_DEFINITION_TYPE_TIMESTAMP",
"FIELD_DEFINITION_TYPE_USER_ID",
"FIELD_DEFINITION_TYPE_RECORD_ID",
"FIELD_DEFINITION_TYPE_ENUM"
],
"unique": true
}
],
"iconDisplayFieldDefinitionApiName": "<string>",
"id": "<string>",
"primaryDisplayFieldDefinitionApiName": "<string>",
"secondaryDisplayFieldDefinitionApiName": "<string>"
}
}
'import requests
url = "https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject"
payload = { "object": {
"apiName": "<string>",
"archived": True,
"displayNamePlural": "<string>",
"displayNameSingular": "<string>",
"fieldDefinitions": [
{
"allowedObjectIds": ["<string>"],
"apiName": "<string>",
"archived": True,
"displayName": "<string>",
"enumValues": [
{
"apiName": "<string>",
"displayColor": ["ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED", "ENUM_VALUE_DISPLAY_COLOR_RED", "ENUM_VALUE_DISPLAY_COLOR_ORANGE", "ENUM_VALUE_DISPLAY_COLOR_YELLOW", "ENUM_VALUE_DISPLAY_COLOR_GREEN", "ENUM_VALUE_DISPLAY_COLOR_BLUE", "ENUM_VALUE_DISPLAY_COLOR_VIOLET"],
"displayName": "<string>"
}
],
"formula": "<string>",
"id": "<string>",
"type": ["FIELD_DEFINITION_TYPE_UNSPECIFIED", "FIELD_DEFINITION_TYPE_BOOLEAN", "FIELD_DEFINITION_TYPE_NUMBER", "FIELD_DEFINITION_TYPE_STRING", "FIELD_DEFINITION_TYPE_TIMESTAMP", "FIELD_DEFINITION_TYPE_USER_ID", "FIELD_DEFINITION_TYPE_RECORD_ID", "FIELD_DEFINITION_TYPE_ENUM"],
"unique": True
}
],
"iconDisplayFieldDefinitionApiName": "<string>",
"id": "<string>",
"primaryDisplayFieldDefinitionApiName": "<string>",
"secondaryDisplayFieldDefinitionApiName": "<string>"
} }
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({
object: {
apiName: '<string>',
archived: true,
displayNamePlural: '<string>',
displayNameSingular: '<string>',
fieldDefinitions: [
{
allowedObjectIds: ['<string>'],
apiName: '<string>',
archived: true,
displayName: '<string>',
enumValues: [
{
apiName: '<string>',
displayColor: [
'ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED',
'ENUM_VALUE_DISPLAY_COLOR_RED',
'ENUM_VALUE_DISPLAY_COLOR_ORANGE',
'ENUM_VALUE_DISPLAY_COLOR_YELLOW',
'ENUM_VALUE_DISPLAY_COLOR_GREEN',
'ENUM_VALUE_DISPLAY_COLOR_BLUE',
'ENUM_VALUE_DISPLAY_COLOR_VIOLET'
],
displayName: '<string>'
}
],
formula: '<string>',
id: '<string>',
type: [
'FIELD_DEFINITION_TYPE_UNSPECIFIED',
'FIELD_DEFINITION_TYPE_BOOLEAN',
'FIELD_DEFINITION_TYPE_NUMBER',
'FIELD_DEFINITION_TYPE_STRING',
'FIELD_DEFINITION_TYPE_TIMESTAMP',
'FIELD_DEFINITION_TYPE_USER_ID',
'FIELD_DEFINITION_TYPE_RECORD_ID',
'FIELD_DEFINITION_TYPE_ENUM'
],
unique: true
}
],
iconDisplayFieldDefinitionApiName: '<string>',
id: '<string>',
primaryDisplayFieldDefinitionApiName: '<string>',
secondaryDisplayFieldDefinitionApiName: '<string>'
}
})
};
fetch('https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject', 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.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject",
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([
'object' => [
'apiName' => '<string>',
'archived' => true,
'displayNamePlural' => '<string>',
'displayNameSingular' => '<string>',
'fieldDefinitions' => [
[
'allowedObjectIds' => [
'<string>'
],
'apiName' => '<string>',
'archived' => true,
'displayName' => '<string>',
'enumValues' => [
[
'apiName' => '<string>',
'displayColor' => [
'ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED',
'ENUM_VALUE_DISPLAY_COLOR_RED',
'ENUM_VALUE_DISPLAY_COLOR_ORANGE',
'ENUM_VALUE_DISPLAY_COLOR_YELLOW',
'ENUM_VALUE_DISPLAY_COLOR_GREEN',
'ENUM_VALUE_DISPLAY_COLOR_BLUE',
'ENUM_VALUE_DISPLAY_COLOR_VIOLET'
],
'displayName' => '<string>'
]
],
'formula' => '<string>',
'id' => '<string>',
'type' => [
'FIELD_DEFINITION_TYPE_UNSPECIFIED',
'FIELD_DEFINITION_TYPE_BOOLEAN',
'FIELD_DEFINITION_TYPE_NUMBER',
'FIELD_DEFINITION_TYPE_STRING',
'FIELD_DEFINITION_TYPE_TIMESTAMP',
'FIELD_DEFINITION_TYPE_USER_ID',
'FIELD_DEFINITION_TYPE_RECORD_ID',
'FIELD_DEFINITION_TYPE_ENUM'
],
'unique' => true
]
],
'iconDisplayFieldDefinitionApiName' => '<string>',
'id' => '<string>',
'primaryDisplayFieldDefinitionApiName' => '<string>',
'secondaryDisplayFieldDefinitionApiName' => '<string>'
]
]),
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.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject"
payload := strings.NewReader("{\n \"object\": {\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayNamePlural\": \"<string>\",\n \"displayNameSingular\": \"<string>\",\n \"fieldDefinitions\": [\n {\n \"allowedObjectIds\": [\n \"<string>\"\n ],\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayName\": \"<string>\",\n \"enumValues\": [\n {\n \"apiName\": \"<string>\",\n \"displayColor\": [\n \"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED\",\n \"ENUM_VALUE_DISPLAY_COLOR_RED\",\n \"ENUM_VALUE_DISPLAY_COLOR_ORANGE\",\n \"ENUM_VALUE_DISPLAY_COLOR_YELLOW\",\n \"ENUM_VALUE_DISPLAY_COLOR_GREEN\",\n \"ENUM_VALUE_DISPLAY_COLOR_BLUE\",\n \"ENUM_VALUE_DISPLAY_COLOR_VIOLET\"\n ],\n \"displayName\": \"<string>\"\n }\n ],\n \"formula\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": [\n \"FIELD_DEFINITION_TYPE_UNSPECIFIED\",\n \"FIELD_DEFINITION_TYPE_BOOLEAN\",\n \"FIELD_DEFINITION_TYPE_NUMBER\",\n \"FIELD_DEFINITION_TYPE_STRING\",\n \"FIELD_DEFINITION_TYPE_TIMESTAMP\",\n \"FIELD_DEFINITION_TYPE_USER_ID\",\n \"FIELD_DEFINITION_TYPE_RECORD_ID\",\n \"FIELD_DEFINITION_TYPE_ENUM\"\n ],\n \"unique\": true\n }\n ],\n \"iconDisplayFieldDefinitionApiName\": \"<string>\",\n \"id\": \"<string>\",\n \"primaryDisplayFieldDefinitionApiName\": \"<string>\",\n \"secondaryDisplayFieldDefinitionApiName\": \"<string>\"\n }\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.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"object\": {\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayNamePlural\": \"<string>\",\n \"displayNameSingular\": \"<string>\",\n \"fieldDefinitions\": [\n {\n \"allowedObjectIds\": [\n \"<string>\"\n ],\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayName\": \"<string>\",\n \"enumValues\": [\n {\n \"apiName\": \"<string>\",\n \"displayColor\": [\n \"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED\",\n \"ENUM_VALUE_DISPLAY_COLOR_RED\",\n \"ENUM_VALUE_DISPLAY_COLOR_ORANGE\",\n \"ENUM_VALUE_DISPLAY_COLOR_YELLOW\",\n \"ENUM_VALUE_DISPLAY_COLOR_GREEN\",\n \"ENUM_VALUE_DISPLAY_COLOR_BLUE\",\n \"ENUM_VALUE_DISPLAY_COLOR_VIOLET\"\n ],\n \"displayName\": \"<string>\"\n }\n ],\n \"formula\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": [\n \"FIELD_DEFINITION_TYPE_UNSPECIFIED\",\n \"FIELD_DEFINITION_TYPE_BOOLEAN\",\n \"FIELD_DEFINITION_TYPE_NUMBER\",\n \"FIELD_DEFINITION_TYPE_STRING\",\n \"FIELD_DEFINITION_TYPE_TIMESTAMP\",\n \"FIELD_DEFINITION_TYPE_USER_ID\",\n \"FIELD_DEFINITION_TYPE_RECORD_ID\",\n \"FIELD_DEFINITION_TYPE_ENUM\"\n ],\n \"unique\": true\n }\n ],\n \"iconDisplayFieldDefinitionApiName\": \"<string>\",\n \"id\": \"<string>\",\n \"primaryDisplayFieldDefinitionApiName\": \"<string>\",\n \"secondaryDisplayFieldDefinitionApiName\": \"<string>\"\n }\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.okapicrm.com/okapicrm.v1.OkapiCRMService/CreateObject")
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 \"object\": {\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayNamePlural\": \"<string>\",\n \"displayNameSingular\": \"<string>\",\n \"fieldDefinitions\": [\n {\n \"allowedObjectIds\": [\n \"<string>\"\n ],\n \"apiName\": \"<string>\",\n \"archived\": true,\n \"displayName\": \"<string>\",\n \"enumValues\": [\n {\n \"apiName\": \"<string>\",\n \"displayColor\": [\n \"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED\",\n \"ENUM_VALUE_DISPLAY_COLOR_RED\",\n \"ENUM_VALUE_DISPLAY_COLOR_ORANGE\",\n \"ENUM_VALUE_DISPLAY_COLOR_YELLOW\",\n \"ENUM_VALUE_DISPLAY_COLOR_GREEN\",\n \"ENUM_VALUE_DISPLAY_COLOR_BLUE\",\n \"ENUM_VALUE_DISPLAY_COLOR_VIOLET\"\n ],\n \"displayName\": \"<string>\"\n }\n ],\n \"formula\": \"<string>\",\n \"id\": \"<string>\",\n \"type\": [\n \"FIELD_DEFINITION_TYPE_UNSPECIFIED\",\n \"FIELD_DEFINITION_TYPE_BOOLEAN\",\n \"FIELD_DEFINITION_TYPE_NUMBER\",\n \"FIELD_DEFINITION_TYPE_STRING\",\n \"FIELD_DEFINITION_TYPE_TIMESTAMP\",\n \"FIELD_DEFINITION_TYPE_USER_ID\",\n \"FIELD_DEFINITION_TYPE_RECORD_ID\",\n \"FIELD_DEFINITION_TYPE_ENUM\"\n ],\n \"unique\": true\n }\n ],\n \"iconDisplayFieldDefinitionApiName\": \"<string>\",\n \"id\": \"<string>\",\n \"primaryDisplayFieldDefinitionApiName\": \"<string>\",\n \"secondaryDisplayFieldDefinitionApiName\": \"<string>\"\n }\n}"
response = http.request(request)
puts response.read_body{
"apiName": "<string>",
"archived": true,
"displayNamePlural": "<string>",
"displayNameSingular": "<string>",
"fieldDefinitions": [
{
"allowedObjectIds": [
"<string>"
],
"apiName": "<string>",
"archived": true,
"displayName": "<string>",
"enumValues": [
{
"apiName": "<string>",
"displayColor": [
"ENUM_VALUE_DISPLAY_COLOR_UNSPECIFIED",
"ENUM_VALUE_DISPLAY_COLOR_RED",
"ENUM_VALUE_DISPLAY_COLOR_ORANGE",
"ENUM_VALUE_DISPLAY_COLOR_YELLOW",
"ENUM_VALUE_DISPLAY_COLOR_GREEN",
"ENUM_VALUE_DISPLAY_COLOR_BLUE",
"ENUM_VALUE_DISPLAY_COLOR_VIOLET"
],
"displayName": "<string>"
}
],
"formula": "<string>",
"id": "<string>",
"type": [
"FIELD_DEFINITION_TYPE_UNSPECIFIED",
"FIELD_DEFINITION_TYPE_BOOLEAN",
"FIELD_DEFINITION_TYPE_NUMBER",
"FIELD_DEFINITION_TYPE_STRING",
"FIELD_DEFINITION_TYPE_TIMESTAMP",
"FIELD_DEFINITION_TYPE_USER_ID",
"FIELD_DEFINITION_TYPE_RECORD_ID",
"FIELD_DEFINITION_TYPE_ENUM"
],
"unique": true
}
],
"iconDisplayFieldDefinitionApiName": "<string>",
"id": "<string>",
"primaryDisplayFieldDefinitionApiName": "<string>",
"secondaryDisplayFieldDefinitionApiName": "<string>"
}{
"code": "CodeNotFound",
"detail": [
{
"@type": "<string>"
}
],
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/jsonapplication/proto
Show child attributes
Show child attributes