HubSpot: Imports schemas

← Imports operations · All schemas

Cancel an active import — response body

Field	Type	Presence	Description and constraints
$	object	Root
completedAt	string	Required within parent	The timestamp when the action was completed, in ISO 8601 format. Format: date-time
links	object	Optional	A map of link names to associated URIs containing documentation about the error or recommended remediation steps Additional keys: see wildcard field
links.*	string	Additional keys
requestedAt	string	Optional	The timestamp when the export request was made, in ISO 8601 format. Format: date-time
startedAt	string	Required within parent	The timestamp when the action was started, in ISO 8601 format. Format: date-time
status	string	Required within parent	An enum representing the lifecycle state of the action. Known values: CANCELED, COMPLETE, PENDING, PROCESSING

Create Import — response body

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	string	Required within parent	The timestamp when the object was created, in ISO 8601 format. Format: date-time
id	string	Required within parent	The unique identifier for this import.
importName	string	Optional	The user-provided name for this import.
importRequestJson	object	Optional	The complete import request configuration as a JSON object.
importSource	string	Optional	Indicates where/how the import was initiated. Known values: API, CRM_UI, IMPORT, MOBILE_ANDROID, MOBILE_IOS, SALESFORCE
importTemplate	Model	Optional	Expand Create Import — response body — import Template
mappedObjectTypeIds	array	Required within parent	An array of object type IDs that are mapped during the import.
mappedObjectTypeIds[]	string	Each item
metadata	Model	Required within parent	Expand Create Import — response body — metadata
optOutImport	boolean	Required within parent	Whether or not the import is a list of people disqualified from receiving emails.
state	string	Required within parent	The status of the import. Known values: CANCELED, DEFERRED, DONE, FAILED, PROCESSING, REVERTED, STARTED
updatedAt	string	Required within parent	The timestamp when the import record was last updated, formatted as an ISO 8601 instant. Format: date-time

Referenced models: Create Import — response body — import Template, Create Import — response body — metadata

Create Import — response body — import Template

Field	Type	Presence	Description and constraints
$	object	Root
templateId	JSON	Required within parent
templateId (anyOf 1)	integer	Alternative	The unique identifier for the specific saved template or previous import being referenced. Format: int64
templateId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
templateType	string	Required within parent	The classification of what type of template this represents, and what is its origin or purpose. Known values: admin_defined, previous_import, user_file

Create Import — response body — metadata

Field	Type	Presence	Description and constraints
$	object	Root
counters	object	Required within parent	Summarized outcomes of each row a developer attempted to import into HubSpot. Additional keys: see wildcard field
counters.*	JSON	Additional keys
counters.* (anyOf 1)	integer	Alternative	Format: int32
counters.* (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
fileIds	array	Required within parent	The IDs of files uploaded in the File Manager API.
fileIds[]	string	Each item
objectLists	array	Required within parent	The lists containing the imported objects.
objectLists[]	Model	Each item	Expand Create Import — response body — metadata object Lists item

Referenced models: Create Import — response body — metadata object Lists item

Create Import — response body — metadata object Lists item

Field	Type	Presence	Description and constraints
$	object	Root
listId	string	Required within parent	The ID of the list containing the imported objects.
objectType	string	Required within parent	The type of object contained in the list.

List Imports — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Imports — response body — paging
results	array	Required within parent	An array of PublicImportResponse objects, each representing an individual import response.
results[]	Model	Each item	Expand Create Import — response body

Referenced models: List Imports — response body — paging, Create Import — response body

List Imports — response body — paging

Field	Type	Presence	Description and constraints
$	object	Root	Paging information for forward-only pagination. Contains the next page reference when more results are available; omitted or empty on the last page.
next	Model	Optional	Expand List Imports — response body — paging next

Referenced models: List Imports — response body — paging next

List Imports — response body — paging next

Field	Type	Presence	Description and constraints
$	object	Root	Specifies the paging information needed to retrieve the next set of results in a paginated API response
after	string	Required within parent	A string token used as a cursor to fetch the next set of results in a paginated response.
link	string	Optional	A URL string that provides the link to the next page of results.

Retrieve errors for a specific import — response body

Field	Type	Presence	Description and constraints
$	object	Root
paging	Model	Optional	Expand List Imports — response body — paging
results	array	Required within parent	An array of public import errors, each represented by a PublicImportError object.
results[]	Model	Each item	Expand Retrieve errors for a specific import — response body — results item

Referenced models: List Imports — response body — paging, Retrieve errors for a specific import — response body — results item

Retrieve errors for a specific import — response body — results item

Field	Type	Presence	Description and constraints
$	object	Root
createdAt	JSON	Required within parent
createdAt (anyOf 1)	integer	Alternative	The epoch millisecond timestamp when this error was recorded. Format: int64
createdAt (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
errorMessage	string	Optional	A human-readable error message.
errorType	string	Required within parent	The classification of what went wrong during import processing. Known values: AMBIGUOUS_ENUMERATION_OPTION, ASSOCIATION_LABEL_NOT_FOUND, ASSOCIATION_LIMIT_EXCEEDED, ASSOCIATION_RECORD_NOT_FOUND, COLUMN_TOO_LARGE, COULD_NOT_FIND_BUSINESS_UNIT, COULD_NOT_FIND_OWNER, COULD_NOT_PARSE_DATE, COULD_NOT_PARSE_NUMBER, COULD_NOT_PARSE_ROW, COULD_NOT_PARSE_TERM, CREATE_ONLY_IMPORT, DUPLICATE_ALTERNATE_ID, DUPLICATE_ASSOCIATION_ID, DUPLICATE_EVENT, DUPLICATE_OBJECT_ID, DUPLICATE_RECORD_ID, DUPLICATE_ROW_CONTENT, DUPLICATE_UNIQUE_CREATION_KEY, DUPLICATE_UNIQUE_PROPERTY_VALUE, FAILED_TO_CREATE_ASSOCIATION, FAILED_TO_FIND_RECORD_FOR_ASSOCIATIONS, FAILED_TO_OPT_OUT_CONTACT, FAILED_TO_PROCESS_OBJECT_WITH_EMPTY_PROPERTY_VALUES, FAILED_VALIDATION, FILE_NOT_FOUND, GDPR_BLACKLISTED_EMAIL, INCORRECT_NUMBER_OF_COLUMNS, INVALID_ALTERNATE_ID, INVALID_ASSOCIATION_IDENTIFIER, INVALID_ASSOCIATION_KEY, INVALID_COLUMN_CONFIGURATION, INVALID_CUSTOM_PROPERTY_VALIDATION, INVALID_DOMAIN, INVALID_EMAIL, INVALID_ENUM_FILE_ID_OR_URL, INVALID_ENUMERATION_OPTION, INVALID_EVENT, INVALID_EVENT_TIMESTAMP, INVALID_FILE_TYPE, INVALID_NUMBER_SIZE, INVALID_OBJECT_ID, INVALID_PROPERTY_VALUE_FORMAT, INVALID_RECORD_ID, INVALID_REQUIRED_PROPERTY, INVALID_SHEET_COUNT, INVALID_SPREADSHEET, LIMIT_EXCEEDED, LINE_ITEM_MULTIPLE_PARENTS_IN_ROW, MANY_ERRORS_IN_ROW, MISSING_EVENT_DEFINITION, MISSING_EVENT_TIMESTAMP, MISSING_OBJECT_DEFINITION, MISSING_REQUIRED_PROPERTY, MULTIPLE_COMPANIES_WITH_THIS_DOMAIN, MULTIPLE_OWNERS_FOUND, NO_OBJECT_ID_FROM_ASSOCIATION_IDENTIFIER, OUTSIDE_VALID_TERM_RANGE, OUTSIDE_VALID_TIME_RANGE, PORTAL_WIDE_CUSTOM_OBJECT_LIMIT_EXCEEDED, PROPERTY_DEFINITION_NOT_FOUND, PROPERTY_VALUE_NOT_FOUND, ROW_DATA_TOO_LARGE, SECONDARY_EMAIL_WRITE_FAILURE, UNKNOWN_ASSOCIATION_RECORD_ID, UNKNOWN_BAD_REQUEST, UNKNOWN_ERROR, UPDATE_ONLY_IMPORT
extraContext	string	Optional	Additional human-readable context about the error.
id	string	Required within parent	A unique, stable identifier for this specific error.
invalidPropertyValue	Model	Optional	Expand Retrieve errors for a specific import — response body — results item invalid Property Value
invalidValue	string	Optional	The raw string value from the import file that caused the validation failure.
invalidValueToDisplay	string	Optional	A convenience accessor that returns either the value from `invalidPropertyValue` or `invalidValue`, whichever is present (preferring the property value).
knownColumnNumber	JSON	Optional
knownColumnNumber (anyOf 1)	integer	Alternative	The zero-based column index in the import file where the error occurred Format: int32
knownColumnNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
objectType	string	Optional	The CRM object type affected by this error. Known values: 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
objectTypeId	string	Optional	The modern object type identifier for the CRM object affected by this error.
sourceData	Model	Required within parent	Expand Retrieve errors for a specific import — response body — results item source Data

Referenced models: Retrieve errors for a specific import — response body — results item source Data, Retrieve errors for a specific import — response body — results item invalid Property Value

Retrieve errors for a specific import — response body — results item invalid Property Value

Field	Type	Presence	Description and constraints
$	object	Root	Represents a single custom property of a marketing event, storing its name, value, metadata (like source, timestamp, and sensitivity), and related audit information for tracking changes.
dataSensitivity	string	Required within parent	A string indicating the sensitivity level of the data. Valid values are 'none', 'standard', and 'high'. Known values: high, none, standard
isEncrypted	boolean	Required within parent	A boolean indicating whether the property value is encrypted.
isLargeValue	boolean	Required within parent	Indicates if the value exceeds normal size limits.
maskedSubstrings	Model	Required within parent	Expand Retrieve errors for a specific import — response body — results item invalid Property Value masked Substrings
name	string	Required within parent	The name of the property, represented as a string.
persistenceTimestamp	JSON	Required within parent
persistenceTimestamp (anyOf 1)	integer	Alternative	When the value was persisted to database, in epoch milliseconds. Format: int64
persistenceTimestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
requestId	string	Required within parent	A string identifier for the request associated with the property value.
selectedByUser	boolean	Required within parent	A boolean indicating whether the property value was selected by a user.
selectedByUserTimestamp	JSON	Required within parent
selectedByUserTimestamp (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when the user selected the property value. Format: int64
selectedByUserTimestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
source	string	Required within parent	A string indicating the origin of the property value. Valid values include various sources such as 'API', 'FORM', 'SALESFORCE', and others. Known values: ACADEMY, ACCEPTANCE_TEST, ACTIVITY_AUTO_ASSOCIATE, ACTIVITY_LOG_REVERT, ADS, AI_GROUP, ANALYTICS, API, APPROVALS, ASSISTS, ASSOCIATIONS, AUTO_ASSOCIATE_BY_DOMAIN, AUTOMATION_JOURNEY, AUTOMATION_PLATFORM, AVATARS_SERVICE, BATCH_UPDATE, BCC_TO_CRM, BEHAVIORAL_EVENTS, BET_ASSIGNMENT, BET_CRM_CONNECTOR, BIDEN, BILLING, BOT, BREEZE_AGENT, CALCULATED, CENTRAL_EXCHANGE_RATES, CHATSPOT, CLONE_OBJECTS, COMMUNICATOR, COMPANIES, COMPANY_FAMILIES, COMPANY_INSIGHTS, CONNECTED_ACCOUNT, CONTACTS, CONTACTS_WEB, CONTENT_MEMBERSHIP, CONVERSATIONAL_ENRICHMENT, CONVERSATIONS, CRM_PROCESSES_PLATFORM, CRM_UI, CRM_UI_BULK_ACTION, CUSTOMER_AGENT, CUSTOMER_PORTAL, DATA_ENRICHMENT, DATA_QUALITY, DATASET, DEALS, DEFAULT, DELETE_OBJECTS, DI_WRITE_TO_CRM, EMAIL, EMAIL_INBOX_IMPORT, EMAIL_INTEGRATION, ENGAGEMENTS, EXTENSION, FILE_MANAGER, FLYWHEEL_PRODUCT_DATA_SYNC, FORECASTING, FORM, FORWARD_TO_CRM, GMAIL_INTEGRATION, GOALS, HEISENBERG, HELP_DESK, HELP_DESK_AI, IMPORT, INTEGRATION, INTEGRATIONS_PLATFORM, INTEGRATIONS_SYNC, INTENT, INTERNAL_PROCESSING, LEADIN, LEGAL_BASIS_REMEDIATION, MARKET_SOURCING, MARKETPLACE, MARKETS, MEETINGS, MERGE_COMPANIES, MERGE_CONTACTS, MERGE_OBJECTS, MERGE_REVERT_OBJECTS, MICROAPPS, MIGRATION, MOBILE_ANDROID, MOBILE_IOS, PAYMENTS, PIPELINE_SETTINGS, PLAYBOOKS, PORTAL_OBJECT_SYNC, PORTAL_USER_ASSOCIATOR, PRESENTATIONS, PRIMARY_AUTOMATION, PROPERTY_DEFAULT_VALUE, PROPERTY_RESTORE, PROPERTY_SETTINGS, PROSPECTING_AGENT, QUOTAS, QUOTES, RECYCLING_BIN, RESTORE_OBJECTS, REVENUE_PLATFORM, SALES, SALES_MESSAGES, SALESFORCE, SEQUENCES, SETTINGS, SIDEKICK, SIGNALS, SLACK_INTEGRATION, SMART_DATA_CAPTURE, SOCIAL, SUCCESS, TALLY, TASK, UNKNOWN, WAL_INCREMENTAL, WORK_UI, WORKFLOW_CONTACT_DELETE_ACTION, WORKFLOWS
sourceId	string	Required within parent	A string identifier for the source of the property value.
sourceLabel	string	Required within parent	A string label describing the source of the property value.
sourceMetadata	string	Required within parent	A string containing metadata about the source of the property value.
sourceUpstreamDeployable	string	Required within parent	A string indicating the upstream deployable source of the property value.
sourceVid	array	Required within parent	An array of integers representing the source video IDs associated with the property value.
sourceVid[]	JSON	Each item
sourceVid[] (anyOf 1)	integer	Alternative	Format: int64
sourceVid[] (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
timestamp	JSON	Required within parent
timestamp (anyOf 1)	integer	Alternative	A Unix timestamp in milliseconds indicating when the property value was recorded. Format: int64
timestamp (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
unit	string	Required within parent	A string representing the unit of the property value, if applicable.
updatedByUserId	JSON	Required within parent
updatedByUserId (anyOf 1)	integer	Alternative	An integer representing the ID of the user who last updated the property value. Format: int32
updatedByUserId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
useTimestampAsPersistenceTimestamp	boolean	Required within parent	Flag indicating whether to use the timestamp field as the persistence timestamp.
value	string	Required within parent	The actual value of the property, represented as a string.

Referenced models: Retrieve errors for a specific import — response body — results item invalid Property Value masked Substrings

Retrieve errors for a specific import — response body — results item invalid Property Value masked Substrings

Field	Type	Presence	Description and constraints
$	object	Root
substrings	array	Required within parent	An array of MaskedSubstring objects, each defining a specific portion of a string to be masked. This property is required and ensures that sensitive data is appropriately obscured.
substrings[]	Model	Each item	Expand Retrieve errors for a specific import — response body — results item invalid Property Value masked Substrings substrings item

Referenced models: Retrieve errors for a specific import — response body — results item invalid Property Value masked Substrings substrings item

Retrieve errors for a specific import — response body — results item invalid Property Value masked Substrings substrings item

Field	Type	Presence	Description and constraints
$	object	Root
end	JSON	Required within parent
end (anyOf 1)	integer	Alternative	An integer indicating the ending position of the substring. Format: int32
end (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
label	string	Required within parent
start	JSON	Required within parent
start (anyOf 1)	integer	Alternative	An integer indicating the starting position of the substring. Format: int32
start (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$

Retrieve errors for a specific import — response body — results item source Data

Field	Type	Presence	Description and constraints
$	object	Root
additionalRowData	array	Required within parent	An array of strings containing any additional data associated with this row.
additionalRowData[]	string	Each item
containsEncryptedProperties	boolean	Required within parent	Indicates whether this row contains values that were encrypted.
fileId	JSON	Required within parent
fileId (anyOf 1)	integer	Alternative	The unique identifier of the uploaded file containing this row. Format: int64
fileId (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
lineNumber	JSON	Required within parent
lineNumber (anyOf 1)	integer	Alternative	The 1-indexed line number of this row in the source file. Line number 0 is reserved for file-wide errors that don't correspond to a specific row. Format: int32
lineNumber (anyOf 2)	string	Alternative	Pattern: ^-?[0-9]+(?:\.[0-9]+)?(?:[eE][+-]?[0-9]+)?$
pageName	string	Optional	The name of the spreadsheet sheet/page containing this row.
rowData	array	Required within parent	An array of strings representing the core data of the row.
rowData[]	string	Each item