Account & Settings
Gestión de aplicaciones
Autenticación
Automatización
CMS
Communication preferences
Conversaciones
Eventos
Archivos
Marketing
Crear informes
Scheduler
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"
]
}
'{
"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"
}Create a new custom object schema.
Crea un nuevo esquema de objeto personalizado definiendo sus propiedades y asociaciones.
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"
]
}
'{
"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"
}Documentation Index
Fetch the complete documentation index at: https://developers.hubspot.es/docs/llms.txt
Use this file to discover all available pages before exploring further.
Supported products
Supported products
Required Scopes
Required Scopes
Autorizaciones
The access token received from the authorization server in the OAuth 2.0 flow.
Cuerpo
Object schema definition, including properties and associations.
Defines a new object type, its properties, and associations.
Asociaciones definidas para este tipo de objeto.
Singular and plural labels for the object. Used in CRM display.
Show child attributes
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}Un nombre único para este objeto. Solo para uso interno.
Propiedades definidas para este tipo de objeto.
Show child attributes
Show child attributes
Los nombres de las propiedades que deben ser obligatorias cuando se cree un objeto de este tipo.
Determina si el tipo de objeto puede incluir propiedades marcadas como sensibles.
Una breve explicación del tipo de objeto.
El nombre de la propiedad principal de este objeto. Se mostrará como principal en la página de registro de HubSpot para este tipo de objeto.
Los nombres de las propiedades que serán indexadas para este tipo de objeto en la búsqueda de productos de HubSpot.
Los nombres de las propiedades secundarias de este objeto. Se mostrarán como secundarias en la página de registro de HubSpot para este tipo de objeto.
Respuesta
successful operation
Defines an object schema, including its properties and associations.
Asociaciones definidas para un tipo de objeto determinado.
Show child attributes
Show child attributes
Un ID único para el tipo de objeto de este esquema. Se definirá como {meta-type}-{unique ID}.
Singular and plural labels for the object. Used in CRM display.
Show child attributes
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}Un nombre único para el tipo de objeto del esquema.
Propiedades definidas para este tipo de objeto.
Show child attributes
Show child attributes
Los nombres de las propiedades que deben ser obligatorias cuando se cree un objeto de este tipo.
Cuando se creó el esquema de objetos.
Un ID único asignado para el objeto, que incluye el ID del portal y el nombre del objeto.
El nombre de la propiedad principal de este objeto. Se mostrará como principal en la página de registro de HubSpot para este tipo de objeto.
Los nombres de las propiedades que serán indexadas para este tipo de objeto en la búsqueda de productos de HubSpot.
Los nombres de las propiedades secundarias de este objeto. Se mostrarán como secundarias en la página de registro de HubSpot para este tipo de objeto.
Cuando se actualizó por última vez el esquema de objetos.