Skip to main content

HubSpot

Manage your HubSpot account.

HubSpot Logo

Authentication​

This connector uses OAuth 2.0 authentication.

info

Set up your connection in the Abstra Console before using it in your workflows.

How to use​

Using the Smart Chat​

Execute the action "CHOOSE_ONE_ACTION_BELOW" from my connector "YOUR_CONNECTOR_NAME" using the params "PARAMS_HERE".

Using the Web Editor​

from abstra.connectors import run_connection_action

result = run_connection_action(
  connection_name="your_connection_name",
  action_name="your_action_name",
  params={
    "param1": "value1",
    "param2": "value2"
  })

Available Actions​

This connector provides 985 actions:

ActionParameters
account_info/get_account_info_v3_activity_loginafter (string)
limit (integer)
userId (integer)
account_info/get_account_info_v3_activity_audit_logsafter (string)
limit (integer)
actingUserId (array)
occurredAfter (string)
occurredBefore (string)
sort (array)
account_info/get_account_info_v3_api_usage_daily
account_info/get_account_info_v3_details
account_info/get_account_info_v3_activity_securityafter (string)
limit (integer)
userId (integer)
fromTimestamp (integer)
actions_v4/post_automation_v4_actions_callbacks_by_callback_id_completecallbackId (string)
data: {
. outputFields (object)
} (object) required
actions_v4/post_automation_v4_actions_callbacks_completedata: {
. inputs (array)
} (object) required
actions_v4/get_automation_v4_actions_by_app_idappId (integer)
limit (integer)
after (string)
archived (boolean)
actions_v4/post_automation_v4_actions_by_app_idappId (integer)
data: {
. inputFields (array)
. outputFields (array)
. archivedAt (integer)
. functions (array)
. actionUrl (string)
. inputFieldDependencies (array)
. published (boolean)
. executionRules (array)
. objectTypes (array)
. objectRequestOptions
. labels (object)
} (object) required
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_functionsdefinitionId (string)
appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_typedefinitionId (string)
functionType (string)
appId (integer)
actions_v4/put_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_typedefinitionId (string)
functionType (string)
appId (integer)
actions_v4/delete_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_typedefinitionId (string)
functionType (string)
appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_revisions_by_revision_iddefinitionId (string)
revisionId (string)
appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_iddefinitionId (string)
appId (integer)
archived (boolean)
actions_v4/delete_automation_v4_actions_by_app_id_by_definition_iddefinitionId (string)
appId (integer)
actions_v4/patch_automation_v4_actions_by_app_id_by_definition_iddefinitionId (string)
appId (integer)
data: {
. inputFields (array)
. outputFields (array)
. actionUrl (string)
. inputFieldDependencies (array)
. published (boolean)
. executionRules (array)
. objectTypes (array)
. objectRequestOptions
. labels (object)
} (object) required
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type_by_function_iddefinitionId (string)
functionType (string)
functionId (string)
appId (integer)
actions_v4/put_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type_by_function_iddefinitionId (string)
functionType (string)
functionId (string)
appId (integer)
actions_v4/delete_automation_v4_actions_by_app_id_by_definition_id_functions_by_function_type_by_function_iddefinitionId (string)
functionType (string)
functionId (string)
appId (integer)
actions_v4/get_automation_v4_actions_by_app_id_by_definition_id_revisionsdefinitionId (string)
appId (integer)
limit (integer)
after (string)
appointments/post_crm_v3_objects_by_object_type_batch_readobjectType (string)
archived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
appointments/get_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
appointments/delete_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
appointments/patch_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
appointments/post_crm_v3_objects_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
appointments/post_crm_v3_objects_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
appointments/post_crm_v3_objects_by_object_type_batch_updateobjectType (string)
data: {
. inputs (array)
} (object) required
appointments/get_crm_v3_objects_by_object_typeobjectType (string)
limit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
appointments/post_crm_v3_objects_by_object_typeobjectType (string)
data: {
. associations (array)
. properties (object)
} (object) required
appointments/post_crm_v3_objects_by_object_type_batch_upsertobjectType (string)
data: {
. inputs (array)
} (object) required
appointments/post_crm_v3_objects_by_object_type_searchobjectType (string)
data: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
app_uninstalls/delete_appinstalls_v3_external_install
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_archivefromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_createfromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
associations/post_crm_v4_associations_usage_high_usage_report_by_user_iduserId (integer)
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_labels_archivefromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_readfromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
associations/post_crm_v4_associations_by_from_object_type_by_to_object_type_batch_associate_defaultfromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
associations/put_crm_v4_objects_by_object_type_by_object_id_associations_by_to_object_type_by_to_object_idobjectType (string)
objectId (string)
toObjectType (string)
toObjectId (string)
data (array) required
associations/delete_crm_v4_objects_by_object_type_by_object_id_associations_by_to_object_type_by_to_object_idobjectType (string)
objectId (string)
toObjectType (string)
toObjectId (string)
associations/get_crm_v4_objects_by_object_type_by_object_id_associations_by_to_object_typeobjectType (string)
objectId (string)
toObjectType (string)
after (string)
limit (integer)
associations/put_crm_v4_objects_by_from_object_type_by_from_object_id_associations_default_by_to_object_type_by_to_object_idfromObjectType (string)
fromObjectId (string)
toObjectType (string)
toObjectId (string)
associations_schema/get_crm_v4_associations_definitions_configurations_all
associations_schema/get_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_typefromObjectType (string)
toObjectType (string)
associations_schema/post_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_type_batch_createfromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
associations_schema/get_crm_v4_associations_by_from_object_type_by_to_object_type_labelsfromObjectType (string)
toObjectType (string)
associations_schema/put_crm_v4_associations_by_from_object_type_by_to_object_type_labelsfromObjectType (string)
toObjectType (string)
data: {
. inverseLabel (string)
. associationTypeId (integer)
. label (string)
} (object) required
associations_schema/post_crm_v4_associations_by_from_object_type_by_to_object_type_labelsfromObjectType (string)
toObjectType (string)
data: {
. inverseLabel (string)
. name (string)
. label (string)
} (object) required
associations_schema/post_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_type_batch_purgefromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
associations_schema/delete_crm_v4_associations_by_from_object_type_by_to_object_type_labels_by_association_type_idfromObjectType (string)
toObjectType (string)
associationTypeId (integer)
associations_schema/post_crm_v4_associations_definitions_configurations_by_from_object_type_by_to_object_type_batch_updatefromObjectType (string)
toObjectType (string)
data: {
. inputs (array)
} (object) required
audit_logs/get_account_info_v3_activity_loginafter (string)
limit (integer)
userId (integer)
audit_logs/get_account_info_v3_activity_audit_logsafter (string)
limit (integer)
actingUserId (array)
occurredAfter (string)
occurredBefore (string)
sort (array)
audit_logs/get_account_info_v3_api_usage_daily
audit_logs/get_account_info_v3_details
audit_logs/get_account_info_v3_activity_securityafter (string)
limit (integer)
userId (integer)
fromTimestamp (integer)
authors/get_cms_v3_blogs_authors_by_object_idobjectId (string)
archived (boolean)
property (string)
authors/delete_cms_v3_blogs_authors_by_object_idobjectId (string)
archived (boolean)
authors/patch_cms_v3_blogs_authors_by_object_idobjectId (string)
archived (boolean)
data: {
. website (string)
. displayName (string)
. created (string)
. facebook (string)
. fullName (string)
. bio (string)
. language (string)
. linkedin (string)
. avatar (string)
. translatedFromId (integer)
. twitter (string)
. deletedAt (string)
. name (string)
. id (string)
. updated (string)
. email (string)
. slug (string)
} (object) required
authors/post_cms_v3_blogs_authors_batch_updatearchived (boolean)
data: {
. inputs (array)
} (object) required
authors/post_cms_v3_blogs_authors_multi_language_detach_from_lang_groupdata: {
. id (string)
} (object) required
authors/put_cms_v3_blogs_authors_multi_language_set_new_lang_primarydata: {
. id (string)
} (object) required
authors/post_cms_v3_blogs_authors_batch_archivedata: {
. inputs (array)
} (object) required
authors/post_cms_v3_blogs_authors_batch_createdata: {
. inputs (array)
} (object) required
authors/post_cms_v3_blogs_authors_batch_readarchived (boolean)
data: {
. inputs (array)
} (object) required
authors/get_cms_v3_blogs_authorscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
property (string)
authors/post_cms_v3_blogs_authorsdata: {
. website (string)
. displayName (string)
. created (string)
. facebook (string)
. fullName (string)
. bio (string)
. language (string)
. linkedin (string)
. avatar (string)
. translatedFromId (integer)
. twitter (string)
. deletedAt (string)
. name (string)
. id (string)
. updated (string)
. email (string)
. slug (string)
} (object) required
authors/post_cms_v3_blogs_authors_multi_language_attach_to_lang_groupdata: {
. language (string)
. id (string)
. primaryId (string)
. primaryLanguage (string)
} (object) required
authors/post_cms_v3_blogs_authors_multi_language_create_language_variationdata: {
. language (string)
. id (string)
. primaryLanguage (string)
. blogAuthor
} (object) required
authors/post_cms_v3_blogs_authors_multi_language_update_languagesdata: {
. languages (object)
. primaryId (string)
} (object) required
automation_v4/post_automation_v4_flows_batch_readdata: {
. inputs (array)
} (object) required
automation_v4/get_automation_v4_flows_email_campaignsafter (string)
before (string)
limit (integer)
flowId (array)
automation_v4/post_automation_v4_workflow_id_mappings_batch_readdata: {
. inputs (array)
} (object) required
automation_v4/get_automation_v4_flowsafter (string)
limit (integer)
automation_v4/post_automation_v4_flowsdata (undefined) required
automation_v4/get_automation_v4_flows_by_flow_idflowId (string)
automation_v4/put_automation_v4_flows_by_flow_idflowId (string)
data (undefined) required
automation_v4/delete_automation_v4_flows_by_flow_idflowId (integer)
blog_settings/post_cms_v3_blog_settings_settings_multi_language_update_languagesdata: {
. languages (object)
. primaryId (string)
} (object) required
blog_settings/get_cms_v3_blog_settings_settings_by_blog_id_revisionsblogId (string)
after (string)
before (string)
limit (integer)
blog_settings/get_cms_v3_blog_settings_settings_by_blog_id_revisions_by_revision_idblogId (string)
revisionId (string)
blog_settings/get_cms_v3_blog_settings_settings_by_blog_idblogId (string)
blog_settings/post_cms_v3_blog_settings_settings_multi_language_create_language_variationdata: {
. language (string)
. id (string)
. primaryLanguage (string)
. slug (string)
} (object) required
blog_settings/get_cms_v3_blog_settings_settingscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
blog_settings/put_cms_v3_blog_settings_settings_multi_language_set_new_lang_primarydata: {
. id (string)
} (object) required
blog_settings/post_cms_v3_blog_settings_settings_multi_language_detach_from_lang_groupdata: {
. id (string)
} (object) required
blog_settings/post_cms_v3_blog_settings_settings_multi_language_attach_to_lang_groupdata: {
. language (string)
. id (string)
. primaryId (string)
. primaryLanguage (string)
} (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
buckettest111/get_crm_v3_objects_bucket_test111s_by_bucket_test111_idbucketTest111Id (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
buckettest111/delete_crm_v3_objects_bucket_test111s_by_bucket_test111_idbucketTest111Id (string)
buckettest111/patch_crm_v3_objects_bucket_test111s_by_bucket_test111_idbucketTest111Id (string)
idProperty (string)
data: {
. properties (object)
} (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_archivedata: {
. inputs (array)
} (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_createdata: {
. inputs (array)
} (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_batch_updatedata: {
. inputs (array)
} (object) required
buckettest111/get_crm_v3_objects_bucket_test111slimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
buckettest111/post_crm_v3_objects_bucket_test111sdata: {
. associations (array)
. properties (object)
} (object) required
buckettest111/post_crm_v3_objects_bucket_test111s_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
business_units/get_business_units_v3_business_units_user_by_user_iduserId (string)
properties (array)
name (array)
calling_extensions/get_crm_v3_extensions_calling_by_app_id_settingsappId (integer)
calling_extensions/post_crm_v3_extensions_calling_by_app_id_settingsappId (integer)
data: {
. supportsCustomObjects (boolean)
. usesRemote (boolean)
. isReady (boolean)
. name (string)
. width (integer)
. usesCallingWindow (boolean)
. supportsInboundCalling (boolean)
. url (string)
. height (integer)
} (object) required
calling_extensions/delete_crm_v3_extensions_calling_by_app_id_settingsappId (integer)
calling_extensions/patch_crm_v3_extensions_calling_by_app_id_settingsappId (integer)
data: {
. supportsCustomObjects (boolean)
. usesRemote (boolean)
. isReady (boolean)
. name (string)
. width (integer)
. usesCallingWindow (boolean)
. supportsInboundCalling (boolean)
. url (string)
. height (integer)
} (object) required
calling_extensions/get_crm_v3_extensions_calling_by_app_id_settings_recordingappId (integer)
calling_extensions/post_crm_v3_extensions_calling_by_app_id_settings_recordingappId (integer)
data: {
. urlToRetrieveAuthedRecording (string)
} (object) required
calling_extensions/patch_crm_v3_extensions_calling_by_app_id_settings_recordingappId (integer)
data: {
. urlToRetrieveAuthedRecording (string)
} (object) required
calling_extensions/post_crm_v3_extensions_calling_recordings_readydata: {
. engagementId (integer)
} (object) required
calling_extensions/get_crm_v3_extensions_calling_by_app_id_settings_channel_connectionappId (integer)
calling_extensions/post_crm_v3_extensions_calling_by_app_id_settings_channel_connectionappId (integer)
data: {
. isReady (boolean)
. url (string)
} (object) required
calling_extensions/delete_crm_v3_extensions_calling_by_app_id_settings_channel_connectionappId (integer)
calling_extensions/patch_crm_v3_extensions_calling_by_app_id_settings_channel_connectionappId (integer)
data: {
. isReady (boolean)
. url (string)
} (object) required
calls/post_crm_v3_objects_calls_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
calls/get_crm_v3_objects_calls_by_call_idcallId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
calls/delete_crm_v3_objects_calls_by_call_idcallId (string)
calls/patch_crm_v3_objects_calls_by_call_idcallId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
calls/post_crm_v3_objects_calls_batch_archivedata: {
. inputs (array)
} (object) required
calls/post_crm_v3_objects_calls_batch_createdata: {
. inputs (array)
} (object) required
calls/post_crm_v3_objects_calls_batch_updatedata: {
. inputs (array)
} (object) required
calls/get_crm_v3_objects_callslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
calls/post_crm_v3_objects_callsdata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
calls/post_crm_v3_objects_calls_batch_upsertdata: {
. inputs (array)
} (object) required
calls/post_crm_v3_objects_calls_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_spend_by_spend_idcampaignGuid (string)
spendId (integer)
campaigns_public_api/put_marketing_v3_campaigns_by_campaign_guid_spend_by_spend_idcampaignGuid (string)
spendId (integer)
data: {
. amount (number)
. name (string)
. description (string)
. order (integer)
} (object) required
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guid_spend_by_spend_idcampaignGuid (string)
spendId (integer)
campaigns_public_api/post_marketing_v3_campaigns_batch_updatedata: {
. inputs (array)
} (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_budget_by_budget_idcampaignGuid (string)
budgetId (integer)
campaigns_public_api/put_marketing_v3_campaigns_by_campaign_guid_budget_by_budget_idcampaignGuid (string)
budgetId (integer)
data: {
. amount (number)
. name (string)
. description (string)
. order (integer)
} (object) required
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guid_budget_by_budget_idcampaignGuid (string)
budgetId (integer)
campaigns_public_api/put_marketing_v3_campaigns_by_campaign_guid_assets_by_asset_type_by_asset_idcampaignGuid (string)
assetType (string)
assetId (string)
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guid_assets_by_asset_type_by_asset_idcampaignGuid (string)
assetType (string)
assetId (string)
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_budget_totalscampaignGuid (string)
campaigns_public_api/get_marketing_v3_campaignssort (string)
after (string)
limit (integer)
name (string)
properties (array)
campaigns_public_api/post_marketing_v3_campaignsdata: {
. properties (object)
} (object) required
campaigns_public_api/post_marketing_v3_campaigns_batch_readstartDate (string)
endDate (string)
properties (array)
data: {
. inputs (array)
} (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_reports_metricscampaignGuid (string)
startDate (string)
endDate (string)
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_assets_by_asset_typecampaignGuid (string)
assetType (string)
after (string)
limit (string)
startDate (string)
endDate (string)
campaigns_public_api/post_marketing_v3_campaigns_batch_archivedata: {
. inputs (array)
} (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_reports_revenuecampaignGuid (string)
attributionModel (string)
startDate (string)
endDate (string)
campaigns_public_api/post_marketing_v3_campaigns_batch_createdata: {
. inputs (array)
} (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guidcampaignGuid (string)
startDate (string)
endDate (string)
properties (array)
campaigns_public_api/delete_marketing_v3_campaigns_by_campaign_guidcampaignGuid (string)
campaigns_public_api/patch_marketing_v3_campaigns_by_campaign_guidcampaignGuid (string)
data: {
. properties (object)
} (object) required
campaigns_public_api/post_marketing_v3_campaigns_by_campaign_guid_budgetcampaignGuid (string)
data: {
. amount (number)
. name (string)
. description (string)
. order (integer)
} (object) required
campaigns_public_api/get_marketing_v3_campaigns_by_campaign_guid_reports_contacts_by_contact_typecampaignGuid (string)
contactType (string)
startDate (string)
endDate (string)
limit (integer)
after (string)
campaigns_public_api/post_marketing_v3_campaigns_by_campaign_guid_spendcampaignGuid (string)
data: {
. amount (number)
. name (string)
. description (string)
. order (integer)
} (object) required
carts/post_crm_v3_objects_carts_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
carts/get_crm_v3_objects_carts_by_cart_idcartId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
carts/delete_crm_v3_objects_carts_by_cart_idcartId (string)
carts/patch_crm_v3_objects_carts_by_cart_idcartId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
carts/post_crm_v3_objects_carts_batch_archivedata: {
. inputs (array)
} (object) required
carts/post_crm_v3_objects_carts_batch_createdata: {
. inputs (array)
} (object) required
carts/post_crm_v3_objects_carts_batch_updatedata: {
. inputs (array)
} (object) required
carts/get_crm_v3_objects_cartslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
carts/post_crm_v3_objects_cartsdata: {
. associations (array)
. properties (object)
} (object) required
carts/post_crm_v3_objects_carts_batch_upsertdata: {
. inputs (array)
} (object) required
carts/post_crm_v3_objects_carts_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
cms_content_audit/get_cms_v3_audit_logsuserId (array)
eventType (array)
objectType (array)
objectId (array)
after (string)
before (string)
limit (integer)
sort (array)
commerce_payments/post_crm_v3_objects_commerce_payments_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
commerce_payments/get_crm_v3_objects_commerce_payments_by_commerce_payment_idcommercePaymentId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
commerce_payments/delete_crm_v3_objects_commerce_payments_by_commerce_payment_idcommercePaymentId (string)
commerce_payments/patch_crm_v3_objects_commerce_payments_by_commerce_payment_idcommercePaymentId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_archivedata: {
. inputs (array)
} (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_createdata: {
. inputs (array)
} (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_updatedata: {
. inputs (array)
} (object) required
commerce_payments/get_crm_v3_objects_commerce_paymentslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
commerce_payments/post_crm_v3_objects_commerce_paymentsdata: {
. associations (array)
. properties (object)
} (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_batch_upsertdata: {
. inputs (array)
} (object) required
commerce_payments/post_crm_v3_objects_commerce_payments_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
commerce_subscriptions/get_crm_v3_objects_subscriptions_by_subscription_idsubscriptionId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
commerce_subscriptions/delete_crm_v3_objects_subscriptions_by_subscription_idsubscriptionId (string)
commerce_subscriptions/patch_crm_v3_objects_subscriptions_by_subscription_idsubscriptionId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_archivedata: {
. inputs (array)
} (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_createdata: {
. inputs (array)
} (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_updatedata: {
. inputs (array)
} (object) required
commerce_subscriptions/get_crm_v3_objects_subscriptionslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
commerce_subscriptions/post_crm_v3_objects_subscriptionsdata: {
. associations (array)
. properties (object)
} (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_batch_upsertdata: {
. inputs (array)
} (object) required
commerce_subscriptions/post_crm_v3_objects_subscriptions_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
communications/post_crm_v3_objects_communications_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
communications/get_crm_v3_objects_communications_by_communication_idcommunicationId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
communications/delete_crm_v3_objects_communications_by_communication_idcommunicationId (string)
communications/patch_crm_v3_objects_communications_by_communication_idcommunicationId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
communications/post_crm_v3_objects_communications_batch_archivedata: {
. inputs (array)
} (object) required
communications/post_crm_v3_objects_communications_batch_createdata: {
. inputs (array)
} (object) required
communications/post_crm_v3_objects_communications_batch_updatedata: {
. inputs (array)
} (object) required
communications/get_crm_v3_objects_communicationslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
communications/post_crm_v3_objects_communicationsdata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
communications/post_crm_v3_objects_communications_batch_upsertdata: {
. inputs (array)
} (object) required
communications/post_crm_v3_objects_communications_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
companies/post_crm_v3_objects_companies_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
companies/get_crm_v3_objects_companies_by_company_idcompanyId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
companies/delete_crm_v3_objects_companies_by_company_idcompanyId (string)
companies/patch_crm_v3_objects_companies_by_company_idcompanyId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
companies/post_crm_v3_objects_companies_mergedata: {
. objectIdToMerge (string)
. primaryObjectId (string)
} (object) required
companies/post_crm_v3_objects_companies_batch_archivedata: {
. inputs (array)
} (object) required
companies/post_crm_v3_objects_companies_batch_createdata: {
. inputs (array)
} (object) required
companies/post_crm_v3_objects_companies_batch_updatedata: {
. inputs (array)
} (object) required
companies/get_crm_v3_objects_companieslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
companies/post_crm_v3_objects_companiesdata: {
. associations (array)
. properties (object)
} (object) required
companies/post_crm_v3_objects_companies_batch_upsertdata: {
. inputs (array)
} (object) required
companies/post_crm_v3_objects_companies_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
contacts/post_crm_v3_objects_contacts_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
contacts/get_crm_v3_objects_contacts_by_contact_idcontactId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
contacts/delete_crm_v3_objects_contacts_by_contact_idcontactId (string)
contacts/patch_crm_v3_objects_contacts_by_contact_idcontactId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
contacts/post_crm_v3_objects_contacts_mergedata: {
. objectIdToMerge (string)
. primaryObjectId (string)
} (object) required
contacts/post_crm_v3_objects_contacts_batch_archivedata: {
. inputs (array)
} (object) required
contacts/post_crm_v3_objects_contacts_batch_createdata: {
. inputs (array)
} (object) required
contacts/post_crm_v3_objects_contacts_batch_updatedata: {
. inputs (array)
} (object) required
contacts/post_crm_v3_objects_contacts_gdpr_deletedata: {
. idProperty (string)
. objectId (string)
} (object) required
contacts/get_crm_v3_objects_contactslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
contacts/post_crm_v3_objects_contactsdata: {
. associations (array)
. properties (object)
} (object) required
contacts/post_crm_v3_objects_contacts_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
contracts/post_crm_v3_objects_by_object_type_batch_readobjectType (string)
archived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
contracts/get_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
contracts/delete_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
contracts/patch_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
contracts/post_crm_v3_objects_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
contracts/post_crm_v3_objects_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
contracts/post_crm_v3_objects_by_object_type_batch_updateobjectType (string)
data: {
. inputs (array)
} (object) required
contracts/get_crm_v3_objects_by_object_typeobjectType (string)
limit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
contracts/post_crm_v3_objects_by_object_typeobjectType (string)
data: {
. associations (array)
. properties (object)
} (object) required
contracts/post_crm_v3_objects_by_object_type_batch_upsertobjectType (string)
data: {
. inputs (array)
} (object) required
contracts/post_crm_v3_objects_by_object_type_searchobjectType (string)
data: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
conversations_inbox_messages/get_conversations_v3_conversations_inboxesafter (string)
limit (integer)
sort (array)
defaultPageLength (integer)
archived (boolean)
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_idthreadId (integer)
archived (boolean)
association (array)
property (string)
conversations_inbox_messages/delete_conversations_v3_conversations_threads_by_thread_idthreadId (integer)
conversations_inbox_messages/patch_conversations_v3_conversations_threads_by_thread_idthreadId (integer)
archived (boolean)
data: {
. archived (boolean)
. status (string)
} (object) required
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_id_messages_by_message_id_original_contentthreadId (integer)
messageId (string)
property (string)
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_id_messagesthreadId (integer)
after (string)
limit (integer)
sort (array)
archived (boolean)
property (string)
conversations_inbox_messages/post_conversations_v3_conversations_threads_by_thread_id_messagesthreadId (integer)
data (undefined) required
conversations_inbox_messages/post_conversations_v3_conversations_actors_batch_readproperty (string)
data: {
. inputs (array)
} (object) required
conversations_inbox_messages/get_conversations_v3_conversations_channel_accountschannelId (array)
inboxId (array)
after (string)
limit (integer)
sort (array)
defaultPageLength (integer)
archived (boolean)
conversations_inbox_messages/get_conversations_v3_conversations_channels_by_channel_idchannelId (integer)
conversations_inbox_messages/get_conversations_v3_conversations_threads_by_thread_id_messages_by_message_idthreadId (integer)
messageId (string)
property (string)
conversations_inbox_messages/get_conversations_v3_conversations_channelsafter (string)
limit (integer)
sort (array)
defaultPageLength (integer)
conversations_inbox_messages/get_conversations_v3_conversations_actors_by_actor_idactorId (string)
property (string)
conversations_inbox_messages/get_conversations_v3_conversations_threadsafter (string)
limit (integer)
sort (array)
inboxId (array)
associatedContactId (integer)
threadStatus (string)
latestMessageTimestampAfter (string)
archived (boolean)
association (array)
property (string)
conversations_inbox_messages/get_conversations_v3_conversations_channel_accounts_by_channel_account_idchannelAccountId (integer)
archived (boolean)
conversations_inbox_messages/get_conversations_v3_conversations_inboxes_by_inbox_idinboxId (integer)
archived (boolean)
courses/post_crm_v3_objects_by_object_type_batch_readobjectType (string)
archived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
courses/get_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
courses/delete_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
courses/patch_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
courses/post_crm_v3_objects_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
courses/post_crm_v3_objects_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
courses/post_crm_v3_objects_by_object_type_batch_updateobjectType (string)
data: {
. inputs (array)
} (object) required
courses/get_crm_v3_objects_by_object_typeobjectType (string)
limit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
courses/post_crm_v3_objects_by_object_typeobjectType (string)
data: {
. associations (array)
. properties (object)
} (object) required
courses/post_crm_v3_objects_by_object_type_batch_upsertobjectType (string)
data: {
. inputs (array)
} (object) required
courses/post_crm_v3_objects_by_object_type_searchobjectType (string)
data: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
crm_owners/get_crm_v3_ownersemail (string)
after (string)
limit (integer)
archived (boolean)
crm_owners/get_crm_v3_owners_by_owner_idownerId (integer)
idProperty (string)
archived (boolean)
custom_channels/get_conversations_v3_custom_channels_by_channel_idchannelId (integer)
custom_channels/delete_conversations_v3_custom_channels_by_channel_idchannelId (integer)
custom_channels/patch_conversations_v3_custom_channels_by_channel_idchannelId (integer)
data: {
. channelDescription (object)
. capabilities (object)
. channelAccountConnectionRedirectUrl (object)
. channelLogoUrl (object)
. webhookUrl (object)
} (object) required
custom_channels/get_conversations_v3_custom_channels_by_channel_id_messages_by_message_idchannelId (integer)
messageId (string)
custom_channels/patch_conversations_v3_custom_channels_by_channel_id_messages_by_message_idchannelId (integer)
messageId (string)
data: {
. statusType (string)
. errorMessage (string)
} (object) required
custom_channels/patch_conversations_v3_custom_channels_by_channel_id_channel_account_staging_tokens_by_account_tokenchannelId (integer)
accountToken (string)
data: {
. accountName (string)
. deliveryIdentifier
} (object) required
custom_channels/get_conversations_v3_custom_channels_by_channel_id_channel_accountschannelId (integer)
deliveryIdentifierType (array)
deliveryIdentifierValue (array)
after (string)
limit (integer)
sort (array)
defaultPageLength (integer)
archived (boolean)
custom_channels/post_conversations_v3_custom_channels_by_channel_id_channel_accountschannelId (integer)
data: {
. authorized (boolean)
. name (string)
. deliveryIdentifier
. inboxId (string)
} (object) required
custom_channels/get_conversations_v3_custom_channels_by_channel_id_channel_accounts_by_channel_account_idchannelId (integer)
channelAccountId (integer)
archived (boolean)
custom_channels/patch_conversations_v3_custom_channels_by_channel_id_channel_accounts_by_channel_account_idchannelId (integer)
channelAccountId (integer)
data: {
. authorized (boolean)
. name (string)
} (object) required
custom_channels/get_conversations_v3_custom_channelsafter (string)
limit (integer)
sort (array)
defaultPageLength (integer)
custom_channels/post_conversations_v3_custom_channelsdata: {
. channelDescription (string)
. capabilities (object)
. channelAccountConnectionRedirectUrl (string)
. channelLogoUrl (string)
. name (string)
. webhookUrl (string)
} (object) required
custom_channels/post_conversations_v3_custom_channels_by_channel_id_messageschannelId (integer)
data: {
. messageDirection (string)
. attachments (array)
. recipients (array)
. integrationThreadId (string)
. integrationIdempotencyId (string)
. text (string)
. richText (string)
. channelAccountId (string)
. senders (array)
. inReplyToId (string)
. timestamp (string)
} (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_readobjectType (string)
archived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
custom_objects/get_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
custom_objects/delete_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
custom_objects/patch_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
custom_objects/post_crm_v3_objects_by_object_type_mergeobjectType (string)
data: {
. objectIdToMerge (string)
. primaryObjectId (string)
} (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_updateobjectType (string)
data: {
. inputs (array)
} (object) required
custom_objects/get_crm_v3_objects_by_object_typeobjectType (string)
limit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
custom_objects/post_crm_v3_objects_by_object_typeobjectType (string)
data: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
custom_objects/post_crm_v3_objects_by_object_type_batch_upsertobjectType (string)
data: {
. inputs (array)
} (object) required
custom_objects/post_crm_v3_objects_by_object_type_searchobjectType (string)
data: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
deals/post_crm_v3_objects_deals_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
deals/get_crm_v3_objects_deals_by_deal_iddealId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
deals/delete_crm_v3_objects_deals_by_deal_iddealId (string)
deals/patch_crm_v3_objects_deals_by_deal_iddealId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
deals/post_crm_v3_objects_deals_mergedata: {
. objectIdToMerge (string)
. primaryObjectId (string)
} (object) required
deals/post_crm_v3_objects_deals_batch_archivedata: {
. inputs (array)
} (object) required
deals/post_crm_v3_objects_deals_batch_createdata: {
. inputs (array)
} (object) required
deals/post_crm_v3_objects_deals_batch_updatedata: {
. inputs (array)
} (object) required
deals/get_crm_v3_objects_dealslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
deals/post_crm_v3_objects_dealsdata: {
. associations (array)
. properties (object)
} (object) required
deals/post_crm_v3_objects_deals_batch_upsertdata: {
. inputs (array)
} (object) required
deals/post_crm_v3_objects_deals_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
deal_splits/post_crm_v3_objects_deals_splits_batch_upsertdata: {
. inputs (array)
} (object) required
deal_splits/post_crm_v3_objects_deals_splits_batch_readdata: {
. inputs (array)
} (object) required
discounts/post_crm_v3_objects_discounts_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
discounts/get_crm_v3_objects_discounts_by_discount_iddiscountId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
discounts/delete_crm_v3_objects_discounts_by_discount_iddiscountId (string)
discounts/patch_crm_v3_objects_discounts_by_discount_iddiscountId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
discounts/post_crm_v3_objects_discounts_batch_archivedata: {
. inputs (array)
} (object) required
discounts/post_crm_v3_objects_discounts_batch_createdata: {
. inputs (array)
} (object) required
discounts/post_crm_v3_objects_discounts_batch_updatedata: {
. inputs (array)
} (object) required
discounts/get_crm_v3_objects_discountslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
discounts/post_crm_v3_objects_discountsdata: {
. associations (array)
. properties (object)
} (object) required
discounts/post_crm_v3_objects_discounts_batch_upsertdata: {
. inputs (array)
} (object) required
discounts/post_crm_v3_objects_discounts_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
domains/get_cms_v3_domainscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
domains/get_cms_v3_domains_by_domain_iddomainId (string)
emails/post_crm_v3_objects_emails_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
emails/get_crm_v3_objects_emails_by_email_idemailId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
emails/delete_crm_v3_objects_emails_by_email_idemailId (string)
emails/patch_crm_v3_objects_emails_by_email_idemailId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
emails/post_crm_v3_objects_emails_batch_archivedata: {
. inputs (array)
} (object) required
emails/post_crm_v3_objects_emails_batch_createdata: {
. inputs (array)
} (object) required
emails/post_crm_v3_objects_emails_batch_updatedata: {
. inputs (array)
} (object) required
emails/get_crm_v3_objects_emailslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
emails/post_crm_v3_objects_emailsdata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
emails/post_crm_v3_objects_emails_batch_upsertdata: {
. inputs (array)
} (object) required
emails/post_crm_v3_objects_emails_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
events/get_events_v3_eventsobjectType (string)
eventType (string)
after (string)
before (string)
limit (integer)
sort (array)
occurredAfter (string)
occurredBefore (string)
objectId (integer)
objectProperty.{propname} (object)
property.{propname} (object)
id (array)
events/get_events_v3_events_event_types
exports/get_crm_v3_exports_export_async_tasks_by_task_id_statustaskId (integer)
exports/post_crm_v3_exports_export_asyncdata (undefined) required
feedback_submissions/post_crm_v3_objects_feedback_submissions_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
feedback_submissions/get_crm_v3_objects_feedback_submissions_by_feedback_submission_idfeedbackSubmissionId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
feedback_submissions/get_crm_v3_objects_feedback_submissionslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
feedback_submissions/post_crm_v3_objects_feedback_submissions_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
fees/post_crm_v3_objects_fees_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
fees/get_crm_v3_objects_fees_by_fee_idfeeId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
fees/delete_crm_v3_objects_fees_by_fee_idfeeId (string)
fees/patch_crm_v3_objects_fees_by_fee_idfeeId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
fees/post_crm_v3_objects_fees_batch_archivedata: {
. inputs (array)
} (object) required
fees/post_crm_v3_objects_fees_batch_createdata: {
. inputs (array)
} (object) required
fees/post_crm_v3_objects_fees_batch_updatedata: {
. inputs (array)
} (object) required
fees/get_crm_v3_objects_feeslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
fees/post_crm_v3_objects_feesdata: {
. associations (array)
. properties (object)
} (object) required
fees/post_crm_v3_objects_fees_batch_upsertdata: {
. inputs (array)
} (object) required
fees/post_crm_v3_objects_fees_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
files/delete_files_v3_files_by_file_id_gdpr_deletefileId (string)
files/get_files_v3_files_by_file_idfileId (string)
properties (array)
files/put_files_v3_files_by_file_idfileId (string)
files/delete_files_v3_files_by_file_idfileId (string)
files/patch_files_v3_files_by_file_idfileId (string)
data: {
. access (string)
. parentFolderId (string)
. name (string)
. parentFolderPath (string)
. clearExpires (boolean)
. isUsableInContent (boolean)
. expiresAt (string)
} (object) required
files/get_files_v3_folders_by_folder_idfolderId (string)
properties (array)
files/delete_files_v3_folders_by_folder_idfolderId (string)
files/patch_files_v3_folders_by_folder_idfolderId (string)
data: {
. parentFolderId (integer)
. name (string)
} (object) required
files/post_files_v3_files
files/post_files_v3_foldersdata: {
. parentFolderId (string)
. parentPath (string)
. name (string)
} (object) required
files/get_files_v3_files_by_file_id_signed_urlfileId (string)
size (string)
expirationSeconds (integer)
upscale (boolean)
files/post_files_v3_files_import_from_url_asyncdata: {
. folderPath (string)
. access (string)
. duplicateValidationScope (string)
. name (string)
. duplicateValidationStrategy (string)
. ttl (string)
. overwrite (boolean)
. expiresAt (string)
. url (string)
. folderId (string)
} (object) required
files/get_files_v3_files_stat_by_pathpath (string)
properties (array)
files/get_files_v3_folders_searchproperties (array)
after (string)
before (string)
limit (integer)
sort (array)
ids (array)
idLte (integer)
idGte (integer)
createdAt (string)
createdAtLte (string)
createdAtGte (string)
updatedAt (string)
updatedAtLte (string)
updatedAtGte (string)
name (string)
path (string)
parentFolderIds (array)
files/get_files_v3_folders_update_async_tasks_by_task_id_statustaskId (string)
files/get_files_v3_files_searchproperties (array)
after (string)
before (string)
limit (integer)
sort (array)
ids (array)
idLte (integer)
idGte (integer)
createdAt (string)
createdAtLte (string)
createdAtGte (string)
updatedAt (string)
updatedAtLte (string)
updatedAtGte (string)
name (string)
path (string)
parentFolderIds (array)
size (integer)
sizeLte (integer)
sizeGte (integer)
height (integer)
heightLte (integer)
heightGte (integer)
width (integer)
widthLte (integer)
widthGte (integer)
encoding (string)
type (string)
extension (string)
url (string)
isUsableInContent (boolean)
allowsAnonymousAccess (boolean)
fileMd5 (string)
expiresAt (string)
expiresAtLte (string)
expiresAtGte (string)
files/get_files_v3_folders_by_folder_pathfolderPath (string)
properties (array)
files/delete_files_v3_folders_by_folder_pathfolderPath (string)
files/post_files_v3_folders_update_asyncdata: {
. parentFolderId (integer)
. name (string)
. id (string)
} (object) required
files/get_files_v3_files_import_from_url_async_tasks_by_task_id_statustaskId (string)
forms/get_marketing_v3_forms_by_form_idformId (string)
archived (boolean)
forms/put_marketing_v3_forms_by_form_idformId (string)
data (undefined) required
forms/delete_marketing_v3_forms_by_form_idformId (string)
forms/patch_marketing_v3_forms_by_form_idformId (string)
data: {
. fieldGroups (array)
. archived (boolean)
. configuration
. name (string)
. legalConsentOptions
. displayOptions
} (object) required
forms/get_marketing_v3_formsafter (string)
limit (integer)
archived (boolean)
formTypes (array)
forms/post_marketing_v3_formsdata (undefined) required
goal_targets/post_crm_v3_objects_goal_targets_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
goal_targets/get_crm_v3_objects_goal_targets_by_goal_target_idgoalTargetId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
goal_targets/delete_crm_v3_objects_goal_targets_by_goal_target_idgoalTargetId (string)
goal_targets/patch_crm_v3_objects_goal_targets_by_goal_target_idgoalTargetId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_archivedata: {
. inputs (array)
} (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_createdata: {
. inputs (array)
} (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_updatedata: {
. inputs (array)
} (object) required
goal_targets/get_crm_v3_objects_goal_targetslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
goal_targets/post_crm_v3_objects_goal_targetsdata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
goal_targets/post_crm_v3_objects_goal_targets_batch_upsertdata: {
. inputs (array)
} (object) required
goal_targets/post_crm_v3_objects_goal_targets_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_draft_exporttableIdOrName (string)
format (string)
hubdb/get_cms_v3_hubdb_tables_draftsort (array)
after (string)
limit (integer)
createdAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
contentType (string)
archived (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rows_drafttableIdOrName (string)
sort (array)
after (string)
limit (integer)
properties (array)
offset (integer)
archived (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_idtableIdOrName (string)
rowId (string)
archived (boolean)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_draft_clonetableIdOrName (string)
rowId (string)
name (string)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_resettableIdOrName (string)
includeForeignIds (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_exporttableIdOrName (string)
format (string)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_replacetableIdOrName (string)
data: {
. inputs (array)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_clonetableIdOrName (string)
data: {
. newName (string)
. isHubspotDefined (boolean)
. newLabel (string)
. copyRows (boolean)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_purgetableIdOrName (string)
data: {
. inputs (array)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_importtableIdOrName (string)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_drafttableIdOrName (string)
rowId (string)
archived (boolean)
hubdb/put_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_drafttableIdOrName (string)
rowId (string)
data: {
. path (string)
. childTableId (integer)
. values (object)
. name (string)
. displayIndex (integer)
} (object) required
hubdb/delete_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_drafttableIdOrName (string)
rowId (string)
hubdb/patch_cms_v3_hubdb_tables_by_table_id_or_name_rows_by_row_id_drafttableIdOrName (string)
rowId (string)
data: {
. path (string)
. childTableId (integer)
. values (object)
. name (string)
. displayIndex (integer)
} (object) required
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_rowstableIdOrName (string)
sort (array)
after (string)
limit (integer)
properties (array)
offset (integer)
archived (boolean)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rowstableIdOrName (string)
data: {
. path (string)
. childTableId (integer)
. values (object)
. name (string)
. displayIndex (integer)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_batch_readtableIdOrName (string)
data: {
. inputs (array)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_createtableIdOrName (string)
data: {
. inputs (array)
} (object) required
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_nametableIdOrName (string)
isGetLocalizedSchema (boolean)
archived (boolean)
includeForeignIds (boolean)
hubdb/delete_cms_v3_hubdb_tables_by_table_id_or_nametableIdOrName (string)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_readtableIdOrName (string)
data: {
. inputs (array)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_clonetableIdOrName (string)
data: {
. inputs (array)
} (object) required
hubdb/get_cms_v3_hubdb_tablessort (array)
after (string)
limit (integer)
createdAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
contentType (string)
archived (boolean)
hubdb/post_cms_v3_hubdb_tablesdata: {
. dynamicMetaTags (object)
. allowPublicApiAccess (boolean)
. useForPages (boolean)
. columns (array)
. name (string)
. enableChildTablePages (boolean)
. label (string)
. allowChildTables (boolean)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_unpublishtableIdOrName (string)
includeForeignIds (boolean)
hubdb/get_cms_v3_hubdb_tables_by_table_id_or_name_drafttableIdOrName (string)
isGetLocalizedSchema (boolean)
archived (boolean)
includeForeignIds (boolean)
hubdb/patch_cms_v3_hubdb_tables_by_table_id_or_name_drafttableIdOrName (string)
isGetLocalizedSchema (boolean)
archived (boolean)
includeForeignIds (boolean)
data: {
. dynamicMetaTags (object)
. allowPublicApiAccess (boolean)
. useForPages (boolean)
. columns (array)
. name (string)
. enableChildTablePages (boolean)
. label (string)
. allowChildTables (boolean)
} (object) required
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_draft_publishtableIdOrName (string)
includeForeignIds (boolean)
hubdb/post_cms_v3_hubdb_tables_by_table_id_or_name_rows_draft_batch_updatetableIdOrName (string)
data: {
. inputs (array)
} (object) required
imports/post_crm_v3_imports_by_import_id_cancelimportId (integer)
imports/get_crm_v3_imports_by_import_idimportId (integer)
imports/get_crm_v3_imports_by_import_id_errorsimportId (integer)
after (string)
limit (integer)
includeErrorMessage (boolean)
includeRowData (boolean)
imports/get_crm_v3_importsafter (string)
before (string)
limit (integer)
imports/post_crm_v3_imports
invoices/post_crm_v3_objects_invoices_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
invoices/get_crm_v3_objects_invoices_by_invoice_idinvoiceId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
invoices/delete_crm_v3_objects_invoices_by_invoice_idinvoiceId (string)
invoices/patch_crm_v3_objects_invoices_by_invoice_idinvoiceId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
invoices/post_crm_v3_objects_invoices_batch_archivedata: {
. inputs (array)
} (object) required
invoices/post_crm_v3_objects_invoices_batch_createdata: {
. inputs (array)
} (object) required
invoices/post_crm_v3_objects_invoices_batch_updatedata: {
. inputs (array)
} (object) required
invoices/get_crm_v3_objects_invoiceslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
invoices/post_crm_v3_objects_invoicesdata: {
. associations (array)
. properties (object)
} (object) required
invoices/post_crm_v3_objects_invoices_batch_upsertdata: {
. inputs (array)
} (object) required
invoices/post_crm_v3_objects_invoices_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
leads/post_crm_v3_objects_leads_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
leads/get_crm_v3_objects_leads_by_leads_idleadsId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
leads/delete_crm_v3_objects_leads_by_leads_idleadsId (string)
leads/patch_crm_v3_objects_leads_by_leads_idleadsId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
leads/post_crm_v3_objects_leads_batch_archivedata: {
. inputs (array)
} (object) required
leads/post_crm_v3_objects_leads_batch_createdata: {
. inputs (array)
} (object) required
leads/post_crm_v3_objects_leads_batch_updatedata: {
. inputs (array)
} (object) required
leads/get_crm_v3_objects_leadslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
leads/post_crm_v3_objects_leadsdata: {
. associations (array)
. properties (object)
} (object) required
leads/post_crm_v3_objects_leads_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
limits_tracking/get_crm_v3_limits_associations_labelsfromObjectTypeId (string)
toObjectTypeId (string)
limits_tracking/get_crm_v3_limits_associations_records_by_from_object_type_id_by_to_object_type_idfromObjectTypeId (string)
toObjectTypeId (string)
limits_tracking/get_crm_v3_limits_associations_records_by_from_object_type_id_tofromObjectTypeId (string)
limits_tracking/get_crm_v3_limits_custom_object_types
limits_tracking/get_crm_v3_limits_custom_properties
limits_tracking/get_crm_v3_limits_associations_records_from
limits_tracking/get_crm_v3_limits_records
limits_tracking/get_crm_v3_limits_pipelines
limits_tracking/get_crm_v3_limits_calculated_properties
line_items/post_crm_v3_objects_line_items_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
line_items/get_crm_v3_objects_line_items_by_line_item_idlineItemId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
line_items/delete_crm_v3_objects_line_items_by_line_item_idlineItemId (string)
line_items/patch_crm_v3_objects_line_items_by_line_item_idlineItemId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
line_items/post_crm_v3_objects_line_items_batch_archivedata: {
. inputs (array)
} (object) required
line_items/post_crm_v3_objects_line_items_batch_createdata: {
. inputs (array)
} (object) required
line_items/post_crm_v3_objects_line_items_batch_updatedata: {
. inputs (array)
} (object) required
line_items/get_crm_v3_objects_line_itemslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
line_items/post_crm_v3_objects_line_itemsdata: {
. associations (array)
. properties (object)
} (object) required
line_items/post_crm_v3_objects_line_items_batch_upsertdata: {
. inputs (array)
} (object) required
line_items/post_crm_v3_objects_line_items_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
listings/post_crm_v3_objects_by_object_type_batch_readobjectType (string)
archived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
listings/get_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
listings/delete_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
listings/patch_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
listings/post_crm_v3_objects_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
listings/post_crm_v3_objects_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
listings/post_crm_v3_objects_by_object_type_batch_updateobjectType (string)
data: {
. inputs (array)
} (object) required
listings/get_crm_v3_objects_by_object_typeobjectType (string)
limit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
listings/post_crm_v3_objects_by_object_typeobjectType (string)
data: {
. associations (array)
. properties (object)
} (object) required
listings/post_crm_v3_objects_by_object_type_batch_upsertobjectType (string)
data: {
. inputs (array)
} (object) required
listings/post_crm_v3_objects_by_object_type_searchobjectType (string)
data: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
lists/put_crm_v3_lists_by_list_id_update_list_namelistId (string)
listName (string)
includeFilters (boolean)
lists/put_crm_v3_lists_by_list_id_memberships_add_and_removelistId (string)
data: {
. recordIdsToRemove (array)
. recordIdsToAdd (array)
} (object) required
lists/get_crm_v3_lists_by_list_idlistId (string)
includeFilters (boolean)
lists/delete_crm_v3_lists_by_list_idlistId (string)
lists/put_crm_v3_lists_by_list_id_update_list_filterslistId (string)
enrollObjectsInWorkflows (boolean)
data: {
. filterBranch
} (object) required
lists/get_crm_v3_lists_by_list_id_schedule_conversionlistId (string)
lists/put_crm_v3_lists_by_list_id_schedule_conversionlistId (string)
data (undefined) required
lists/delete_crm_v3_lists_by_list_id_schedule_conversionlistId (string)
lists/post_crm_v3_lists_searchdata: {
. listIds (array)
. offset (integer)
. query (string)
. count (integer)
. processingTypes (array)
. additionalProperties (array)
. sort (string)
} (object) required
lists/put_crm_v3_lists_folders_move_listdata: {
. listId (string)
. newFolderId (string)
} (object) required
lists/put_crm_v3_lists_by_list_id_memberships_addlistId (string)
data (array) required
lists/get_crm_v3_lists_object_type_id_by_object_type_id_name_by_list_namelistName (string)
objectTypeId (string)
includeFilters (boolean)
lists/put_crm_v3_lists_folders_by_folder_id_move_by_new_parent_folder_idfolderId (string)
newParentFolderId (string)
lists/get_crm_v3_lists_idmappinglegacyListId (string)
lists/post_crm_v3_lists_idmappingdata (array) required
lists/put_crm_v3_lists_by_list_id_restorelistId (string)
lists/put_crm_v3_lists_folders_by_folder_id_renamefolderId (string)
newFolderName (string)
lists/get_crm_v3_lists_by_list_id_memberships_join_orderlistId (string)
after (string)
before (string)
limit (integer)
lists/put_crm_v3_lists_by_list_id_memberships_add_from_by_source_list_idlistId (string)
sourceListId (string)
lists/get_crm_v3_lists_records_by_object_type_id_by_record_id_membershipsobjectTypeId (string)
recordId (string)
lists/get_crm_v3_listslistIds (array)
includeFilters (boolean)
lists/post_crm_v3_listsdata: {
. membershipSettings
. objectTypeId (string)
. processingType (string)
. customProperties (object)
. listFolderId (integer)
. name (string)
. listPermissions
. filterBranch
} (object) required
lists/get_crm_v3_lists_foldersfolderId (string)
lists/post_crm_v3_lists_foldersdata: {
. parentFolderId (string)
. name (string)
} (object) required
lists/delete_crm_v3_lists_folders_by_folder_idfolderId (string)
lists/get_crm_v3_lists_by_list_id_membershipslistId (string)
after (string)
before (string)
limit (integer)
lists/delete_crm_v3_lists_by_list_id_membershipslistId (string)
lists/put_crm_v3_lists_by_list_id_memberships_removelistId (string)
data (array) required
manage_event_definitions/get_events_v3_event_definitionssearchString (string)
after (string)
limit (integer)
includeProperties (boolean)
sortOrder (string)
manage_event_definitions/post_events_v3_event_definitionsdata: {
. propertyDefinitions (array)
. name (string)
. description (string)
. label (string)
. primaryObject (string)
} (object) required
manage_event_definitions/get_events_v3_event_definitions_by_event_nameeventName (string)
manage_event_definitions/delete_events_v3_event_definitions_by_event_nameeventName (string)
manage_event_definitions/patch_events_v3_event_definitions_by_event_nameeventName (string)
data: {
. description (string)
. label (string)
} (object) required
manage_event_definitions/post_events_v3_event_definitions_by_event_name_propertyeventName (string)
data: {
. name (string)
. options (array)
. description (string)
. label (string)
. type (string)
} (object) required
manage_event_definitions/delete_events_v3_event_definitions_by_event_name_property_by_property_nameeventName (string)
propertyName (string)
manage_event_definitions/patch_events_v3_event_definitions_by_event_name_property_by_property_nameeventName (string)
propertyName (string)
data: {
. options (array)
. description (string)
. label (string)
} (object) required
marketing_emails/get_marketing_v3_emails_statistics_liststartTimestamp (string)
endTimestamp (string)
emailIds (array)
property (string)
marketing_emails/post_marketing_v3_emails_by_email_id_publishemailId (string)
marketing_emails/post_marketing_v3_emails_ab_test_create_variationdata: {
. variationName (string)
. contentId (string)
} (object) required
marketing_emails/get_marketing_v3_emails_statistics_histograminterval (string)
startTimestamp (string)
endTimestamp (string)
emailIds (array)
marketing_emails/get_marketing_v3_emails_by_email_id_ab_test_get_variationemailId (string)
marketing_emails/post_marketing_v3_emails_by_email_id_draft_resetemailId (string)
marketing_emails/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restore_to_draftemailId (string)
revisionId (integer)
marketing_emails/get_marketing_v3_emails_by_email_id_draftemailId (string)
marketing_emails/patch_marketing_v3_emails_by_email_id_draftemailId (string)
data: {
. rssData
. subject (string)
. testing
. publishDate (string)
. language (string)
. businessUnitId (integer)
. content
. webversion
. archived (boolean)
. subscriptionDetails
. activeDomain (string)
. name (string)
. campaign (string)
. from
. jitterSendTime (boolean)
. state (string)
. to
. subcategory (string)
. sendOnPublish (boolean)
} (object) required
marketing_emails/get_marketing_v3_emails_by_email_id_revisionsemailId (string)
after (string)
before (string)
limit (integer)
marketing_emails/post_marketing_v3_emails_by_email_id_unpublishemailId (string)
marketing_emails/get_marketing_v3_emails_by_email_id_revisions_by_revision_idemailId (string)
revisionId (string)
marketing_emails/post_marketing_v3_emails_clonedata: {
. cloneName (string)
. language (string)
. id (string)
} (object) required
marketing_emails/get_marketing_v3_emailscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
includeStats (boolean)
marketingCampaignNames (boolean)
workflowNames (boolean)
type (string)
isPublished (boolean)
includedProperties (array)
campaign (string)
archived (boolean)
marketing_emails/post_marketing_v3_emailsdata: {
. feedbackSurveyId (string)
. rssData
. subject (string)
. testing
. publishDate (string)
. language (string)
. businessUnitId (integer)
. content
. webversion
. archived (boolean)
. subscriptionDetails
. activeDomain (string)
. name (string)
. campaign (string)
. from
. jitterSendTime (boolean)
. state (string)
. to
. subcategory (string)
. sendOnPublish (boolean)
} (object) required
marketing_emails/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restoreemailId (string)
revisionId (string)
marketing_emails/get_marketing_v3_emails_by_email_idemailId (string)
includeStats (boolean)
marketingCampaignNames (boolean)
workflowNames (boolean)
includedProperties (array)
archived (boolean)
marketing_emails/delete_marketing_v3_emails_by_email_idemailId (string)
archived (boolean)
marketing_emails/patch_marketing_v3_emails_by_email_idemailId (string)
archived (boolean)
data: {
. rssData
. subject (string)
. testing
. publishDate (string)
. language (string)
. businessUnitId (integer)
. content
. webversion
. archived (boolean)
. subscriptionDetails
. activeDomain (string)
. name (string)
. campaign (string)
. from
. jitterSendTime (boolean)
. state (string)
. to
. subcategory (string)
. sendOnPublish (boolean)
} (object) required
marketing_emails_v3/get_marketing_v3_emails_statistics_liststartTimestamp (string)
endTimestamp (string)
emailIds (array)
property (string)
marketing_emails_v3/post_marketing_v3_emails_ab_test_create_variationdata: {
. variationName (string)
. contentId (string)
} (object) required
marketing_emails_v3/get_marketing_v3_emails_statistics_histograminterval (string)
startTimestamp (string)
endTimestamp (string)
emailIds (array)
marketing_emails_v3/get_marketing_v3_emails_by_email_id_ab_test_get_variationemailId (string)
marketing_emails_v3/post_marketing_v3_emails_by_email_id_draft_resetemailId (string)
marketing_emails_v3/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restore_to_draftemailId (string)
revisionId (integer)
marketing_emails_v3/get_marketing_v3_emails_by_email_id_draftemailId (string)
marketing_emails_v3/patch_marketing_v3_emails_by_email_id_draftemailId (string)
data: {
. rssData
. subject (string)
. testing
. publishDate (string)
. language (string)
. businessUnitId (string)
. content
. webversion
. archived (boolean)
. subscriptionDetails
. activeDomain (string)
. name (string)
. campaign (string)
. from
. state (string)
. to
. subcategory (string)
. sendOnPublish (boolean)
} (object) required
marketing_emails_v3/get_marketing_v3_emails_by_email_id_revisionsemailId (string)
after (string)
before (string)
limit (integer)
marketing_emails_v3/get_marketing_v3_emails_by_email_id_revisions_by_revision_idemailId (string)
revisionId (string)
marketing_emails_v3/post_marketing_v3_emails_clonedata: {
. cloneName (string)
. id (string)
} (object) required
marketing_emails_v3/get_marketing_v3_emailscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
includeStats (boolean)
type (string)
isPublished (boolean)
includedProperties (array)
archived (boolean)
marketing_emails_v3/post_marketing_v3_emailsdata: {
. feedbackSurveyId (string)
. rssData
. subject (string)
. testing
. publishDate (string)
. language (string)
. businessUnitId (string)
. content
. webversion
. archived (boolean)
. subscriptionDetails
. activeDomain (string)
. name (string)
. campaign (string)
. from
. state (string)
. to
. subcategory (string)
. sendOnPublish (boolean)
} (object) required
marketing_emails_v3/post_marketing_v3_emails_by_email_id_revisions_by_revision_id_restoreemailId (string)
revisionId (string)
marketing_emails_v3/get_marketing_v3_emails_by_email_idemailId (string)
includeStats (boolean)
includedProperties (array)
archived (boolean)
marketing_emails_v3/delete_marketing_v3_emails_by_email_idemailId (string)
archived (boolean)
marketing_emails_v3/patch_marketing_v3_emails_by_email_idemailId (string)
archived (boolean)
data: {
. rssData
. subject (string)
. testing
. publishDate (string)
. language (string)
. businessUnitId (string)
. content
. webversion
. archived (boolean)
. subscriptionDetails
. activeDomain (string)
. name (string)
. campaign (string)
. from
. state (string)
. to
. subcategory (string)
. sendOnPublish (boolean)
} (object) required
marketing_events/post_marketing_v3_marketing_events_attendance_by_external_event_id_by_subscriber_state_createexternalEventId (string)
subscriberState (string)
externalAccountId (string)
data: {
. inputs (array)
} (object) required
marketing_events/get_marketing_v3_marketing_events_participations_by_marketing_event_id_breakdownmarketingEventId (integer)
contactIdentifier (string)
state (string)
limit (integer)
after (string)
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_by_subscriber_state_upsertexternalEventId (string)
subscriberState (string)
externalAccountId (string) required
data: {
. inputs (array)
} (object) required
marketing_events/get_marketing_v3_marketing_events_events_by_external_event_idexternalEventId (string)
externalAccountId (string) required
marketing_events/put_marketing_v3_marketing_events_events_by_external_event_idexternalEventId (string)
data: {
. startDateTime (string)
. customProperties (array)
. externalAccountId (string)
. eventCancelled (boolean)
. eventOrganizer (string)
. eventUrl (string)
. externalEventId (string)
. eventDescription (string)
. eventName (string)
. eventType (string)
. eventCompleted (boolean)
. endDateTime (string)
} (object) required
marketing_events/delete_marketing_v3_marketing_events_events_by_external_event_idexternalEventId (string)
externalAccountId (string) required
marketing_events/patch_marketing_v3_marketing_events_events_by_external_event_idexternalEventId (string)
externalAccountId (string) required
data: {
. startDateTime (string)
. customProperties (array)
. eventCancelled (boolean)
. eventOrganizer (string)
. eventUrl (string)
. eventDescription (string)
. eventName (string)
. eventType (string)
. eventCompleted (boolean)
. endDateTime (string)
} (object) required
marketing_events/post_marketing_v3_marketing_events_events_upsertdata: {
. inputs (array)
} (object) required
marketing_events/post_marketing_v3_marketing_events_attendance_by_external_event_id_by_subscriber_state_email_createexternalEventId (string)
subscriberState (string)
externalAccountId (string)
data: {
. inputs (array)
} (object) required
marketing_events/get_marketing_v3_marketing_events_participations_by_external_account_id_by_external_event_id_breakdownexternalAccountId (string)
externalEventId (string)
contactIdentifier (string)
state (string)
limit (integer)
after (string)
marketing_events/get_marketing_v3_marketing_events_by_object_idobjectId (string)
marketing_events/delete_marketing_v3_marketing_events_by_object_idobjectId (string)
marketing_events/patch_marketing_v3_marketing_events_by_object_idobjectId (string)
data: {
. startDateTime (string)
. customProperties (array)
. eventCancelled (boolean)
. eventOrganizer (string)
. eventUrl (string)
. eventDescription (string)
. eventName (string)
. eventType (string)
. endDateTime (string)
} (object) required
marketing_events/get_marketing_v3_marketing_events_associations_by_external_account_id_by_external_event_id_listsexternalAccountId (string)
externalEventId (string)
marketing_events/get_marketing_v3_marketing_events_associations_by_marketing_event_id_listsmarketingEventId (string)
marketing_events/post_marketing_v3_marketing_events_by_object_id_attendance_by_subscriber_state_email_createobjectId (string)
subscriberState (string)
data: {
. inputs (array)
} (object) required
marketing_events/get_marketing_v3_marketing_eventsafter (string)
limit (integer)
marketing_events/post_marketing_v3_marketing_events_batch_updatedata: {
. inputs (array)
} (object) required
marketing_events/post_marketing_v3_marketing_events_by_object_id_attendance_by_subscriber_state_createobjectId (string)
subscriberState (string)
data: {
. inputs (array)
} (object) required
marketing_events/post_marketing_v3_marketing_events_batch_archivedata: {
. inputs (array)
} (object) required
marketing_events/get_marketing_v3_marketing_events_participations_by_external_account_id_by_external_event_idexternalAccountId (string)
externalEventId (string)
marketing_events/get_marketing_v3_marketing_events_by_external_event_id_identifiersexternalEventId (string)
marketing_events/get_marketing_v3_marketing_events_participations_by_marketing_event_idmarketingEventId (integer)
marketing_events/post_marketing_v3_marketing_events_events_deletedata: {
. inputs (array)
} (object) required
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_cancelexternalEventId (string)
externalAccountId (string) required
marketing_events/put_marketing_v3_marketing_events_associations_by_marketing_event_id_lists_by_list_idmarketingEventId (string)
listId (string)
marketing_events/delete_marketing_v3_marketing_events_associations_by_marketing_event_id_lists_by_list_idmarketingEventId (string)
listId (string)
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_by_subscriber_state_email_upsertexternalEventId (string)
subscriberState (string)
externalAccountId (string) required
data: {
. inputs (array)
} (object) required
marketing_events/put_marketing_v3_marketing_events_associations_by_external_account_id_by_external_event_id_lists_by_list_idexternalAccountId (string)
externalEventId (string)
listId (string)
marketing_events/delete_marketing_v3_marketing_events_associations_by_external_account_id_by_external_event_id_lists_by_list_idexternalAccountId (string)
externalEventId (string)
listId (string)
marketing_events/post_marketing_v3_marketing_events_events_by_external_event_id_completeexternalEventId (string)
externalAccountId (string) required
data: {
. startDateTime (string)
. endDateTime (string)
} (object) required
marketing_events/post_marketing_v3_marketing_events_eventsdata: {
. startDateTime (string)
. customProperties (array)
. externalAccountId (string)
. eventCancelled (boolean)
. eventOrganizer (string)
. eventUrl (string)
. externalEventId (string)
. eventDescription (string)
. eventName (string)
. eventType (string)
. eventCompleted (boolean)
. endDateTime (string)
} (object) required
marketing_events/get_marketing_v3_marketing_events_participations_contacts_by_contact_identifier_breakdowncontactIdentifier (string)
state (string)
limit (integer)
after (string)
marketing_events/get_marketing_v3_marketing_events_by_app_id_settingsappId (integer)
marketing_events/post_marketing_v3_marketing_events_by_app_id_settingsappId (integer)
data: {
. eventDetailsUrl (string)
} (object) required
marketing_events/get_marketing_v3_marketing_events_events_searchq (string) required
media_bridge/get_media_bridge_v1_by_app_id_settings_event_visibilityappId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_settings_event_visibilityappId (integer)
data: {
. showInWorkflows (boolean)
. showInReporting (boolean)
. eventType (string)
. showInTimeline (boolean)
. updatedAt (integer)
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_schemasappId (integer)
archived (boolean)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_batch_archiveobjectType (string)
appId (integer)
data: {
. inputs (array)
} (object) required
media_bridge/post_media_bridge_v1_events_attention_spandata: {
. mediaUrl (string)
. contactId (integer)
. rawDataString (string)
. rawDataMap (object)
. derivedValues
. externalId (string)
. mediaType (string)
. sessionId (string)
. pageId (integer)
. pageName (string)
. occurredTimestamp (integer)
. contactUtk (string)
. pageUrl (string)
. _hsenc (string)
. mediaBridgeId (integer)
. mediaName (string)
} (object) required
media_bridge/post_media_bridge_v1_events_media_played_percentdata: {
. mediaUrl (string)
. contactId (integer)
. externalId (string)
. mediaType (string)
. sessionId (string)
. playedPercent (integer)
. pageId (integer)
. pageName (string)
. occurredTimestamp (integer)
. contactUtk (string)
. pageUrl (string)
. _hsenc (string)
. mediaBridgeId (integer)
. mediaName (string)
} (object) required
media_bridge/post_media_bridge_v1_by_app_id_settings_registerappId (integer)
data: {
. name (string)
. updatedAt (integer)
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_type_by_property_nameobjectType (string)
propertyName (string)
appId (integer)
archived (boolean)
properties (string)
media_bridge/delete_media_bridge_v1_by_app_id_properties_by_object_type_by_property_nameobjectType (string)
propertyName (string)
appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_properties_by_object_type_by_property_nameobjectType (string)
propertyName (string)
appId (integer)
data: {
. groupName (string)
. hidden (boolean)
. options (array)
. displayOrder (integer)
. description (string)
. calculationFormula (string)
. label (string)
. hasUniqueValue (boolean)
. type (string)
. fieldType (string)
. formField (boolean)
} (object) required
media_bridge/post_media_bridge_v1_by_app_id_schemas_by_object_type_associationsobjectType (string)
appId (integer)
data: {
. fromObjectTypeId (string)
. name (string)
. toObjectTypeId (string)
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_settings_object_definitions_by_media_typemediaType (string)
appId (integer)
includeFullDefinition (boolean)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_batch_readobjectType (string)
appId (integer)
data: {
. archived (boolean)
. inputs (array)
. dataSensitivity (string)
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_type_groupsobjectType (string)
appId (integer)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_groupsobjectType (string)
appId (integer)
data: {
. name (string)
. displayOrder (integer)
. label (string)
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_schemas_by_object_typeobjectType (string)
appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_schemas_by_object_typeobjectType (string)
appId (integer)
data: {
. secondaryDisplayProperties (array)
. requiredProperties (array)
. searchableProperties (array)
. clearDescription (boolean)
. primaryDisplayProperty (string)
. description (string)
. allowsSensitiveProperties (boolean)
. restorable (boolean)
. labels
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_type_groups_by_group_nameobjectType (string)
groupName (string)
appId (integer)
media_bridge/delete_media_bridge_v1_by_app_id_properties_by_object_type_groups_by_group_nameobjectType (string)
groupName (string)
appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_properties_by_object_type_groups_by_group_nameobjectType (string)
groupName (string)
appId (integer)
data: {
. displayOrder (integer)
. label (string)
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_properties_by_object_typeobjectType (string)
appId (integer)
archived (boolean)
properties (string)
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_typeobjectType (string)
appId (integer)
data: {
. hidden (boolean)
. displayOrder (integer)
. description (string)
. label (string)
. type (string)
. formField (boolean)
. dataSensitivity (string)
. groupName (string)
. referencedObjectType (string)
. name (string)
. options (array)
. calculationFormula (string)
. hasUniqueValue (boolean)
. fieldType (string)
. externalOptions (boolean)
} (object) required
media_bridge/post_media_bridge_v1_by_app_id_settings_object_definitionsappId (integer)
data: {
. mediaTypes (array)
} (object) required
media_bridge/get_media_bridge_v1_by_app_id_settings_oembed_domainsappId (integer)
domainPortalId (integer)
media_bridge/post_media_bridge_v1_by_app_id_settings_oembed_domainsappId (integer)
data: {
. endpoints
. portalId (integer)
} (object) required
media_bridge/delete_media_bridge_v1_by_app_id_settings_oembed_domainsappId (integer)
id (integer)
domainPortalId (integer)
media_bridge/put_media_bridge_v1_by_app_id_settingsappId (integer)
data: {
. name (string)
. updatedAt (integer)
} (object) required
media_bridge/delete_media_bridge_v1_by_app_id_schemas_by_object_type_associations_by_association_idobjectType (string)
associationId (string)
appId (integer)
media_bridge/get_media_bridge_v1_by_app_id_settings_oembed_domains_by_o_embed_domain_idoEmbedDomainId (string)
appId (integer)
media_bridge/patch_media_bridge_v1_by_app_id_settings_oembed_domains_by_o_embed_domain_idoEmbedDomainId (string)
appId (integer)
data: {
. endpoints
. portalId (integer)
} (object) required
media_bridge/post_media_bridge_v1_events_media_playeddata: {
. mediaUrl (string)
. contactId (integer)
. externalId (string)
. mediaType (string)
. sessionId (string)
. pageId (integer)
. pageName (string)
. iframeUrl (string)
. occurredTimestamp (integer)
. contactUtk (string)
. pageUrl (string)
. state (string)
. _hsenc (string)
. mediaBridgeId (integer)
. mediaName (string)
} (object) required
media_bridge/post_media_bridge_v1_by_app_id_properties_by_object_type_batch_createobjectType (string)
appId (integer)
data: {
. inputs (array)
} (object) required
meetings/get_scheduler_v3_meetings_meeting_links_book_by_slugslug (string)
timezone (string)
meetings/get_scheduler_v3_meetings_meeting_linksafter (string)
limit (integer)
name (string)
organizerUserId (string)
type (string)
meetings/post_scheduler_v3_meetings_meeting_links_bookdata: {
. duration (integer)
. firstName (string)
. lastName (string)
. likelyAvailableUserIds (array)
. timezone (string)
. legalConsentResponses (array)
. startTime (string)
. formFields (array)
. locale (string)
. slug (string)
. email (string)
} (object) required
meetings/get_scheduler_v3_meetings_meeting_links_book_availability_page_by_slugslug (string)
timezone (string)
monthOffset (integer)
multicurrency/get_settings_v3_currencies_exchange_rateslimit (integer)
after (string)
fromCurrencyCode (string)
toCurrencyCode (string)
multicurrency/post_settings_v3_currencies_exchange_ratesdata: {
. effectiveAt (string)
. conversionRate (number)
. fromCurrencyCode (string)
} (object) required
multicurrency/get_settings_v3_currencies_codes
multicurrency/get_settings_v3_currencies_company_currency
multicurrency/put_settings_v3_currencies_company_currencydata: {
. currencyCode (string)
} (object) required
multicurrency/post_settings_v3_currencies_exchange_rates_batch_updatedata: {
. inputs (array)
} (object) required
multicurrency/get_settings_v3_currencies_exchange_rates_current
multicurrency/post_settings_v3_currencies_exchange_rates_update_visibilitydata: {
. toCurrencyCode (string)
. visibleInUI (boolean)
. fromCurrencyCode (string)
} (object) required
multicurrency/get_settings_v3_currencies_exchange_rates_by_exchange_rate_idexchangeRateId (string)
multicurrency/patch_settings_v3_currencies_exchange_rates_by_exchange_rate_idexchangeRateId (string)
data: {
. effectiveAt (string)
. conversionRate (number)
} (object) required
multicurrency/post_settings_v3_currencies_exchange_rates_batch_createdata: {
. inputs (array)
} (object) required
multicurrency/post_settings_v3_currencies_exchange_rates_batch_readdata: {
. inputs (array)
} (object) required
notes/post_crm_v3_objects_notes_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
notes/get_crm_v3_objects_notes_by_note_idnoteId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
notes/delete_crm_v3_objects_notes_by_note_idnoteId (string)
notes/patch_crm_v3_objects_notes_by_note_idnoteId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
notes/post_crm_v3_objects_notes_batch_archivedata: {
. inputs (array)
} (object) required
notes/post_crm_v3_objects_notes_batch_createdata: {
. inputs (array)
} (object) required
notes/post_crm_v3_objects_notes_batch_updatedata: {
. inputs (array)
} (object) required
notes/get_crm_v3_objects_noteslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
notes/post_crm_v3_objects_notesdata: {
. associations (array)
. properties (object)
} (object) required
notes/post_crm_v3_objects_notes_batch_upsertdata: {
. inputs (array)
} (object) required
notes/post_crm_v3_objects_notes_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
oauth/get_oauth_v1_access_tokens_by_tokentoken (string)
oauth/get_oauth_v1_refresh_tokens_by_tokentoken (string)
oauth/delete_oauth_v1_refresh_tokens_by_tokentoken (string)
oauth/post_oauth_v1_token
object_library/get_crm_v3_object_library_enablement
object_library/get_crm_v3_object_library_enablement_by_object_type_idobjectTypeId (string)
objects/post_crm_v3_objects_by_object_type_batch_readobjectType (string)
archived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
objects/get_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
objects/delete_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
objects/patch_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
objects/post_crm_v3_objects_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
objects/post_crm_v3_objects_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
objects/post_crm_v3_objects_by_object_type_batch_updateobjectType (string)
data: {
. inputs (array)
} (object) required
objects/get_crm_v3_objects_by_object_typeobjectType (string)
limit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
objects/post_crm_v3_objects_by_object_typeobjectType (string)
data: {
. associations (array)
. properties (object)
} (object) required
objects/post_crm_v3_objects_by_object_type_batch_upsertobjectType (string)
data: {
. inputs (array)
} (object) required
objects/post_crm_v3_objects_by_object_type_searchobjectType (string)
data: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
orders/post_crm_v3_objects_orders_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
orders/get_crm_v3_objects_orders_by_order_idorderId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
orders/delete_crm_v3_objects_orders_by_order_idorderId (string)
orders/patch_crm_v3_objects_orders_by_order_idorderId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
orders/post_crm_v3_objects_orders_batch_archivedata: {
. inputs (array)
} (object) required
orders/post_crm_v3_objects_orders_batch_createdata: {
. inputs (array)
} (object) required
orders/post_crm_v3_objects_orders_batch_updatedata: {
. inputs (array)
} (object) required
orders/get_crm_v3_objects_orderslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
orders/post_crm_v3_objects_ordersdata: {
. associations (array)
. properties (object)
} (object) required
orders/post_crm_v3_objects_orders_batch_upsertdata: {
. inputs (array)
} (object) required
orders/post_crm_v3_objects_orders_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
pages/get_cms_v3_pages_site_pages_by_object_id_revisions_by_revision_idobjectId (string)
revisionId (string)
pages/get_cms_v3_pages_landing_pages_by_object_id_revisionsobjectId (string)
after (string)
before (string)
limit (integer)
pages/post_cms_v3_pages_site_pages_batch_updatearchived (boolean)
data: {
. inputs (array)
} (object) required
pages/get_cms_v3_pages_landing_pages_folders_by_object_id_revisionsobjectId (string)
after (string)
before (string)
limit (integer)
pages/post_cms_v3_pages_site_pages_by_object_id_revisions_by_revision_id_restoreobjectId (string)
revisionId (string)
pages/get_cms_v3_pages_landing_pages_folderscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
property (string)
pages/post_cms_v3_pages_landing_pages_foldersdata: {
. deletedAt (string)
. parentFolderId (integer)
. created (string)
. name (string)
. id (string)
. category (integer)
. updated (string)
} (object) required
pages/post_cms_v3_pages_site_pages_multi_language_attach_to_lang_groupdata: {
. language (string)
. id (string)
. primaryId (string)
. primaryLanguage (string)
} (object) required
pages/post_cms_v3_pages_site_pages_scheduledata: {
. publishDate (string)
. id (string)
} (object) required
pages/post_cms_v3_pages_site_pages_multi_language_detach_from_lang_groupdata: {
. id (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_createdata: {
. inputs (array)
} (object) required
pages/get_cms_v3_pages_site_pages_by_object_id_revisionsobjectId (string)
after (string)
before (string)
limit (integer)
pages/get_cms_v3_pages_landing_pages_by_object_id_draftobjectId (string)
pages/patch_cms_v3_pages_landing_pages_by_object_id_draftobjectId (string)
data: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. publishImmediately (boolean)
. htmlTitle (string)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. subcategory (string)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. widgets (object)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. contentGroupId (string)
. pageExpiryEnabled (boolean)
. templatePath (string)
. url (string)
. publicAccessRules (array)
. archivedAt (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. pageRedirected (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
pages/get_cms_v3_pages_landing_pagescreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
property (string)
pages/post_cms_v3_pages_landing_pagesdata: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. publishImmediately (boolean)
. htmlTitle (string)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. subcategory (string)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. widgets (object)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. contentGroupId (string)
. pageExpiryEnabled (boolean)
. templatePath (string)
. url (string)
. publicAccessRules (array)
. archivedAt (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. pageRedirected (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
pages/post_cms_v3_pages_site_pages_ab_test_enddata: {
. winnerId (string)
. abTestId (string)
} (object) required
pages/post_cms_v3_pages_site_pages_by_object_id_revisions_by_revision_id_restore_to_draftobjectId (string)
revisionId (integer)
pages/post_cms_v3_pages_landing_pages_batch_createdata: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_landing_pages_batch_updatearchived (boolean)
data: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_landing_pages_batch_readarchived (boolean)
data: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_landing_pages_clonedata: {
. cloneName (string)
. id (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_folders_by_object_id_revisions_by_revision_id_restoreobjectId (string)
revisionId (string)
pages/put_cms_v3_pages_landing_pages_multi_language_set_new_lang_primarydata: {
. id (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_by_object_id_revisions_by_revision_id_restoreobjectId (string)
revisionId (string)
pages/get_cms_v3_pages_site_pages_by_object_id_draftobjectId (string)
pages/patch_cms_v3_pages_site_pages_by_object_id_draftobjectId (string)
data: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. publishImmediately (boolean)
. htmlTitle (string)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. subcategory (string)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. widgets (object)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. contentGroupId (string)
. pageExpiryEnabled (boolean)
. templatePath (string)
. url (string)
. publicAccessRules (array)
. archivedAt (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. pageRedirected (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
pages/get_cms_v3_pages_landing_pages_folders_by_object_idobjectId (string)
archived (boolean)
property (string)
pages/delete_cms_v3_pages_landing_pages_folders_by_object_idobjectId (string)
archived (boolean)
pages/patch_cms_v3_pages_landing_pages_folders_by_object_idobjectId (string)
archived (boolean)
data: {
. deletedAt (string)
. parentFolderId (integer)
. created (string)
. name (string)
. id (string)
. category (integer)
. updated (string)
} (object) required
pages/post_cms_v3_pages_site_pages_batch_readarchived (boolean)
data: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_landing_pages_ab_test_create_variationdata: {
. variationName (string)
. contentId (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_multi_language_attach_to_lang_groupdata: {
. language (string)
. id (string)
. primaryId (string)
. primaryLanguage (string)
} (object) required
pages/get_cms_v3_pages_site_pagescreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
property (string)
pages/post_cms_v3_pages_site_pagesdata: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. publishImmediately (boolean)
. htmlTitle (string)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. subcategory (string)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. widgets (object)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. contentGroupId (string)
. pageExpiryEnabled (boolean)
. templatePath (string)
. url (string)
. publicAccessRules (array)
. archivedAt (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. pageRedirected (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
pages/get_cms_v3_pages_landing_pages_by_object_id_revisions_by_revision_idobjectId (string)
revisionId (string)
pages/post_cms_v3_pages_site_pages_multi_language_create_language_variationdata: {
. language (string)
. id (string)
. primaryLanguage (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_ab_test_enddata: {
. winnerId (string)
. abTestId (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_by_object_id_draft_push_liveobjectId (string)
pages/post_cms_v3_pages_landing_pages_multi_language_detach_from_lang_groupdata: {
. id (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_multi_language_update_languagesdata: {
. languages (object)
. primaryId (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_scheduledata: {
. publishDate (string)
. id (string)
} (object) required
pages/post_cms_v3_pages_site_pages_ab_test_create_variationdata: {
. variationName (string)
. contentId (string)
} (object) required
pages/post_cms_v3_pages_site_pages_multi_language_update_languagesdata: {
. languages (object)
. primaryId (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_ab_test_rerundata: {
. variationId (string)
. abTestId (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_archivedata: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_site_pages_batch_archivedata: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_site_pages_batch_createdata: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_updatearchived (boolean)
data: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_site_pages_clonedata: {
. cloneName (string)
. id (string)
} (object) required
pages/put_cms_v3_pages_site_pages_multi_language_set_new_lang_primarydata: {
. id (string)
} (object) required
pages/get_cms_v3_pages_landing_pages_folders_by_object_id_revisions_by_revision_idobjectId (string)
revisionId (string)
pages/post_cms_v3_pages_landing_pages_by_object_id_draft_resetobjectId (string)
pages/get_cms_v3_pages_landing_pages_by_object_idobjectId (string)
archived (boolean)
property (string)
pages/delete_cms_v3_pages_landing_pages_by_object_idobjectId (string)
archived (boolean)
pages/patch_cms_v3_pages_landing_pages_by_object_idobjectId (string)
archived (boolean)
data: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. publishImmediately (boolean)
. htmlTitle (string)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. subcategory (string)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. widgets (object)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. contentGroupId (string)
. pageExpiryEnabled (boolean)
. templatePath (string)
. url (string)
. publicAccessRules (array)
. archivedAt (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. pageRedirected (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_multi_language_create_language_variationdata: {
. language (string)
. id (string)
. primaryLanguage (string)
} (object) required
pages/post_cms_v3_pages_site_pages_by_object_id_draft_push_liveobjectId (string)
pages/post_cms_v3_pages_landing_pages_batch_archivedata: {
. inputs (array)
} (object) required
pages/post_cms_v3_pages_landing_pages_by_object_id_revisions_by_revision_id_restore_to_draftobjectId (string)
revisionId (integer)
pages/post_cms_v3_pages_site_pages_ab_test_rerundata: {
. variationId (string)
. abTestId (string)
} (object) required
pages/post_cms_v3_pages_site_pages_by_object_id_draft_resetobjectId (string)
pages/get_cms_v3_pages_site_pages_by_object_idobjectId (string)
archived (boolean)
property (string)
pages/delete_cms_v3_pages_site_pages_by_object_idobjectId (string)
archived (boolean)
pages/patch_cms_v3_pages_site_pages_by_object_idobjectId (string)
archived (boolean)
data: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. publishImmediately (boolean)
. htmlTitle (string)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. subcategory (string)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. widgets (object)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. contentGroupId (string)
. pageExpiryEnabled (boolean)
. templatePath (string)
. url (string)
. publicAccessRules (array)
. archivedAt (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. pageRedirected (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
pages/post_cms_v3_pages_landing_pages_folders_batch_readarchived (boolean)
data: {
. inputs (array)
} (object) required
partner_clients/post_crm_v3_objects_partner_clients_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
partner_clients/get_crm_v3_objects_partner_clients_by_partner_client_idpartnerClientId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
partner_clients/patch_crm_v3_objects_partner_clients_by_partner_client_idpartnerClientId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
partner_clients/post_crm_v3_objects_partner_clients_batch_updatedata: {
. inputs (array)
} (object) required
partner_clients/get_crm_v3_objects_partner_clientslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
partner_clients/post_crm_v3_objects_partner_clients_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
payments/post_crm_v3_objects_payments_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
payments/get_crm_v3_objects_payments_by_payments_idpaymentsId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
payments/get_crm_v3_objects_paymentslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
payments/post_crm_v3_objects_payments_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_id_auditobjectType (string)
stageId (string)
pipelineId (string)
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_idobjectType (string)
pipelineId (string)
pipelines/put_crm_v3_pipelines_by_object_type_by_pipeline_idobjectType (string)
pipelineId (string)
validateReferencesBeforeDelete (boolean)
validateDealStageUsagesBeforeDelete (boolean)
data: {
. displayOrder (integer)
. stages (array)
. label (string)
} (object) required
pipelines/delete_crm_v3_pipelines_by_object_type_by_pipeline_idobjectType (string)
pipelineId (string)
validateReferencesBeforeDelete (boolean)
validateDealStageUsagesBeforeDelete (boolean)
pipelines/patch_crm_v3_pipelines_by_object_type_by_pipeline_idobjectType (string)
pipelineId (string)
validateReferencesBeforeDelete (boolean)
validateDealStageUsagesBeforeDelete (boolean)
data: {
. archived (boolean)
. displayOrder (integer)
. label (string)
} (object) required
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_auditobjectType (string)
pipelineId (string)
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_stagesobjectType (string)
pipelineId (string)
pipelines/post_crm_v3_pipelines_by_object_type_by_pipeline_id_stagesobjectType (string)
pipelineId (string)
data: {
. metadata (object)
. displayOrder (integer)
. label (string)
} (object) required
pipelines/get_crm_v3_pipelines_by_object_typeobjectType (string)
pipelines/post_crm_v3_pipelines_by_object_typeobjectType (string)
data: {
. displayOrder (integer)
. stages (array)
. label (string)
} (object) required
pipelines/get_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_idobjectType (string)
pipelineId (string)
stageId (string)
pipelines/put_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_idobjectType (string)
pipelineId (string)
stageId (string)
data: {
. metadata (object)
. displayOrder (integer)
. label (string)
} (object) required
pipelines/delete_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_idobjectType (string)
pipelineId (string)
stageId (string)
pipelines/patch_crm_v3_pipelines_by_object_type_by_pipeline_id_stages_by_stage_idobjectType (string)
pipelineId (string)
stageId (string)
data: {
. archived (boolean)
. metadata (object)
. displayOrder (integer)
. label (string)
} (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
postal_mail/get_crm_v3_objects_postal_mail_by_postal_mail_idpostalMailId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
postal_mail/delete_crm_v3_objects_postal_mail_by_postal_mail_idpostalMailId (string)
postal_mail/patch_crm_v3_objects_postal_mail_by_postal_mail_idpostalMailId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_archivedata: {
. inputs (array)
} (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_createdata: {
. inputs (array)
} (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_updatedata: {
. inputs (array)
} (object) required
postal_mail/get_crm_v3_objects_postal_maillimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
postal_mail/post_crm_v3_objects_postal_maildata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
postal_mail/post_crm_v3_objects_postal_mail_batch_upsertdata: {
. inputs (array)
} (object) required
postal_mail/post_crm_v3_objects_postal_mail_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
posts/post_cms_v3_blogs_posts_scheduledata: {
. publishDate (string)
. id (string)
} (object) required
posts/post_cms_v3_blogs_posts_batch_readarchived (boolean)
data: {
. inputs (array)
} (object) required
posts/post_cms_v3_blogs_posts_multi_language_update_languagesdata: {
. languages (object)
. primaryId (string)
} (object) required
posts/post_cms_v3_blogs_posts_batch_createdata: {
. inputs (array)
} (object) required
posts/post_cms_v3_blogs_posts_batch_updatearchived (boolean)
data: {
. inputs (array)
} (object) required
posts/get_cms_v3_blogs_posts_by_object_id_draftobjectId (string)
posts/patch_cms_v3_blogs_posts_by_object_id_draftobjectId (string)
data: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. htmlTitle (string)
. publishImmediately (boolean)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. rssBody (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. tagIds (array)
. widgets (object)
. postSummary (string)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. blogAuthorId (string)
. contentGroupId (string)
. rssSummary (string)
. pageExpiryEnabled (boolean)
. url (string)
. enableGoogleAmpOutputOverride (boolean)
. publicAccessRules (array)
. archivedAt (integer)
. postBody (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
posts/get_cms_v3_blogs_posts_by_object_id_revisions_by_revision_idobjectId (string)
revisionId (string)
posts/post_cms_v3_blogs_posts_by_object_id_revisions_by_revision_id_restore_to_draftobjectId (string)
revisionId (integer)
posts/post_cms_v3_blogs_posts_multi_language_create_language_variationdata: {
. language (string)
. id (string)
} (object) required
posts/get_cms_v3_blogs_postscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
property (string)
posts/post_cms_v3_blogs_postsdata: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. htmlTitle (string)
. publishImmediately (boolean)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. rssBody (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. tagIds (array)
. widgets (object)
. postSummary (string)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. blogAuthorId (string)
. contentGroupId (string)
. rssSummary (string)
. pageExpiryEnabled (boolean)
. url (string)
. enableGoogleAmpOutputOverride (boolean)
. publicAccessRules (array)
. archivedAt (integer)
. postBody (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
posts/post_cms_v3_blogs_posts_clonedata: {
. cloneName (string)
. id (string)
} (object) required
posts/post_cms_v3_blogs_posts_by_object_id_revisions_by_revision_id_restoreobjectId (string)
revisionId (string)
posts/post_cms_v3_blogs_posts_multi_language_detach_from_lang_groupdata: {
. id (string)
} (object) required
posts/post_cms_v3_blogs_posts_by_object_id_draft_push_liveobjectId (string)
posts/post_cms_v3_blogs_posts_batch_archivedata: {
. inputs (array)
} (object) required
posts/post_cms_v3_blogs_posts_by_object_id_draft_resetobjectId (string)
posts/post_cms_v3_blogs_posts_multi_language_attach_to_lang_groupdata: {
. language (string)
. id (string)
. primaryId (string)
. primaryLanguage (string)
} (object) required
posts/put_cms_v3_blogs_posts_multi_language_set_new_lang_primarydata: {
. id (string)
} (object) required
posts/get_cms_v3_blogs_posts_by_object_idobjectId (string)
archived (boolean)
property (string)
posts/delete_cms_v3_blogs_posts_by_object_idobjectId (string)
archived (boolean)
posts/patch_cms_v3_blogs_posts_by_object_idobjectId (string)
archived (boolean)
data: {
. publishDate (string)
. language (string)
. enableLayoutStylesheets (boolean)
. metaDescription (string)
. attachedStylesheets (array)
. password (string)
. htmlTitle (string)
. publishImmediately (boolean)
. translations (object)
. id (string)
. state (string)
. slug (string)
. createdById (string)
. rssBody (string)
. currentlyPublished (boolean)
. archivedInDashboard (boolean)
. created (string)
. contentTypeCategory (string)
. mabExperimentId (string)
. updatedById (string)
. translatedFromId (string)
. folderId (string)
. widgetContainers (object)
. pageExpiryRedirectId (integer)
. dynamicPageDataSourceType (integer)
. featuredImage (string)
. authorName (string)
. domain (string)
. name (string)
. dynamicPageHubDbTableId (string)
. campaign (string)
. dynamicPageDataSourceId (string)
. enableDomainStylesheets (boolean)
. includeDefaultCustomCss (boolean)
. layoutSections (object)
. updated (string)
. footerHtml (string)
. tagIds (array)
. widgets (object)
. postSummary (string)
. headHtml (string)
. pageExpiryRedirectUrl (string)
. abStatus (string)
. useFeaturedImage (boolean)
. abTestId (string)
. featuredImageAltText (string)
. blogAuthorId (string)
. contentGroupId (string)
. rssSummary (string)
. pageExpiryEnabled (boolean)
. url (string)
. enableGoogleAmpOutputOverride (boolean)
. publicAccessRules (array)
. archivedAt (integer)
. postBody (string)
. themeSettingsValues (object)
. pageExpiryDate (integer)
. publicAccessRulesEnabled (boolean)
. currentState (string)
. categoryId (integer)
. linkRelCanonicalUrl (string)
} (object) required
posts/get_cms_v3_blogs_posts_by_object_id_revisionsobjectId (string)
after (string)
before (string)
limit (integer)
products/post_crm_v3_objects_products_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
products/get_crm_v3_objects_products_by_product_idproductId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
products/delete_crm_v3_objects_products_by_product_idproductId (string)
products/patch_crm_v3_objects_products_by_product_idproductId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
products/post_crm_v3_objects_products_batch_archivedata: {
. inputs (array)
} (object) required
products/post_crm_v3_objects_products_batch_createdata: {
. inputs (array)
} (object) required
products/post_crm_v3_objects_products_batch_updatedata: {
. inputs (array)
} (object) required
products/get_crm_v3_objects_productslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
products/post_crm_v3_objects_productsdata: {
. associations (array)
. properties (object)
} (object) required
products/post_crm_v3_objects_products_batch_upsertdata: {
. inputs (array)
} (object) required
products/post_crm_v3_objects_products_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
properties/post_crm_v3_properties_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
properties/get_crm_v3_properties_by_object_type_groups_by_group_nameobjectType (string)
groupName (string)
properties/delete_crm_v3_properties_by_object_type_groups_by_group_nameobjectType (string)
groupName (string)
properties/patch_crm_v3_properties_by_object_type_groups_by_group_nameobjectType (string)
groupName (string)
data: {
. displayOrder (integer)
. label (string)
} (object) required
properties/get_crm_v3_properties_by_object_type_by_property_nameobjectType (string)
propertyName (string)
archived (boolean)
properties (string)
properties/delete_crm_v3_properties_by_object_type_by_property_nameobjectType (string)
propertyName (string)
properties/patch_crm_v3_properties_by_object_type_by_property_nameobjectType (string)
propertyName (string)
data: {
. groupName (string)
. hidden (boolean)
. options (array)
. displayOrder (integer)
. description (string)
. calculationFormula (string)
. label (string)
. type (string)
. fieldType (string)
. formField (boolean)
} (object) required
properties/post_crm_v3_properties_by_object_type_batch_readobjectType (string)
data: {
. archived (boolean)
. inputs (array)
} (object) required
properties/post_crm_v3_properties_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
properties/get_crm_v3_properties_by_object_typeobjectType (string)
archived (boolean)
properties (string)
properties/post_crm_v3_properties_by_object_typeobjectType (string)
data: {
. hidden (boolean)
. displayOrder (integer)
. description (string)
. label (string)
. type (string)
. formField (boolean)
. groupName (string)
. referencedObjectType (string)
. name (string)
. options (array)
. calculationFormula (string)
. hasUniqueValue (boolean)
. fieldType (string)
. externalOptions (boolean)
} (object) required
properties/get_crm_v3_properties_by_object_type_groupsobjectType (string)
properties/post_crm_v3_properties_by_object_type_groupsobjectType (string)
data: {
. name (string)
. displayOrder (integer)
. label (string)
} (object) required
property_validations/get_crm_v3_property_validations_by_object_type_idobjectTypeId (string)
property_validations/get_crm_v3_property_validations_by_object_type_id_by_property_nameobjectTypeId (string)
propertyName (string)
public_app_crm_cards/get_crm_v3_extensions_cards_dev_sample_response
public_app_crm_cards/get_crm_v3_extensions_cards_dev_by_app_idappId (integer)
public_app_crm_cards/post_crm_v3_extensions_cards_dev_by_app_idappId (integer)
data: {
. fetch
. display
. title (string)
. actions
} (object) required
public_app_crm_cards/get_crm_v3_extensions_cards_dev_by_app_id_by_card_idcardId (string)
appId (integer)
public_app_crm_cards/delete_crm_v3_extensions_cards_dev_by_app_id_by_card_idcardId (string)
appId (integer)
public_app_crm_cards/patch_crm_v3_extensions_cards_dev_by_app_id_by_card_idcardId (string)
appId (integer)
data: {
. fetch
. display
. title (string)
. actions
} (object) required
public_app_feature_flags_v3/post_feature_flags_v3_by_app_id_flags_by_flag_name_portals_batch_upsertflagName (string)
appId (integer)
data: {
. portalStates (array)
} (object) required
public_app_feature_flags_v3/get_feature_flags_v3_by_app_id_flags_by_flag_name_portalsflagName (string)
appId (integer)
startPortalId (integer)
limit (integer)
public_app_feature_flags_v3/get_feature_flags_v3_by_app_id_flags_by_flag_name_portals_by_portal_idflagName (string)
portalId (integer)
appId (integer)
public_app_feature_flags_v3/put_feature_flags_v3_by_app_id_flags_by_flag_name_portals_by_portal_idflagName (string)
portalId (integer)
appId (integer)
data: {
. flagState (string)
} (object) required
public_app_feature_flags_v3/delete_feature_flags_v3_by_app_id_flags_by_flag_name_portals_by_portal_idflagName (string)
portalId (integer)
appId (integer)
public_app_feature_flags_v3/post_feature_flags_v3_by_app_id_flags_by_flag_name_portals_batch_deleteflagName (string)
appId (integer)
data: {
. portalIds (array)
} (object) required
public_app_feature_flags_v3/get_feature_flags_v3_by_app_id_flags_by_flag_nameflagName (string)
appId (integer)
public_app_feature_flags_v3/put_feature_flags_v3_by_app_id_flags_by_flag_nameflagName (string)
appId (integer)
data: {
. overrideState (string)
. defaultState (string)
} (object) required
public_app_feature_flags_v3/delete_feature_flags_v3_by_app_id_flags_by_flag_nameflagName (string)
appId (integer)
quotes/post_crm_v3_objects_quotes_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
quotes/get_crm_v3_objects_quotes_by_quote_idquoteId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
quotes/delete_crm_v3_objects_quotes_by_quote_idquoteId (string)
quotes/patch_crm_v3_objects_quotes_by_quote_idquoteId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
quotes/post_crm_v3_objects_quotes_batch_archivedata: {
. inputs (array)
} (object) required
quotes/post_crm_v3_objects_quotes_batch_createdata: {
. inputs (array)
} (object) required
quotes/post_crm_v3_objects_quotes_batch_updatedata: {
. inputs (array)
} (object) required
quotes/get_crm_v3_objects_quoteslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
quotes/post_crm_v3_objects_quotesdata: {
. associations (array)
. properties (object)
} (object) required
quotes/post_crm_v3_objects_quotes_batch_upsertdata: {
. inputs (array)
} (object) required
quotes/post_crm_v3_objects_quotes_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
schemas/get_crm_object_schemas_v3_schemasarchived (boolean)
schemas/post_crm_object_schemas_v3_schemasdata: {
. secondaryDisplayProperties (array)
. requiredProperties (array)
. searchableProperties (array)
. primaryDisplayProperty (string)
. name (string)
. description (string)
. associatedObjects (array)
. properties (array)
. labels
} (object) required
schemas/get_crm_object_schemas_v3_schemas_by_object_typeobjectType (string)
schemas/delete_crm_object_schemas_v3_schemas_by_object_typeobjectType (string)
archived (boolean)
schemas/patch_crm_object_schemas_v3_schemas_by_object_typeobjectType (string)
data: {
. secondaryDisplayProperties (array)
. requiredProperties (array)
. searchableProperties (array)
. clearDescription (boolean)
. primaryDisplayProperty (string)
. description (string)
. restorable (boolean)
. labels
} (object) required
schemas/post_crm_object_schemas_v3_schemas_by_object_type_associationsobjectType (string)
data: {
. fromObjectTypeId (string)
. name (string)
. toObjectTypeId (string)
} (object) required
schemas/delete_crm_object_schemas_v3_schemas_by_object_type_associations_by_association_identifierobjectType (string)
associationIdentifier (string)
send_event_completions/post_events_v3_send_batchdata: {
. inputs (array)
} (object) required
send_event_completions/post_events_v3_senddata: {
. occurredAt (string)
. eventName (string)
. utk (string)
. uuid (string)
. email (string)
. properties (object)
. objectId (string)
} (object) required
sequences/get_automation_v4_sequences_enrollments_contact_by_contact_idcontactId (string)
sequences/get_automation_v4_sequencesuserId (string) required
after (string)
limit (integer)
name (string)
sequences/post_automation_v4_sequences_enrollmentsuserId (string) required
data: {
. contactId (string)
. senderEmail (string)
. sequenceId (string)
} (object) required
sequences/get_automation_v4_sequences_by_sequence_idsequenceId (string)
userId (string) required
services/post_crm_v3_objects_by_object_type_batch_readobjectType (string)
archived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
services/get_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
services/delete_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
services/patch_crm_v3_objects_by_object_type_by_object_idobjectType (string)
objectId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
services/post_crm_v3_objects_by_object_type_batch_archiveobjectType (string)
data: {
. inputs (array)
} (object) required
services/post_crm_v3_objects_by_object_type_batch_createobjectType (string)
data: {
. inputs (array)
} (object) required
services/post_crm_v3_objects_by_object_type_batch_updateobjectType (string)
data: {
. inputs (array)
} (object) required
services/get_crm_v3_objects_by_object_typeobjectType (string)
limit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
services/post_crm_v3_objects_by_object_typeobjectType (string)
data: {
. associations (array)
. properties (object)
} (object) required
services/post_crm_v3_objects_by_object_type_batch_upsertobjectType (string)
data: {
. inputs (array)
} (object) required
services/post_crm_v3_objects_by_object_type_searchobjectType (string)
data: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
singlesend/post_marketing_v4_email_single_senddata: {
. customProperties (object)
. emailId (integer)
. message
. contactProperties (object)
} (object) required
site_search/get_cms_v3_site_search_indexed_data_by_content_idcontentId (string)
type (string)
site_search/get_cms_v3_site_search_searchq (string)
limit (integer)
offset (integer)
language (string)
matchPrefix (boolean)
autocomplete (boolean)
popularityBoost (number)
boostLimit (number)
boostRecent (string)
tableId (integer)
hubdbQuery (string)
domain (array)
type (array)
pathPrefix (array)
property (array)
length (string)
groupId (array)
source_code/get_cms_v3_source_code_by_environment_content_by_pathenvironment (string)
path (string)
source_code/put_cms_v3_source_code_by_environment_content_by_pathenvironment (string)
path (string)
source_code/post_cms_v3_source_code_by_environment_content_by_pathenvironment (string)
path (string)
source_code/delete_cms_v3_source_code_by_environment_content_by_pathenvironment (string)
path (string)
source_code/get_cms_v3_source_code_by_environment_metadata_by_pathenvironment (string)
path (string)
properties (string)
source_code/post_cms_v3_source_code_by_environment_validate_by_pathpath (string)
environment (string)
source_code/post_cms_v3_source_code_extract_asyncdata: {
. path (string)
} (object) required
source_code/get_cms_v3_source_code_extract_async_tasks_by_task_id_statustaskId (integer)
subscriptions/post_communication_preferences_v4_statuses_batch_writedata: {
. inputs (array)
} (object) required
subscriptions/get_communication_preferences_v4_statuses_by_subscriber_id_string_unsubscribe_allsubscriberIdString (string)
businessUnitId (integer)
verbose (boolean)
channel (string) required
subscriptions/post_communication_preferences_v4_statuses_by_subscriber_id_string_unsubscribe_allsubscriberIdString (string)
businessUnitId (integer)
verbose (boolean)
channel (string) required
subscriptions/post_communication_preferences_v4_statuses_batch_readbusinessUnitId (integer)
channel (string) required
data: {
. inputs (array)
} (object) required
subscriptions/post_communication_preferences_v4_statuses_batch_unsubscribe_allbusinessUnitId (integer)
verbose (boolean)
channel (string) required
data: {
. inputs (array)
} (object) required
subscriptions/get_communication_preferences_v4_definitionsbusinessUnitId (integer)
includeTranslations (boolean)
subscriptions/post_communication_preferences_v4_statuses_batch_unsubscribe_all_readbusinessUnitId (integer)
channel (string) required
data: {
. inputs (array)
} (object) required
subscriptions/get_communication_preferences_v4_statuses_by_subscriber_id_stringsubscriberIdString (string)
businessUnitId (integer)
channel (string) required
subscriptions/post_communication_preferences_v4_statuses_by_subscriber_id_stringsubscriberIdString (string)
data: {
. statusState (string)
. channel (string)
. legalBasis (string)
. subscriptionId (integer)
. legalBasisExplanation (string)
} (object) required
tags/post_cms_v3_blogs_tags_batch_updatearchived (boolean)
data: {
. inputs (array)
} (object) required
tags/post_cms_v3_blogs_tags_multi_language_update_languagesdata: {
. languages (object)
. primaryId (string)
} (object) required
tags/post_cms_v3_blogs_tags_multi_language_detach_from_lang_groupdata: {
. id (string)
} (object) required
tags/post_cms_v3_blogs_tags_batch_createdata: {
. inputs (array)
} (object) required
tags/post_cms_v3_blogs_tags_batch_archivedata: {
. inputs (array)
} (object) required
tags/put_cms_v3_blogs_tags_multi_language_set_new_lang_primarydata: {
. id (string)
} (object) required
tags/post_cms_v3_blogs_tags_batch_readarchived (boolean)
data: {
. inputs (array)
} (object) required
tags/get_cms_v3_blogs_tagscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
property (string)
tags/post_cms_v3_blogs_tagsdata: {
. deletedAt (string)
. created (string)
. name (string)
. language (string)
. id (string)
. translatedFromId (integer)
. updated (string)
} (object) required
tags/post_cms_v3_blogs_tags_multi_language_attach_to_lang_groupdata: {
. language (string)
. id (string)
. primaryId (string)
. primaryLanguage (string)
} (object) required
tags/get_cms_v3_blogs_tags_by_object_idobjectId (string)
archived (boolean)
property (string)
tags/delete_cms_v3_blogs_tags_by_object_idobjectId (string)
archived (boolean)
tags/patch_cms_v3_blogs_tags_by_object_idobjectId (string)
archived (boolean)
data: {
. deletedAt (string)
. created (string)
. name (string)
. language (string)
. id (string)
. translatedFromId (integer)
. updated (string)
} (object) required
tags/post_cms_v3_blogs_tags_multi_language_create_language_variationdata: {
. name (string)
. language (string)
. id (string)
. primaryLanguage (string)
} (object) required
tasks/post_crm_v3_objects_tasks_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
tasks/get_crm_v3_objects_tasks_by_task_idtaskId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
tasks/delete_crm_v3_objects_tasks_by_task_idtaskId (string)
tasks/patch_crm_v3_objects_tasks_by_task_idtaskId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
tasks/post_crm_v3_objects_tasks_batch_archivedata: {
. inputs (array)
} (object) required
tasks/post_crm_v3_objects_tasks_batch_createdata: {
. inputs (array)
} (object) required
tasks/post_crm_v3_objects_tasks_batch_updatedata: {
. inputs (array)
} (object) required
tasks/get_crm_v3_objects_taskslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
tasks/post_crm_v3_objects_tasksdata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
tasks/post_crm_v3_objects_tasks_batch_upsertdata: {
. inputs (array)
} (object) required
tasks/post_crm_v3_objects_tasks_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
taxes/post_crm_v3_objects_taxes_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
taxes/get_crm_v3_objects_taxes_by_tax_idtaxId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
taxes/delete_crm_v3_objects_taxes_by_tax_idtaxId (string)
taxes/patch_crm_v3_objects_taxes_by_tax_idtaxId (string)
idProperty (string)
data: {
. properties (object)
} (object) required
taxes/post_crm_v3_objects_taxes_batch_archivedata: {
. inputs (array)
} (object) required
taxes/post_crm_v3_objects_taxes_batch_createdata: {
. inputs (array)
} (object) required
taxes/post_crm_v3_objects_taxes_batch_updatedata: {
. inputs (array)
} (object) required
taxes/get_crm_v3_objects_taxeslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
taxes/post_crm_v3_objects_taxesdata: {
. associations (array)
. properties (object)
} (object) required
taxes/post_crm_v3_objects_taxes_batch_upsertdata: {
. inputs (array)
} (object) required
taxes/post_crm_v3_objects_taxes_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
test_child_api/get_account_info_v3_activity_loginafter (string)
limit (integer)
userId (integer)
test_child_api/get_account_info_v3_activity_audit_logsafter (string)
limit (integer)
actingUserId (array)
occurredAfter (string)
occurredBefore (string)
sort (array)
test_child_api/get_account_info_v3_api_usage_daily
test_child_api/get_account_info_v3_details
test_child_api/get_account_info_v3_activity_securityafter (string)
limit (integer)
userId (integer)
fromTimestamp (integer)
tickets/post_crm_v3_objects_tickets_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
tickets/get_crm_v3_objects_tickets_by_ticket_idticketId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
tickets/delete_crm_v3_objects_tickets_by_ticket_idticketId (string)
tickets/patch_crm_v3_objects_tickets_by_ticket_idticketId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
tickets/post_crm_v3_objects_tickets_mergedata: {
. objectIdToMerge (string)
. primaryObjectId (string)
} (object) required
tickets/post_crm_v3_objects_tickets_batch_archivedata: {
. inputs (array)
} (object) required
tickets/post_crm_v3_objects_tickets_batch_createdata: {
. inputs (array)
} (object) required
tickets/post_crm_v3_objects_tickets_batch_updatedata: {
. inputs (array)
} (object) required
tickets/get_crm_v3_objects_ticketslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
tickets/post_crm_v3_objects_ticketsdata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
tickets/post_crm_v3_objects_tickets_batch_upsertdata: {
. inputs (array)
} (object) required
tickets/post_crm_v3_objects_tickets_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
timeline/get_integrators_timeline_v3_events_by_event_template_id_by_event_id_detaileventTemplateId (string)
eventId (string)
timeline/post_integrators_timeline_v3_eventsdata: {
. eventTemplateId (string)
. extraData (object)
. timelineIFrame
. domain (string)
. tokens (object)
. id (string)
. utk (string)
. email (string)
. objectId (string)
. timestamp (string)
} (object) required
timeline/put_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id_tokens_by_token_nameeventTemplateId (string)
tokenName (string)
appId (integer)
data: {
. options (array)
. label (string)
. objectPropertyName (string)
} (object) required
timeline/delete_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id_tokens_by_token_nameeventTemplateId (string)
tokenName (string)
appId (integer)
timeline/get_integrators_timeline_v3_events_by_event_template_id_by_event_ideventTemplateId (string)
eventId (string)
timeline/post_integrators_timeline_v3_events_batch_createdata: {
. inputs (array)
} (object) required
timeline/get_integrators_timeline_v3_events_by_event_template_id_by_event_id_rendereventTemplateId (string)
eventId (string)
detail (boolean)
timeline/get_integrators_timeline_v3_by_app_id_event_templatesappId (integer)
timeline/post_integrators_timeline_v3_by_app_id_event_templatesappId (integer)
data: {
. detailTemplate (string)
. name (string)
. tokens (array)
. headerTemplate (string)
. objectType (string)
} (object) required
timeline/get_integrators_timeline_v3_by_app_id_event_templates_by_event_template_ideventTemplateId (string)
appId (integer)
timeline/put_integrators_timeline_v3_by_app_id_event_templates_by_event_template_ideventTemplateId (string)
appId (integer)
data: {
. detailTemplate (string)
. name (string)
. tokens (array)
. id (string)
. headerTemplate (string)
} (object) required
timeline/delete_integrators_timeline_v3_by_app_id_event_templates_by_event_template_ideventTemplateId (string)
appId (integer)
timeline/post_integrators_timeline_v3_by_app_id_event_templates_by_event_template_id_tokenseventTemplateId (string)
appId (integer)
data: {
. createdAt (string)
. options (array)
. name (string)
. label (string)
. objectPropertyName (string)
. type (string)
. updatedAt (string)
} (object) required
transactional_single_send/post_marketing_v3_transactional_single_email_senddata: {
. customProperties (object)
. emailId (integer)
. message
. contactProperties (object)
} (object) required
transactional_single_send/get_marketing_v3_transactional_smtp_tokenscampaignName (string)
emailCampaignId (string)
after (string)
limit (integer)
transactional_single_send/post_marketing_v3_transactional_smtp_tokensdata: {
. createContact (boolean)
. campaignName (string)
} (object) required
transactional_single_send/post_marketing_v3_transactional_smtp_tokens_by_token_id_password_resettokenId (string)
transactional_single_send/get_marketing_v3_transactional_smtp_tokens_by_token_idtokenId (string)
transactional_single_send/delete_marketing_v3_transactional_smtp_tokens_by_token_idtokenId (string)
url_redirects/get_cms_v3_url_redirectscreatedAt (string)
createdAfter (string)
createdBefore (string)
updatedAt (string)
updatedAfter (string)
updatedBefore (string)
sort (array)
after (string)
limit (integer)
archived (boolean)
url_redirects/post_cms_v3_url_redirectsdata: {
. isTrailingSlashOptional (boolean)
. isMatchQueryString (boolean)
. redirectStyle (integer)
. routePrefix (string)
. isMatchFullUrl (boolean)
. isProtocolAgnostic (boolean)
. destination (string)
. isOnlyAfterNotFound (boolean)
. isPattern (boolean)
. precedence (integer)
} (object) required
url_redirects/get_cms_v3_url_redirects_by_url_redirect_idurlRedirectId (string)
url_redirects/delete_cms_v3_url_redirects_by_url_redirect_idurlRedirectId (string)
url_redirects/patch_cms_v3_url_redirects_by_url_redirect_idurlRedirectId (string)
data: {
. isTrailingSlashOptional (boolean)
. redirectStyle (integer)
. isMatchQueryString (boolean)
. created (string)
. isMatchFullUrl (boolean)
. destination (string)
. isOnlyAfterNotFound (boolean)
. isPattern (boolean)
. precedence (integer)
. routePrefix (string)
. isProtocolAgnostic (boolean)
. id (string)
. updated (string)
} (object) required
user_provisioning/get_settings_v3_users_teams
user_provisioning/get_settings_v3_users_roles
user_provisioning/get_settings_v3_userslimit (integer)
after (string)
user_provisioning/post_settings_v3_usersdata: {
. firstName (string)
. lastName (string)
. primaryTeamId (string)
. sendWelcomeEmail (boolean)
. roleId (string)
. secondaryTeamIds (array)
. email (string)
} (object) required
user_provisioning/get_settings_v3_users_by_user_iduserId (string)
idProperty (string)
user_provisioning/put_settings_v3_users_by_user_iduserId (string)
idProperty (string)
data: {
. firstName (string)
. lastName (string)
. primaryTeamId (string)
. roleId (string)
. secondaryTeamIds (array)
} (object) required
user_provisioning/delete_settings_v3_users_by_user_iduserId (string)
idProperty (string)
users/post_crm_v3_objects_users_batch_readarchived (boolean)
data: {
. propertiesWithHistory (array)
. idProperty (string)
. inputs (array)
. properties (array)
} (object) required
users/get_crm_v3_objects_users_by_user_iduserId (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
idProperty (string)
users/delete_crm_v3_objects_users_by_user_iduserId (string)
users/patch_crm_v3_objects_users_by_user_iduserId (string)
idProperty (string)
data: {
. objectWriteTraceId (string)
. properties (object)
} (object) required
users/post_crm_v3_objects_users_batch_archivedata: {
. inputs (array)
} (object) required
users/post_crm_v3_objects_users_batch_createdata: {
. inputs (array)
} (object) required
users/post_crm_v3_objects_users_batch_updatedata: {
. inputs (array)
} (object) required
users/get_crm_v3_objects_userslimit (integer)
after (string)
properties (array)
propertiesWithHistory (array)
associations (array)
archived (boolean)
users/post_crm_v3_objects_usersdata: {
. associations (array)
. objectWriteTraceId (string)
. properties (object)
} (object) required
users/post_crm_v3_objects_users_batch_upsertdata: {
. inputs (array)
} (object) required
users/post_crm_v3_objects_users_searchdata: {
. query (string)
. limit (integer)
. after (string)
. sorts (array)
. properties (array)
. filterGroups (array)
} (object) required
video_conferencing_extension/get_crm_v3_extensions_videoconferencing_settings_by_app_idappId (integer)
video_conferencing_extension/put_crm_v3_extensions_videoconferencing_settings_by_app_idappId (integer)
data: {
. userVerifyUrl (string)
. fetchAccountsUri (string)
. createMeetingUrl (string)
. updateMeetingUrl (string)
. deleteMeetingUrl (string)
} (object) required
video_conferencing_extension/delete_crm_v3_extensions_videoconferencing_settings_by_app_idappId (integer)
visitor_identification/post_visitor_identification_v3_tokens_createdata: {
. firstName (string)
. lastName (string)
. email (string)
} (object) required
webhooks/get_webhooks_v3_by_app_id_settingsappId (integer)
webhooks/put_webhooks_v3_by_app_id_settingsappId (integer)
data: {
. throttling
. targetUrl (string)
} (object) required
webhooks/delete_webhooks_v3_by_app_id_settingsappId (integer)
webhooks/get_webhooks_v3_by_app_id_subscriptions_by_subscription_idsubscriptionId (integer)
appId (integer)
webhooks/delete_webhooks_v3_by_app_id_subscriptions_by_subscription_idsubscriptionId (integer)
appId (integer)
webhooks/patch_webhooks_v3_by_app_id_subscriptions_by_subscription_idsubscriptionId (integer)
appId (integer)
data: {
. active (boolean)
} (object) required
webhooks/get_webhooks_v3_by_app_id_subscriptionsappId (integer)
webhooks/post_webhooks_v3_by_app_id_subscriptionsappId (integer)
data: {
. objectTypeId (string)
. propertyName (string)
. active (boolean)
. eventType (string)
} (object) required
webhooks/post_webhooks_v3_by_app_id_subscriptions_batch_updateappId (integer)
data: {
. inputs (array)
} (object) required