Create a new property
Create a new property for a specified object type within a given app in the MediaBridge service. This endpoint allows you to define new properties that can be used to store additional information related to the object type. The request must include the necessary property details in the request body.
Supported products
Supported products
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the app where the property will be created.
The type of object for which the property is being created.
Body
A string indicating the field type for the property, such as 'booleancheckbox', 'calculation_equation', 'checkbox', 'date', 'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text', or 'textarea'.
booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea The name of the group to which the property belongs, represented as a string.
A string representing the display label for the property, used in user interfaces.
The unique name of the property. It is a string that identifies the property within the object type.
The data type of the property, which can be one of 'bool', 'date', 'datetime', 'enumeration', 'number', 'phone_number', or 'string'.
bool, date, datetime, enumeration, number, phone_number, string A string representing the formula used to calculate the property's value, applicable for calculated properties.
A string that specifies the name of the property used to determine the currency for currency-type properties.
A string indicating the sensitivity level of the data, such as 'PII' (Personally Identifiable Information).
highly_sensitive, non_sensitive, sensitive A string providing a description of the property, explaining its purpose or usage.
An integer that determines the order in which the property is displayed relative to other properties.
A boolean that specifies whether the property options are managed externally.
A boolean indicating whether the property is available for use in forms.
A boolean indicating whether the property must have a unique value across all records.
A boolean that specifies whether the property is hidden from user interfaces.
A string that provides a hint for displaying number properties, such as 'unformatted', 'formatted', 'currency', 'percentage', 'duration', or 'probability'.
currency, duration, formatted, percentage, probability, unformatted An array of OptionInput objects, specifying the options available for properties of type 'enumeration'.
A string that denotes the object type referenced by the property, if applicable.
A boolean indicating whether to display a currency symbol for currency-type properties.
A string that provides a hint for displaying text properties, such as 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', or 'postal_code'.
domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line Response
successful operation
A HubSpot property
An array of strings representing the object types that are allowed for this property.
A boolean indicating if the property is calculated.
A boolean indicating if the property can be archived.
A boolean indicating if the property can be restored.
A string representing the date and time when the property was created, in ISO 8601 format.
A string representing the user ID who created the property.
A string representing the name of the currency property associated with this property.
A string indicating the sensitivity level of the data.
high, none, standard A string providing a hint for displaying dates.
absolute, absolute_with_relative, time_since, time_until A boolean indicating if the property has been deleted.
A string providing a description of the property.
A string indicating the display mode of the property.
all_unique_versions, current_value An integer specifying the order in which the property is displayed.
A boolean indicating if uniqueness is enforced for multivalue properties.
A boolean indicating if the property has external options.
A string indicating the reference type for external options.
A boolean indicating if the property is marked as a favorite.
An integer specifying the order of the property among favorites.
A string indicating the field type of the property, such as 'booleancheckbox', 'calculation_equation', 'checkbox', 'date', 'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text', or 'textarea'.
A boolean indicating whether the property is used as a form field.
A string representing the user ID from which the property originates.
A string representing the name of the group to which the property belongs.
A boolean indicating if the property has a unique value.
A boolean indicating whether the property is hidden.
false
A boolean indicating if the property is defined by HubSpot.
A boolean indicating if the property is a customized default.
A boolean indicating if the property can have multiple values.
A boolean indicating if the property is partial.
A string representing the label of the property, used for display purposes.
A boolean indicating if the property definition is mutable but not deletable.
A string representing the name of the property.
A string providing a hint for displaying numbers, with options like 'unformatted', 'formatted', 'currency', 'percentage', 'duration', or 'probability'.
currency, duration, formatted, percentage, probability, unformatted A string indicating the strategy used to sort options.
ALPHABETICAL, DISPLAY_ORDER An array of options available for the property, applicable if the property type supports options.
A boolean indicating if the options for the property are mutable.
An integer representing the ID of the app that owns the property.
An integer representing the unique identifier for the portal.
A boolean indicating if the property's definition is read-only.
A boolean indicating if the property's value is read-only.
A string indicating the type of object referenced by the property.
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 A string indicating the mode of text analysis for search purposes.
NONE, NOT_ANALYZED_TEXT A boolean indicating if the property is searchable in global search.
An array of strings representing the categories of sensitive data associated with this property.
A boolean indicating if the currency symbol should be displayed for the property.
A string providing a hint for displaying text, with options like 'unformatted_single_line', 'multi_line', 'email', 'phone_number', 'domain_name', 'ip_address', 'physical_address', or 'postal_code'.
domain_name, email, ip_address, multi_line, phone_number, physical_address, postal_code, unformatted_single_line A string indicating the type of the property, such as 'bool', 'date', 'datetime', 'enumeration', 'number', 'phone_number', or 'string'.
bool, currency_number, date, datetime, enumeration, json, number, object_coordinates, phone_number, string A string representing the date and time when the property was last updated, in ISO 8601 format.