Créer une nouvelle propriété

curl --request POST \
  --url 'https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldType": "booleancheckbox",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "type": "bool",
  "calculationFormula": "<string>",
  "dataSensitivity": "highly_sensitive",
  "description": "<string>",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": true,
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "referencedObjectType": "<string>"
}
'

{
  "allowedObjectTypes": [
    {
      "innerId": 123,
      "metaTypeId": 123
    }
  ],
  "calculated": true,
  "canArchive": true,
  "canRestore": true,
  "createdAt": 123,
  "createdUserId": 123,
  "currencyPropertyName": "<string>",
  "dataSensitivity": "high",
  "dateDisplayHint": "absolute",
  "deleted": true,
  "description": "<string>",
  "displayMode": "all_unique_versions",
  "displayOrder": 123,
  "enforceMultivalueUniqueness": true,
  "externalOptions": true,
  "externalOptionsReferenceType": "<string>",
  "favorited": true,
  "favoritedOrder": 123,
  "fieldType": "<string>",
  "formField": true,
  "fromUserId": 123,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "isCustomizedDefault": true,
  "isMultiValued": true,
  "isPartial": true,
  "label": "<string>",
  "mutableDefinitionNotDeletable": true,
  "name": "<string>",
  "numberDisplayHint": "currency",
  "optionSortStrategy": "ALPHABETICAL",
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "doubleData": 123,
      "hidden": true,
      "label": "<string>",
      "readOnly": true,
      "value": "<string>"
    }
  ],
  "optionsAreMutable": true,
  "owningAppId": 123,
  "portalId": 123,
  "readOnlyDefinition": true,
  "readOnlyValue": true,
  "referencedObjectType": "ABANDONED_CART",
  "searchTextAnalysisMode": "NONE",
  "searchableInGlobalSearch": true,
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "type": "bool",
  "updatedAt": 123
}

POST

media-bridge

{appId}

properties

{objectType}

Créer une nouvelle propriété

curl --request POST \
  --url 'https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}?hapikey=' \
  --header 'Content-Type: application/json' \
  --data '
{
  "fieldType": "booleancheckbox",
  "groupName": "<string>",
  "label": "<string>",
  "name": "<string>",
  "type": "bool",
  "calculationFormula": "<string>",
  "dataSensitivity": "highly_sensitive",
  "description": "<string>",
  "displayOrder": 123,
  "externalOptions": true,
  "formField": true,
  "hasUniqueValue": true,
  "hidden": true,
  "options": [
    {
      "displayOrder": 123,
      "hidden": true,
      "label": "<string>",
      "value": "<string>",
      "description": "<string>"
    }
  ],
  "referencedObjectType": "<string>"
}
'

{
  "allowedObjectTypes": [
    {
      "innerId": 123,
      "metaTypeId": 123
    }
  ],
  "calculated": true,
  "canArchive": true,
  "canRestore": true,
  "createdAt": 123,
  "createdUserId": 123,
  "currencyPropertyName": "<string>",
  "dataSensitivity": "high",
  "dateDisplayHint": "absolute",
  "deleted": true,
  "description": "<string>",
  "displayMode": "all_unique_versions",
  "displayOrder": 123,
  "enforceMultivalueUniqueness": true,
  "externalOptions": true,
  "externalOptionsReferenceType": "<string>",
  "favorited": true,
  "favoritedOrder": 123,
  "fieldType": "<string>",
  "formField": true,
  "fromUserId": 123,
  "groupName": "<string>",
  "hasUniqueValue": true,
  "hidden": false,
  "hubspotDefined": true,
  "isCustomizedDefault": true,
  "isMultiValued": true,
  "isPartial": true,
  "label": "<string>",
  "mutableDefinitionNotDeletable": true,
  "name": "<string>",
  "numberDisplayHint": "currency",
  "optionSortStrategy": "ALPHABETICAL",
  "options": [
    {
      "description": "<string>",
      "displayOrder": 123,
      "doubleData": 123,
      "hidden": true,
      "label": "<string>",
      "readOnly": true,
      "value": "<string>"
    }
  ],
  "optionsAreMutable": true,
  "owningAppId": 123,
  "portalId": 123,
  "readOnlyDefinition": true,
  "readOnlyValue": true,
  "referencedObjectType": "ABANDONED_CART",
  "searchTextAnalysisMode": "NONE",
  "searchableInGlobalSearch": true,
  "sensitiveDataCategories": [
    "<string>"
  ],
  "showCurrencySymbol": true,
  "textDisplayHint": "domain_name",
  "type": "bool",
  "updatedAt": 123
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.

Marketing HubGratuit

Sales HubGratuit

Service HubGratuit

Content HubGratuit

Autorisations

hapikey

string

query

requis

Paramètres de chemin

appId

integer<int32>

requis

L'appId de l'application Media Bridge. Il est possible d'avoir plusieurs applications dans votre compte développeur qui utilisent le Media Bridge.

objectType

string

requis

Le type d'objet pour lequel la nouvelle propriété doit être créée.

Corps

application/json

fieldType

enum<string>

requis

Options disponibles:

booleancheckbox,

calculation_equation,

checkbox,

date,

file,

html,

number,

phonenumber,

radio,

select,

text,

textarea

groupName

string

requis

label

string

requis

name

string

requis

type

enum<string>

requis

Options disponibles:

bool,

date,

datetime,

enumeration,

number,

phone_number,

string

calculationFormula

string

dataSensitivity

enum<string>

Options disponibles:

highly_sensitive,

non_sensitive,

sensitive

description

string

displayOrder

integer<int32>

externalOptions

boolean

formField

boolean

hasUniqueValue

boolean

hidden

boolean

options

object[]

Afficher attributs enfants

referencedObjectType

string

Réponse

successful operation

A HubSpot property

allowedObjectTypes

object[]

requis

Types d'objets autorisés à utiliser cette propriété.

Afficher attributs enfants

calculated

boolean

requis

Si la propriété est un champ calculé.

canArchive

boolean

requis

canRestore

boolean

requis

createdAt

integer<int64>

requis

Date à laquelle la propriété a été créée, au format ISO 8601.

createdUserId

integer<int64>

requis

L'ID de l'utilisateur qui a créé la propriété.

currencyPropertyName

string

requis

Le nom de la propriété de la devise associée.

dataSensitivity

enum<string>

requis

Indique le niveau de sensibilité de la propriété, par exemple « non_sensitive », « sensitive » ou « highly_sensitive ».

Options disponibles:

high,

none,

standard

dateDisplayHint

enum<string>

requis

Options disponibles:

absolute,

absolute_with_relative,

time_since,

time_until

deleted

boolean

requis

Indique si la propriété a été supprimée.

description

string

requis

Un résumé de l'objectif de la propriété.

displayMode

enum<string>

requis

Mode d'affichage de la propriété. Peut être : « current_value » ou « all_unique_versions ».

Options disponibles:

all_unique_versions,

current_value

displayOrder

integer<int32>

requis

La position de l'élément par rapport aux autres éléments de la liste.

enforceMultivalueUniqueness

boolean

requis

externalOptions

boolean

requis

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

externalOptionsReferenceType

string

requis

Lorsque externalOptions est défini sur true, cela indique que les valeurs d'option de la propriété seront renseignées à partir d'autres systèmes (par exemple, « OWNER » pour la propriété hubspot_owner_id).

favorited

boolean

requis

Obsolète. Indique si la propriété est marquée comme favorite.

favoritedOrder

integer<int32>

requis

Obsolète. La position de l'ordre lorsqu'il est marqué comme favori.

fieldType

string

requis

Détermine comment la propriété apparaîtra dans l'interface utilisateur de HubSpot ou sur un formulaire. Pour en savoir plus, consultez le guide de l'API sur les propriétés.

formField

boolean

requis

Si la propriété peut apparaître sur les formulaires.

fromUserId

integer<int64>

requis

L'ID de l'utilisateur qui a mis à jour la propriété pour la dernière fois.

groupName

string

requis

Le nom du groupe auquel la propriété est attribuée.

hasUniqueValue

boolean

requis

Indique si la propriété est une propriété à identifiant unique.

hidden

boolean

requis

Si la propriété sera masquée de l'interface utilisateur HubSpot ou non. Il est recommandé de laisser la valeur définie sur « faux » pour les propriétés personnalisées.

Exemple:

false

hubspotDefined

boolean

requis

Une valeur booléenne fixée à true pour les propriétés par défaut de HubSpot.

isCustomizedDefault

boolean

requis

Pour les propriétés par défaut, indique si la propriété a été personnalisée. Équivalent du champ « isCustomizedDefault ».

isMultiValued

boolean

requis

Si la propriété peut contenir plusieurs valeurs.

isPartial

boolean

requis

Pour les propriétés par défaut, indique si la propriété a été personnalisée. Équivalent du champ « isCustomizedDefault ».

label

string

requis

Le libellé d'affichage de la propriété.

mutableDefinitionNotDeletable

boolean

requis

Si la définition de la propriété peut être personnalisée mais pas supprimée.

name

string

requis

Le nom interne de la propriété.

numberDisplayHint

enum<string>

requis

Indication sur la manière dont une propriété numérique est affichée et validée dans l'interface utilisateur de HubSpot. Peut être : « non formaté », « formaté », « devise », « pourcentage », « durée » ou « probabilité ».

Options disponibles:

currency,

duration,

formatted,

percentage,

probability,

unformatted

optionSortStrategy

enum<string>

requis

Spécifie comment trier les options de propriété. Peut être soit « DISPLAY_ORDER » pour se référer au champ displayOrder, soit « ALPHABETICAL ».

Options disponibles:

ALPHABETICAL,

DISPLAY_ORDER

options

object[]

requis

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

Afficher attributs enfants

optionsAreMutable

boolean

requis

Si les options peuvent être modifiées après la création.

owningAppId

integer<int64>

requis

portalId

integer<int64>

requis

L'ID du compte HubSpot où la propriété est définie.

readOnlyDefinition

boolean

requis

Indique si la description de la propriété est en lecture seule.

readOnlyValue

boolean

requis

Indique si la valeur de la propriété est en lecture seule.

referencedObjectType

enum<string>

requis

Obsolète. Utilisez plutôt externalOptionsReferenceType.

Options disponibles:

ABANDONED_CART,

ACCEPTANCE_TEST,

AD,

AD_ACCOUNT,

AD_CAMPAIGN,

AD_GROUP,

AI_FORECAST,

ALL_PAGES,

APPROVAL,

APPROVAL_STEP,

ATTRIBUTION,

AUDIENCE,

AUTOMATION_JOURNEY,

AUTOMATION_PLATFORM_FLOW,

AUTOMATION_PLATFORM_FLOW_ACTION,

BET_ALERT,

BET_DELIVERABLE_SERVICE,

BLOG_LISTING_PAGE,

BLOG_POST,

CALL,

CAMPAIGN,

CAMPAIGN_BUDGET_ITEM,

CAMPAIGN_SPEND_ITEM,

CAMPAIGN_STEP,

CAMPAIGN_TEMPLATE,

CAMPAIGN_TEMPLATE_STEP,

CART,

CASE_STUDY,

CHATFLOW,

CLIP,

CMS_URL,

COMBO_EVENT_CONFIGURATION,

COMMERCE_PAYMENT,

COMMUNICATION,

COMPANY,

CONTACT,

CONTACT_CREATE_ATTRIBUTION,

CONTENT,

CONTENT_AUDIT,

CONTENT_AUDIT_PAGE,

CONVERSATION,

CONVERSATION_INBOX,

CONVERSATION_SESSION,

CRM_OBJECTS_DUMMY_TYPE,

CRM_PIPELINES_DUMMY_TYPE,

CTA,

CTA_VARIANT,

DATA_PRIVACY_CONSENT,

DATA_SYNC_STATE,

DEAL,

DEAL_CREATE_ATTRIBUTION,

DEAL_REGISTRATION,

DEAL_SPLIT,

DISCOUNT,

DISCOUNT_CODE,

DISCOUNT_TEMPLATE,

EMAIL,

ENGAGEMENT,

EXPORT,

EXTERNAL_WEB_URL,

FEE,

FEEDBACK_SUBMISSION,

FEEDBACK_SURVEY,

FILE_MANAGER_FILE,

FILE_MANAGER_FOLDER,

FOLDER,

FORECAST,

FORM,

FORM_SUBMISSION_INBOUNDDB,

GOAL_TARGET,

GOAL_TARGET_GROUP,

GOAL_TEMPLATE,

GSC_PROPERTY,

HUB,

IMPORT,

INVOICE,

KEYWORD,

KNOWLEDGE_ARTICLE,

LANDING_PAGE,

LEAD,

LINE_ITEM,

MARKETING_CALENDAR,

MARKETING_CAMPAIGN_UTM,

MARKETING_EMAIL,

MARKETING_EVENT,

MARKETING_EVENT_ATTENDANCE,

MARKETING_SMS,

MEDIA_BRIDGE,

MEETING_EVENT,

MIC,

NOTE,

OBJECT_LIST,

ORDER,

OWNER,

PARTNER_ACCOUNT,

PARTNER_CLIENT,

PARTNER_CLIENT_REVENUE,

PARTNER_SERVICE,

PAYMENT_LINK,

PAYMENT_SCHEDULE,

PAYMENT_SCHEDULE_INSTALLMENT,

PERMISSIONS_TESTING,

PLAYBOOK,

PLAYBOOK_QUESTION,

PLAYBOOK_SUBMISSION,

PLAYBOOK_SUBMISSION_ANSWER,

PLAYLIST,

PLAYLIST_FOLDER,

PODCAST_EPISODE,

PORTAL,

PORTAL_OBJECT_SYNC_MESSAGE,

POSTAL_MAIL,

PRIVACY_SCANNER_COOKIE,

PRODUCT,

PRODUCT_OR_FOLDER,

PROPERTY_INFO,

PROSPECTING_AGENT_CONTACT_ASSIGNMENT,

PUBLISHING_TASK,

QUARANTINED_SUBMISSION,

QUOTA,

QUOTE,

QUOTE_FIELD,

QUOTE_MODULE,

QUOTE_MODULE_FIELD,

QUOTE_TEMPLATE,

RESTORABLE_CRM_OBJECT,

ROSTER,

ROSTER_MEMBER,

SALES_DOCUMENT,

SALES_TASK,

SALES_WORKLOAD,

SALESFORCE_SYNC_ERROR,

SCHEDULING_PAGE,

SCHEMAS_BACKEND_TEST,

SCORE_CONFIGURATION,

SEQUENCE,

SEQUENCE_ENROLLMENT,

SEQUENCE_STEP,

SEQUENCE_STEP_ENROLLMENT,

SERVICE,

SITE_PAGE,

SNIPPET,

SOCIAL_BROADCAST,

SOCIAL_CHANNEL,

SOCIAL_POST,

SOCIAL_PROFILE,

SOX_PROTECTED_DUMMY_TYPE,

SOX_PROTECTED_TEST_TYPE,

SUBMISSION_TAG,

SUBSCRIPTION,

TASK,

TASK_TEMPLATE,

TAX,

TEMPLATE,

TICKET,

UNKNOWN,

UNSUBSCRIBE,

USER,

VIEW,

VIEW_BLOCK,

WEB_INTERACTIVE

searchTextAnalysisMode

enum<string>

requis

Options disponibles:

NONE,

NOT_ANALYZED_TEXT

searchableInGlobalSearch

boolean

requis

Si la propriété peut faire l'objet d'une recherche à l'échelle mondiale.

sensitiveDataCategories

string[]

requis

Lorsque sensitiveData est vrai, liste le type de données sensibles contenues dans la propriété (par exemple, « HIPAA »).

showCurrencySymbol

boolean

requis

Afficher ou non le symbole de la devise dans l'interface utilisateur de HubSpot.

textDisplayHint

enum<string>

requis

Indication sur la manière dont le texte est affiché et validé dans l'interface utilisateur de HubSpot. Peut être = : « unformatted_single_line », « multi_line », « email », « phone_number », « domain_name », « ip_address », « physical_address » ou « postal_code ».

Options disponibles:

domain_name,

email,

ip_address,

multi_line,

phone_number,

physical_address,

postal_code,

unformatted_single_line

type

enum<string>

requis

Le type de données de la propriété, par exemple une chaîne ou un nombre.

Options disponibles:

bool,

currency_number,

date,

datetime,

enumeration,

json,

number,

object_coordinates,

phone_number,

string

updatedAt

integer<int64>

requis

L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO 8601.

Last modified on September 3, 2025

Obtenir les propriétés d'un type d'objet.

Obtenir les détails d'une propriété

⌘I

Articles de blog

Paramètres du blog

Balises de blog

HubDB

Pages

Auteurs de blog

Code source CMS

Audit de contenu

Redirections d'URL

Domaines

Media Bridge

Recherche de site

Fichiers

Créer une nouvelle propriété

Autorisations

Paramètres de chemin

Corps

Réponse