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"
}'
{
  "location": "<string>",
  "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"
  }
}
Produits pris en charge
Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubStarter

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • crm.schemas.invoices.write
  • crm.schemas.orders.write
  • crm.schemas.commercepayments.write
  • crm.objects.orders.write
  • crm.schemas.contacts.write
  • tickets
  • tickets.sensitive.v2
  • e-commerce
  • crm.schemas.appointments.write
  • crm.schemas.courses.write
  • crm.schemas.carts.write
  • tickets.highly_sensitive.v2
  • crm.schemas.services.write
  • crm.schemas.deals.write
  • crm.pipelines.orders.write
  • crm.objects.users.write
  • crm.schemas.companies.write
  • crm.schemas.subscriptions.write
  • crm.schemas.listings.write
  • crm.objects.carts.write

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
​
label
string
required

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

Example:

"My Contact Property"

​
type
enum<string>
required

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

Available options:
bool,
date,
datetime,
enumeration,
number,
phone_number,
string
Example:

"enumeration"

​
groupName
string
required

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

Example:

"contactinformation"

​
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.

​
fieldType
enum<string>
required

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

Available options:
booleancheckbox,
calculation_equation,
checkbox,
date,
file,
html,
number,
phonenumber,
radio,
select,
text,
textarea
Example:

"select"

​
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.

​
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.

Example:

2

​
description
string

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

​
formField
boolean

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

​
dataSensitivity
enum<string>
Available options:
non_sensitive,
sensitive,
highly_sensitive
​
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é.

​
options
object[]

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

Example:

"[{\"label\":\"Option A\",\"value\":\"A\",\"hidden\":false,\"description\":\"Choice number one\",\"displayOrder\":1},{\"label\":\"Option B\",\"value\":\"B\",\"hidden\":false,\"description\":\"Choice number two\",\"displayOrder\":2}]"

​
calculationFormula
string

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

​
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.

​
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 ».

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
⌘I