Create a new custom object schema.

Crie um novo esquema de objeto personalizado.

curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "associatedObjects": [
    "CONTACT"
  ],
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "isPrimaryDisplayLabel": true,
      "label": "My object property",
      "name": "my_object_property"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ]
}
'

import requests

url = "https://api.hubapi.com/crm-object-schemas/v3/schemas"

payload = {
    "associatedObjects": ["CONTACT"],
    "labels": {
        "plural": "My objects",
        "singular": "My object"
    },
    "metaType": "PORTAL_SPECIFIC",
    "name": "my_object",
    "primaryDisplayProperty": "my_object_property",
    "properties": [
        {
            "isPrimaryDisplayLabel": True,
            "label": "My object property",
            "name": "my_object_property"
        }
    ],
    "requiredProperties": ["my_object_property"]
}
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({
    associatedObjects: ['CONTACT'],
    labels: {plural: 'My objects', singular: 'My object'},
    metaType: 'PORTAL_SPECIFIC',
    name: 'my_object',
    primaryDisplayProperty: 'my_object_property',
    properties: [
      {
        isPrimaryDisplayLabel: true,
        label: 'My object property',
        name: 'my_object_property'
      }
    ],
    requiredProperties: ['my_object_property']
  })
};

fetch('https://api.hubapi.com/crm-object-schemas/v3/schemas', 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.hubapi.com/crm-object-schemas/v3/schemas",
  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([
    'associatedObjects' => [
        'CONTACT'
    ],
    'labels' => [
        'plural' => 'My objects',
        'singular' => 'My object'
    ],
    'metaType' => 'PORTAL_SPECIFIC',
    'name' => 'my_object',
    'primaryDisplayProperty' => 'my_object_property',
    'properties' => [
        [
                'isPrimaryDisplayLabel' => true,
                'label' => 'My object property',
                'name' => 'my_object_property'
        ]
    ],
    'requiredProperties' => [
        'my_object_property'
    ]
  ]),
  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.hubapi.com/crm-object-schemas/v3/schemas"

	payload := strings.NewReader("{\n  \"associatedObjects\": [\n    \"CONTACT\"\n  ],\n  \"labels\": {\n    \"plural\": \"My objects\",\n    \"singular\": \"My object\"\n  },\n  \"metaType\": \"PORTAL_SPECIFIC\",\n  \"name\": \"my_object\",\n  \"primaryDisplayProperty\": \"my_object_property\",\n  \"properties\": [\n    {\n      \"isPrimaryDisplayLabel\": true,\n      \"label\": \"My object property\",\n      \"name\": \"my_object_property\"\n    }\n  ],\n  \"requiredProperties\": [\n    \"my_object_property\"\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.hubapi.com/crm-object-schemas/v3/schemas")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"associatedObjects\": [\n    \"CONTACT\"\n  ],\n  \"labels\": {\n    \"plural\": \"My objects\",\n    \"singular\": \"My object\"\n  },\n  \"metaType\": \"PORTAL_SPECIFIC\",\n  \"name\": \"my_object\",\n  \"primaryDisplayProperty\": \"my_object_property\",\n  \"properties\": [\n    {\n      \"isPrimaryDisplayLabel\": true,\n      \"label\": \"My object property\",\n      \"name\": \"my_object_property\"\n    }\n  ],\n  \"requiredProperties\": [\n    \"my_object_property\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm-object-schemas/v3/schemas")

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  \"associatedObjects\": [\n    \"CONTACT\"\n  ],\n  \"labels\": {\n    \"plural\": \"My objects\",\n    \"singular\": \"My object\"\n  },\n  \"metaType\": \"PORTAL_SPECIFIC\",\n  \"name\": \"my_object\",\n  \"primaryDisplayProperty\": \"my_object_property\",\n  \"properties\": [\n    {\n      \"isPrimaryDisplayLabel\": true,\n      \"label\": \"My object property\",\n      \"name\": \"my_object_property\"\n    }\n  ],\n  \"requiredProperties\": [\n    \"my_object_property\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "associations": [
    {
      "fromObjectTypeId": "2-123456",
      "id": "123",
      "name": "my_object_to_contact",
      "toObjectTypeId": "0-1"
    }
  ],
  "createdAt": "2020-02-20T18:07:11.390Z",
  "fullyQualifiedName": "p7878787_my_object\"",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "archived": false,
      "calculated": false,
      "createdAt": "2020-02-20T18:07:11.802Z",
      "displayOrder": -1,
      "externalOptions": false,
      "fieldType": "text",
      "groupName": "my_object_information",
      "hasUniqueValue": false,
      "label": "My object property",
      "name": "my_object_property",
      "type": "string",
      "updatedAt": "2020-02-20T18:07:11.802Z"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-20T18:09:07.555Z"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

POST

crm-object-schemas

schemas

Crie um novo esquema de objeto personalizado.

curl --request POST \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "associatedObjects": [
    "CONTACT"
  ],
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "isPrimaryDisplayLabel": true,
      "label": "My object property",
      "name": "my_object_property"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ]
}
'

import requests

url = "https://api.hubapi.com/crm-object-schemas/v3/schemas"

payload = {
    "associatedObjects": ["CONTACT"],
    "labels": {
        "plural": "My objects",
        "singular": "My object"
    },
    "metaType": "PORTAL_SPECIFIC",
    "name": "my_object",
    "primaryDisplayProperty": "my_object_property",
    "properties": [
        {
            "isPrimaryDisplayLabel": True,
            "label": "My object property",
            "name": "my_object_property"
        }
    ],
    "requiredProperties": ["my_object_property"]
}
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({
    associatedObjects: ['CONTACT'],
    labels: {plural: 'My objects', singular: 'My object'},
    metaType: 'PORTAL_SPECIFIC',
    name: 'my_object',
    primaryDisplayProperty: 'my_object_property',
    properties: [
      {
        isPrimaryDisplayLabel: true,
        label: 'My object property',
        name: 'my_object_property'
      }
    ],
    requiredProperties: ['my_object_property']
  })
};

fetch('https://api.hubapi.com/crm-object-schemas/v3/schemas', 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.hubapi.com/crm-object-schemas/v3/schemas",
  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([
    'associatedObjects' => [
        'CONTACT'
    ],
    'labels' => [
        'plural' => 'My objects',
        'singular' => 'My object'
    ],
    'metaType' => 'PORTAL_SPECIFIC',
    'name' => 'my_object',
    'primaryDisplayProperty' => 'my_object_property',
    'properties' => [
        [
                'isPrimaryDisplayLabel' => true,
                'label' => 'My object property',
                'name' => 'my_object_property'
        ]
    ],
    'requiredProperties' => [
        'my_object_property'
    ]
  ]),
  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.hubapi.com/crm-object-schemas/v3/schemas"

	payload := strings.NewReader("{\n  \"associatedObjects\": [\n    \"CONTACT\"\n  ],\n  \"labels\": {\n    \"plural\": \"My objects\",\n    \"singular\": \"My object\"\n  },\n  \"metaType\": \"PORTAL_SPECIFIC\",\n  \"name\": \"my_object\",\n  \"primaryDisplayProperty\": \"my_object_property\",\n  \"properties\": [\n    {\n      \"isPrimaryDisplayLabel\": true,\n      \"label\": \"My object property\",\n      \"name\": \"my_object_property\"\n    }\n  ],\n  \"requiredProperties\": [\n    \"my_object_property\"\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.hubapi.com/crm-object-schemas/v3/schemas")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"associatedObjects\": [\n    \"CONTACT\"\n  ],\n  \"labels\": {\n    \"plural\": \"My objects\",\n    \"singular\": \"My object\"\n  },\n  \"metaType\": \"PORTAL_SPECIFIC\",\n  \"name\": \"my_object\",\n  \"primaryDisplayProperty\": \"my_object_property\",\n  \"properties\": [\n    {\n      \"isPrimaryDisplayLabel\": true,\n      \"label\": \"My object property\",\n      \"name\": \"my_object_property\"\n    }\n  ],\n  \"requiredProperties\": [\n    \"my_object_property\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hubapi.com/crm-object-schemas/v3/schemas")

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  \"associatedObjects\": [\n    \"CONTACT\"\n  ],\n  \"labels\": {\n    \"plural\": \"My objects\",\n    \"singular\": \"My object\"\n  },\n  \"metaType\": \"PORTAL_SPECIFIC\",\n  \"name\": \"my_object\",\n  \"primaryDisplayProperty\": \"my_object_property\",\n  \"properties\": [\n    {\n      \"isPrimaryDisplayLabel\": true,\n      \"label\": \"My object property\",\n      \"name\": \"my_object_property\"\n    }\n  ],\n  \"requiredProperties\": [\n    \"my_object_property\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "associations": [
    {
      "fromObjectTypeId": "2-123456",
      "id": "123",
      "name": "my_object_to_contact",
      "toObjectTypeId": "0-1"
    }
  ],
  "createdAt": "2020-02-20T18:07:11.390Z",
  "fullyQualifiedName": "p7878787_my_object\"",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "archived": false,
      "calculated": false,
      "createdAt": "2020-02-20T18:07:11.802Z",
      "displayOrder": -1,
      "externalOptions": false,
      "fieldType": "text",
      "groupName": "my_object_information",
      "hasUniqueValue": false,
      "label": "My object property",
      "name": "my_object_property",
      "type": "string",
      "updatedAt": "2020-02-20T18:07:11.802Z"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-20T18:09:07.555Z"
}

{
  "message": "Invalid input (details will vary based on the error)",
  "correlationId": "aeb5f871-7f07-4993-9211-075dc63e7cbf",
  "category": "VALIDATION_ERROR",
  "links": {
    "knowledge-base": "https://www.hubspot.com/products/service/knowledge-base"
  }
}

Supported products

Required Scopes

Autorizações

Authorization

string

header

obrigatório

The access token received from the authorization server in the OAuth 2.0 flow.

Corpo

application/json

Object schema definition, including properties and associations.

Defines a new object type, its properties, and associations.

associatedObjects

string[]

obrigatório

Associações definidas para este tipo de objeto.

labels

object

obrigatório

Singular and plural labels for the object. Used in CRM display.

Show child attributes

Exemplo:

{
  "plural": "My objects",
  "singular": "My object"
}

name

string

obrigatório

Um nome exclusivo para este objeto. Apenas para uso interno.

properties

object[]

obrigatório

Propriedades definidas para este tipo de objeto.

Show child attributes

requiredProperties

string[]

obrigatório

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

allowsSensitiveProperties

boolean

Determina se o tipo de objeto pode incluir propriedades marcadas como confidenciais.

description

string

Uma breve explicação do tipo de objeto.

primaryDisplayProperty

string

O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.

searchableProperties

string[]

Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.

secondaryDisplayProperties

string[]

Os nomes das propriedades secundárias para este objeto. Serão exibidas como secundárias na página do registro do HubSpot para este tipo de objeto.

shouldCreateSameObjectAssociation

boolean

Resposta

successful operation

Defines an object schema, including its properties and associations.

associations

object[]

obrigatório

Associações definidas para um determinado tipo de objeto.

Show child attributes

string

obrigatório

Um ID exclusivo para o tipo de objeto deste esquema. Será definido como {meta-type}-{unique ID}.

labels

object

obrigatório

Singular and plural labels for the object. Used in CRM display.

Show child attributes

Exemplo:

{
  "plural": "My objects",
  "singular": "My object"
}

name

string

obrigatório

Um nome exclusivo para o tipo de objeto do esquema.

properties

object[]

obrigatório

Propriedades definidas para este tipo de objeto.

Show child attributes

requiredProperties

string[]

obrigatório

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

allowsSensitiveProperties

boolean

archived

boolean

createdAt

string<date-time>

Quando o esquema do objeto foi criado.

createdByUserId

integer<int32>

description

string

fullyQualifiedName

string

Um ID exclusivo atribuído ao objeto, incluindo o ID do portal e o nome do objeto.

objectTypeId

string

primaryDisplayProperty

string

O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.

searchableProperties

string[]

Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.

secondaryDisplayProperties

string[]

Os nomes das propriedades secundárias para este objeto. Serão exibidas como secundárias na página do registro do HubSpot para este tipo de objeto.

updatedAt

string<date-time>

Quando o esquema do objeto foi atualizado pela última vez.

updatedByUserId

integer<int32>

Última modificação em 13 de abril de 2026

Conta e configurações

Gerenciamento de aplicativo

Autenticação

Automação

CMS

Preferências de comunicação

Conversas

CRM

Eventos

Arquivos

Marketing

Relatórios

Agendador

Webhooks

Create a new custom object schema.

Autorizações

Corpo

Resposta