Zum Hauptinhalt springen
POST
/
crm
/
v3
/
properties
/
{objectType}
Créer une propriété
curl --request POST \
  --url https://api.hubapi.com/crm/v3/properties/{objectType} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "hidden": false,
  "label": "My Contact Property",
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}'
{
  "createdResourceId": "<string>",
  "entity": {
    "displayOrder": 2,
    "fieldType": "select",
    "formField": true,
    "groupName": "contactinformation",
    "hasUniqueValue": false,
    "hidden": false,
    "label": "My Contact Property",
    "modificationMetadata": {
      "archivable": true,
      "readOnlyDefinition": false,
      "readOnlyOptions": false,
      "readOnlyValue": false
    },
    "name": "my_contact_property",
    "options": [
      {
        "description": "Choice number one",
        "displayOrder": 1,
        "hidden": false,
        "label": "Option A",
        "value": "A"
      },
      {
        "description": "Choice number two",
        "displayOrder": 2,
        "hidden": false,
        "label": "Option B",
        "value": "B"
      }
    ],
    "type": "enumeration"
  },
  "location": "<string>"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Starter
Cette API requiert l'une des portées suivantes :
crm.objects.carts.write
crm.objects.orders.write
crm.objects.users.write
crm.pipelines.orders.write
crm.schemas.appointments.write
crm.schemas.carts.write
crm.schemas.commercepayments.write
crm.schemas.companies.write
crm.schemas.contacts.write
crm.schemas.courses.write
crm.schemas.deals.write
crm.schemas.invoices.write
crm.schemas.listings.write
crm.schemas.orders.write
crm.schemas.services.write
crm.schemas.subscriptions.write
e-commerce
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required

Body

application/json
​
fieldType
enum<string>
required

Contrôle la façon dont la propriété apparaît dans HubSpot.

Verfügbare Optionen:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
​
groupName
string
required

Le nom du groupe de propriétés auquel appartient la propriété.

​
label
string
required

Un libellé de propriété qui sera affichée dans HubSpot lisible par les personnes.

​
name
string
required

Le nom interne de la propriété, qui doit être utilisé lorsque la propriété est référencée par le biais de l'API.

​
type
enum<string>
required

Le type de données de la propriété.

Verfügbare Optionen:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string
​
calculationFormula
string

Cela représente une formule utilisée pour calculer une propriété calculée.

​
dataSensitivity
enum<string>
Verfügbare Optionen:
highly_sensitive,
non_sensitive,
sensitive
​
description
string

Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.

​
displayOrder
integer

Les propriétés sont affichées dans l'ordre croissant en partant de la valeur entière positive la plus basse. Une valeur -1 fera apparaître la propriété après toute valeur positive.

​
externalOptions
boolean

Applicable uniquement aux propriétés de type « énumération ». Doit être définie sur « true » en conjonction avec un « referencedObjectType » de « OWNER ». Sinon, définir sur « false ».

​
formField
boolean

Si la propriété peut être utilisée dans un formulaire HubSpot ou non.

​
hasUniqueValue
boolean

Si la valeur de la propriété doit être unique ou non. Une fois définie, il n'est pas possible de le modifier.

​
hidden
boolean

Si vrai, l'option ne sera pas affichée dans des formulaires, des bots ou des pages de planification de réunions. Pris en charge pour les propriétés d'énumération de contacts, d'entreprises, de tickets et d'objets personnalisés.

​
options
object[]

Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées.

​
referencedObjectType
string

Cela doit être défini sur « OWNER » lorsque la valeur de « externalOptions » est « vrai », et entraîne l'extraction dynamique des valeurs des options des utilisateurs actuels de HubSpot par la propriété.

Response

successful operation

​
createdResourceId
string
required
​
entity
object
required

A HubSpot property

Example:
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "hidden": false,
  "label": "My Contact Property",
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": false,
    "readOnlyOptions": false,
    "readOnlyValue": false
  },
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}
​
location
string