Reference Guide Simba Technologies Inc.

Transcription

1 Simba HubSpot ODBC Driver with SQL Connector Reference Guide Simba Technologies Inc. Version December 23, 2016

2 Copyright 2016 Simba Technologies Inc. All Rights Reserved. Information in this document is subject to change without notice. Companies, names and data used in examples herein are fictitious unless otherwise noted. No part of this publication, or the software it describes, may be reproduced, transmitted, transcribed, stored in a retrieval system, decompiled, disassembled, reverse-engineered, or translated into any language in any form by any means for any purpose without the express written permission of Simba Technologies Inc. Trademarks Simba, the Simba logo, SimbaEngine, and Simba Technologies are registered trademarks of Simba Technologies Inc. in Canada, United States and/or other countries. All other trademarks and/or servicemarks are the property of their respective owners. Microsoft SQL Server, SQL Server, Microsoft, MSDN, Windows, Windows Azure, Windows Server, Windows Vista, and the Windows start button are trademarks or registered trademarks of Microsoft Corporation or its subsidiaries in Canada, United States and/or other countries. Contact Us Simba Technologies Inc. 938 West 8th Avenue Vancouver, BC Canada V5Z 1E5 Tel: +1 (604) Fax: +1 (604)

3 Simba HubSpot ODBC Driver Reference Simba HubSpot ODBC Driver Reference Purpose The Simba HubSpot ODBC Driver with SQL Connector Reference Guide describes the schema tables and stored procedures available for the Simba HubSpot ODBC Driver. Audience The guide is intended for end users of the Simba HubSpot ODBC Driver who have already installed and configured the driver. Knowledge Prerequisites For detailed information about installing, configuring, and using the Simba HubSpot ODBC Driver, see the Simba HubSpot ODBC Driver Install and Configuration Guide. Document Conventions Italics are used when referring to book and document titles. Bold is used in procedures for graphical user interface elements that a user clicks and text that a user types. Monospace font indicates commands, source code, or contents of text files. Note: A text box with a pencil icon indicates a short note appended to a paragraph. Important: A text box with an exclamation mark indicates an important comment related to the preceding paragraph. 3

4 Simba HubSpot ODBC Driver Reference Table of Contents Simba HubSpot ODBC Driver Reference 3 HubSpot Stored Procedures 11 AddContactToCompany() 12 AddContactToList() 13 AddContactToListContent() 14 ArchiveFile() 15 AssociateDealWithContactOrCompany() 16 AssociateEngagement() 17 CloneBlogPost() 18 ClonePage() 19 CreateBlogPost() 20 CreateBlogPostContent() 21 CreateBroadcastMessage() 22 CreateBroadcastMessageContent() 23 CreateCalendarTasks() 24 CreateCalendarTasksContent() 25 CreateCompany() 26 CreateCompanyContent() 27 CreateCompanyProperty() 28 CreateCompanyPropertyContent() 29 CreateCompanyPropertyGroup() 30 CreateCompanyPropertyGroupContent() 31 CreateContact() 32 CreateContactContent() 33 CreateContactList() 34 CreateContactListContent() 35 CreateContactProperty() 36 CreateContactPropertyContent() 37 CreateContactPropertyGroup() 38 CreateContactPropertyGroupContent() 39 CreateDeal() 40 CreateDealContent() 41 CreateDealProperty() 42 CreateDealPropertyContent() 43 CreateDealPropertyGroup()

5 Simba HubSpot ODBC Driver Reference CreateDealPropertyGroupContent() 45 CreateEngagement() 46 CreateEngagementContent() 47 CreateForm() 48 CreateFormContent() 49 CreateOwner() 50 CreateOwnerContent() 51 CreatePage() 52 CreatePageContent() 53 CreateWorkflow() 54 CreateWorkflowContent() 55 DeleteEngagement() 56 EnrollContactIntoWorkflow() 57 GetACompany() 58 GetAContact() 59 GetADeal() 60 GetAnEngagement() 61 GetPreviousVersionOfASiteMap() 63 GetSiteMapById() 65 ListSiteMapPreviousVersions() 66 ListAllSiteMaps() 67 LogEvents() 68 MergeBlogTopics() 69 MergeContacts() 70 MoveFileToNewFolder() 71 PublishOrScheduleOrUnpublishBlogPost() 72 PublishOrScheduleOrUnpublishPage() 73 RemoveContactFromCompany() 74 RemoveContactFromList() 75 RemoveContactFromListContent() 76 RemoveDealAssociationWithContactOrCompany() 77 RestoreBlogPostRevision() 78 RestoreDeletedBlogPost() 79 RestoreDeletedComment() 80 RestoreDeletedPage() 81 RestoreDeletedTemplate() 82 RestorePageRevision() 83 RestoreTemplateRevision()

6 Simba HubSpot ODBC Driver Reference SearchBlogAuthors() 85 SearchBlogTopics() 86 SearchContacts() 88 SubmitFormData() 89 UnenrollContactFromWorkflow() 90 UpdateBlogPost() 91 UpdateBlogPostContent() 92 UpdateCalendarTasks() 93 UpdateCalendarTasksContent() 94 UpdateCompany() 95 UpdateCompanyContent() 96 UpdateCompanyProperty() 97 UpdateCompanyPropertyContent() 98 UpdateCompanyPropertyGroup() 99 UpdateCompanyPropertyGroupContent() 100 UpdateContact() 101 UpdateContactContent() 102 UpdateContactList() 103 UpdateContactListContent() 104 UpdateContactProperty() 105 UpdateContactPropertyContent() 106 UpdateContactPropertyGroup() 107 UpdateContactPropertyGroupContent() 108 UpdateDeal() 109 UpdateDealContent() 110 UpdateDealProperty() 111 UpdateDealPropertyContent() 112 UpdateEngagement() 113 UpdateEngagementContent() 114 UpdateForm() 115 UpdateFormContent() 116 UpdateOwner() 117 UpdateOwnerContent() 118 UpdatePage() 119 UpdatePageContent() Blog_Authors

7 Simba HubSpot ODBC Driver Reference Blog_Comments 124 Blog_Post_Versions 126 Blog_Post_Versions_Attached_Stylesheets 133 Blog_Post_Versions_Keywords 134 Blog_Post_Versions_Personas 135 Blog_Post_Versions_Placement_Guids 136 Blog_Post_Versions_Topic_Ids 137 Blog_Posts 138 Blog_Posts_Attached_Stylesheets 144 Blog_Posts_Keywords 145 Blog_Posts_Personas 146 Blog_Posts_Placement_Guids 147 Blog_Posts_Topic_Ids 148 Blog_Topics 149 Blog_Versions 150 Blog_Versions_Attached_Stylesheets 156 Blog_Versions_Comment_Notification_ s 157 Blog_Versions_Html_Keywords 158 Blogs 159 Blogs_Attached_Stylesheets 164 Blogs_Comment_Notification_ s 165 Blogs_Html_Keywords 166 Broadcast_Messages 167 Broadcast_Messages_Interactions 170 Calendar_Events 171 Calendar_Tasks 173 Calendar_Tasks_Topic_Ids 175 Channels 176 Companies 179 Companies_Additional_Domains 186 Company_Properties 187 Company_Properties_Options 189 Company_Property_Groups 190 Contact_Form_Submissions_Metadata 191 Contact_Lists 192 Contact_Lists_Filters 193 Contact_Merge_Audits_Merged_From_ _Source_Vids 194 Contact_Properties

8 Simba HubSpot ODBC Driver Reference Contact_Properties_Options 197 Contact_Property_Groups 198 Contacts 199 Contacts_Form_Submissions 201 Contacts_Identity_Profiles 202 Contacts_Identity_Profiles_Identities 203 Contacts_List_Memberships 204 Contacts_Merge_Audits 205 Contacts_Merged_Vids 207 Current_Enrollments 208 Current_Enrollments_Goal_List_Excluded_List_Ids 210 Current_Enrollments_Reenrollment_TriggerSet 211 Current_Enrollments_Steps 212 Current_Enrollments_Steps_Increment_Company_Property_Actions 215 Current_Enrollments_Steps_Notification_Actions 217 Current_Enrollments_Steps_Set_Company_Property_Actions 219 Current_Enrollments_Steps_Sms_Notification_Actions 221 Current_Enrollments_Steps_Task_Actions 223 Current_Enrollments_Steps_Workflow_Enrollment_Actions 225 Current_Enrollments_Suppression_Setting_Excluded_List_Ids 227 Current_Enrollments_Trigger_Set 228 Current_Enrollments_Triggers 229 Current_Enrollments_Unenrollment_Setting_Excluded_Workflows 230 Deal_Pipelines 231 Deal_Pipelines_Stages 232 Deal_Properties 233 Deal_Properties_Options 235 Deal_Property_Groups 236 Deals 237 Deals_Associations_Associated_Company_Ids 239 Deals_Associations_Associated_Deal_Ids 240 Deals_Associations_Associated_Vids 241 Deals_Imports 242 Domains 243 File_Metadata 245 Folder_Metadata 248 Form_Field_Groups 249 Form_Field_Groups_Fields

9 Simba HubSpot ODBC Driver Reference Form_Field_Groups_Fields_Dependent_Field_Filters 252 Form_Field_Groups_Fields_Options 253 Form_Field_Groups_Fields_Selected_Options 255 Form_Field_Groups_Fields_Validation_Blocked_ _Addresses 256 Forms 258 Forms_Metadata 260 Forms_Social_Login_Types 261 Keywords 262 Keywords_Campaigns 263 Layout_Versions 264 Layout_Versions_Attached_Stylesheets 266 Layouts 267 Layouts_Attached_Stylesheets 269 Owners 270 Owners_Remote_List 271 Page_Attached_Stylesheets 272 Page_Keywords 273 Page_Publishing_Personas 274 Page_Versions 275 Page_Versions_Attached_Stylesheets 282 Page_Versions_Keywords 283 Page_Versions_Personas 284 Pages 285 Template_Versions 291 Template_Versions_Attached_Stylesheets 295 Templates 296 Templates_Attached_Stylesheets 299 Url_Mappings 300 Workflows 302 Workflows_Actions 305 Workflows_Goal_Criteria 306 Workflows_Goal_List_Ids 307 Workflows_Metadata_Triggered_By_Workflow_Ids 308 Workflows_Reenrollment_Trigger_Sets 309 Workflows_Segment_Criteria 310 Workflows_Suppression_List_Ids 311 Workflows_Trigger_Sets 312 Workflows_Unenrollment_Setting_Excluded_Workflows

10 Simba HubSpot ODBC Driver Reference Contact Us 314 Third-Party Trademarks 315 Third-Party Licenses

11 HubSpot Stored Procedures HubSpot Stored Procedures The Simba HubSpot ODBC Driver provides stored procedures that you can use to create, view, modify, and delete objects from a HubSpot data source. The stored procedures are listed alphabetically by table name. For each stored procedure, the following information is provided: The name of the stored procedure. A brief description of the stored procedure. The name, SQL type, and description of each parameter used by the stored procedure. If the stored procedure requires a JSON input as one of the parameters, the structure of the JSON. A description of the data that is returned by the stored procedure, if any. 11

12 HubSpot Stored Procedures AddContactToCompany() Associate a contact with a company. If the contact is already associated with a different company, the contact is added to the new company and removed from the old company, as a contact can only be associated with one company at a time. Parameters Company_Id SQL_VARCHAR(50) The company that the contact is currently associated with, if any. Contact_Id SQL_VARCHAR(50) The ID of the contact to be assigned to the company. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 12

13 HubSpot Stored Procedures AddContactToList() Add a contact to a contact list, using the details that are stored in the specified JSON file. Note: This procedure cannot update a dynamic contact list. Parameters List_Id SQL_VARCHAR(50) The ID of the list to which the contact is added. Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the contact. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 13

14 HubSpot Stored Procedures AddContactToListContent() Add a contact to a contact list, based on the details contained in the specified JSON string. Note: This procedure cannot update a dynamic contact list. Parameters List_Id SQL_VARCHAR(50) The ID of the list to which the contact is added. File_Content SQL_LONGVARCHAR( ) The JSON string that contains the contact. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 14

15 HubSpot Stored Procedures ArchiveFile() Archives an existing file, removing it from the HubSpot user interface. Parameters File_Id SQL_VARCHAR(50) The ID of the file to be archived. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 15

16 HubSpot Stored Procedures AssociateDealWithContactOrCompany() Creates an association between an existing deal and contacts or companies. This stored procedure supports simultaneously associating a deal with more than one contact or company, but only of a single type. To associate a deal with both contacts and companies, you must call this stored procedure twice. Parameters Deal_Id SQL_VARCHAR(50) The ID of the deal to be associated with contacts or companies. Object_Type SQL_VARCHAR(50) The type of object that the deal is to be associated with, either CONTACT or COMPANY. Contact_Or_Company_Ids SQL_VARCHAR(50) A list of contact or company IDs that the deal is to be associated with, depending on what was passed in as the Object_Type. Multiple IDs must be separated by a comma,, for example, ,123456, Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 16

17 HubSpot Stored Procedures AssociateEngagement() Creates an association between an existing HubSpot engagement (a task or activity) and a single contact, company, or deal. Parameters Engagement_Id SQL_VARCHAR(50) The ID of the engagement to be associated with a contact, company, or deal. For more information, see the HubSpot documentation at Object_Type SQL_VARCHAR(50) The type of object that the engagement is to be associated with, either CONTACT, COMPANY, or DEAL. Object_Id SQL_VARCHAR(50) The ID of the object that the engagement is to be associated with, depending on what was passed in as the Object_Type. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 17

18 HubSpot Stored Procedures CloneBlogPost() Clone an existing blog post. Parameters Blog_Post_Id SQL_VARCHAR(50) The ID of the blog post to be cloned. New_Page_Name SQL_VARCHAR(50) The name of the new blog post. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 18

19 HubSpot Stored Procedures ClonePage() Make a copy of an existing page in the Pages table. Parameters Page_Id SQL_VARCHAR(50) The ID of the page to be cloned. New_Name SQL_VARCHAR(255) The new name of the newly created page. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 19

20 HubSpot Stored Procedures CreateBlogPost() Create a new blog post, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the blog post. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 20

21 HubSpot Stored Procedures CreateBlogPostContent() Create a new blog post, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the blog post. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 21

22 HubSpot Stored Procedures CreateBroadcastMessage() Create a new broadcast message, such as a tweet or Facebook post, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the broadcast message. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 22

23 HubSpot Stored Procedures CreateBroadcastMessageContent() Create a new broadcast message, such as a tweet or Facebook post, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the broadcast message. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 23

24 HubSpot Stored Procedures CreateCalendarTasks() Create a new Task, using the details that are stored in the specified JSON file. Creating a Task of category BLOG_POST, , or LANDING_PAGE creates a draft of the respective content and associates it with the Task (see the 'Content_Id' column). Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the Task. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 24

25 HubSpot Stored Procedures CreateCalendarTasksContent() Create a new Task, based on the details contained in the specified JSON string. Creating a Task of category BLOG_POST, , or LANDING_PAGE creates a draft of the respective content and associates it with the Task (see the 'Content_Id' column). Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the Task. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 25

26 HubSpot Stored Procedures CreateCompany() Create a new company for a given portal, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the company. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 26

27 HubSpot Stored Procedures CreateCompanyContent() Create a new company for a given portal, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the company. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 27

28 HubSpot Stored Procedures CreateCompanyProperty() Create a new property on every company object to store a specific piece of data, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the new property. For a description of the structure of the JSON file, see the HubSpot documentation at property. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 28

29 HubSpot Stored Procedures CreateCompanyPropertyContent() Create a new property on every company object to store a specific piece of data, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the property. For a description of the structure of the JSON string, see the HubSpot documentation at property. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 29

30 HubSpot Stored Procedures CreateCompanyPropertyGroup() Create a new group of company properties, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the company property group. For a description of the structure of the JSON file, see the HubSpot documentation at property_group. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 30

31 HubSpot Stored Procedures CreateCompanyPropertyGroupContent() Create a new group of company properties, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the company property group. For a description of the structure of the JSON file, see the HubSpot documentation at property_group. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 31

32 HubSpot Stored Procedures CreateContact() Create a new HubSpot contact, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the contact. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 32

33 HubSpot Stored Procedures CreateContactContent() Create a new HubSpot contact, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the contact. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 33

34 HubSpot Stored Procedures CreateContactList() Create a new list of contacts, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the contact list. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 34

35 HubSpot Stored Procedures CreateContactListContent() Create a new list of contacts, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the contact list. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 35

36 HubSpot Stored Procedures CreateContactProperty() Create a new property on every contact object to store a specific piece of data, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the new property. For a description of the structure of the JSON file, see the HubSpot documentation at property. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 36

37 HubSpot Stored Procedures CreateContactPropertyContent() Create a new property on every contact object to store a specific piece of data, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the property. For a description of the structure of the JSON string, see the HubSpot documentation at property. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 37

38 HubSpot Stored Procedures CreateContactPropertyGroup() Create a new group of contact properties, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the contact property group. For a description of the structure of the JSON file, see the HubSpot documentation at property_group. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 38

39 HubSpot Stored Procedures CreateContactPropertyGroupContent() Create a new group of contact properties, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the contact property group. For a description of the structure of the JSON file, see the HubSpot documentation at property_group. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 39

40 HubSpot Stored Procedures CreateDeal() Create a new deal object, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the deal object. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 40

41 HubSpot Stored Procedures CreateDealContent() Create a new deal object, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the deal object. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 41

42 HubSpot Stored Procedures CreateDealProperty() Create a new deal property, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the deal property. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 42

43 HubSpot Stored Procedures CreateDealPropertyContent() Create a new deal property, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the deal property. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 43

44 HubSpot Stored Procedures CreateDealPropertyGroup() Create a new deal property group, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the deal property group. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 44

45 HubSpot Stored Procedures CreateDealPropertyGroupContent() Create a new deal property group, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the deal property group. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 45

46 HubSpot Stored Procedures CreateEngagement() Create a new HubSpot engagement (a task or activity), using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the engagement. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 46

47 HubSpot Stored Procedures CreateEngagementContent() Create a new HubSpot engagement (a task or activity), based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the engagement. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 47

48 HubSpot Stored Procedures CreateForm() Create a new form, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the form. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 48

49 HubSpot Stored Procedures CreateFormContent() Create a new form, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the form. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 49

50 HubSpot Stored Procedures CreateOwner() Create a new owner, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the owner. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 50

51 HubSpot Stored Procedures CreateOwnerContent() Create a new owner, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the owner. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 51

52 HubSpot Stored Procedures CreatePage() Create a new page in the Pages table, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the page. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 52

53 HubSpot Stored Procedures CreatePageContent() Create a new page in the Pages table, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the page. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 53

54 HubSpot Stored Procedures CreateWorkflow() Create a new workflow, using the details that are stored in the specified JSON file. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the workflow. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 54

55 HubSpot Stored Procedures CreateWorkflowContent() Create a new workflow, based on the details contained in the specified JSON string. Parameters File_Content SQL_LONGVARCHAR( ) The JSON string that contains the workflow. For a description of the structure of the JSON string, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 55

56 HubSpot Stored Procedures DeleteEngagement() Delete an existing HubSpot engagement (a task or activity). Parameters Engagement_Id SQL_VARCHAR(50) The ID of the engagement to be deleted. For more information, see the HubSpot documentation at engagement. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 56

57 HubSpot Stored Procedures EnrollContactIntoWorkflow() Add a contact to a workflow. Parameters Workflow_Id SQL_VARCHAR(50) The ID of the workflow into which the contact is enrolled. SQL_VARCHAR(255) The of the contact to be enrolled into a workflow. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 57

58 HubSpot Stored Procedures GetACompany() Retrieve the details of a company. Parameters Company_Id SQL_VARCHAR(50) The ID of the company to retrieve. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following columns: Company_Id SQL_VARCHAR(50) The ID of the company. Portal_Id SQL_VARCHAR(50) The ID of the HubSpot portal that the company was created on. Is_Deleted SQL_BIT 1 if the company is currently being deleted, 0 if it is not. Properties SQL_LONGVARCHAR( ) The properties of the company. 58

59 HubSpot Stored Procedures GetAContact() Retrieve the details of a contact. Parameters Vid SQL_VARCHAR(50) The ID of the contact to retrieve. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Contact_Data SQL_LONGVARCHAR( ) A JSON string that contains the contact. 59

60 HubSpot Stored Procedures GetADeal() Retrieve the details of a deal. Parameters Deal_Id SQL_VARCHAR(50) The ID of the deal to retrieve. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following columns: Deal_Id SQL_VARCHAR(50) The ID of the deal. Portal_Id SQL_VARCHAR(50) The ID of the HubSpot portal that the deal was created on. Is_Deleted SQL_BIT 1 if the deal is currently being deleted, 0 if it is not. Properties SQL_LONGVARCHAR( ) The properties of the deal. Associations SQL_LONGVARCHAR( ) The associations of the deal. 60

61 HubSpot Stored Procedures GetAnEngagement() Retrieve the details of an engagement (a task or activity) on an object in HubSpot. Parameters Engagement_Id SQL_VARCHAR(50) The ID of the engagement to retrieve. For more information, see the HubSpot documentation at engagement. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following columns: Id SQL_VARCHAR(50) The ID of the engagement. Portal_Id Active SQL_VARCHAR(50) The ID of the HubSpot portal that the engagement was created on. SQL_BIT 1 if the engagement is currently active, 0 if it is not. Created_At SQL_TIMESTAMP The creation time of the engagement, in UNIX timestamp format. Last_Updated SQL_TIMESTAMP The last update time of the engagement, in UNIX timestamp format. 61

62 HubSpot Stored Procedures Owner_Id SQL_VARCHAR(25) The ID of the owner who created the engagement. Type SQL_VARCHAR(5) The type of the engagement, either , CALL, MEETING, TASK, or NOTE. Timestamp SQL_TIMESTAMP A timestamp that is used for logical ordering, in Unix timestamp format. Associations_Contact_Ids SQL_LONGVARCHAR( ) The contacts that the engagement is associated with. Associations_Company_Ids SQL_LONGVARCHAR( ) The companies that the engagement is associated with. Associations_Deal_Ids SQL_LONGVARCHAR( ) The deals that the engagement is associated with. Associations_Owner_Ids SQL_LONGVARCHAR( ) The owners that the engagement is associated with. Metadata_Body SQL_LONGVARCHAR( ) Additional metadata that is associated with the engagement. 62

63 HubSpot Stored Procedures GetPreviousVersionOfASiteMap() Retrieve information about a previous version of a specified site map. Parameters Id SQL_VARCHAR(50) The ID of the site map to return version information about. Version_Id SQL_VARCHAR(50) The ID of the version of the site map to return information about. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a table representing the previous version of the site map with the specified ID. The table contains all columns of the table returned by GetSiteMapById(), as well as the following columns: Version_Id SQL_VARCHAR(255) The version ID of the site map revision represented by this row in the table. Updated_At SQL_VARCHAR(50) The time in UNIX timestamp format that the update occurred to create the revision. User_ SQL_VARCHAR(50) The address of the user that was responsible for the revision. User_Full_Name SQL_VARCHAR(50) The full name of the user that was responsible for the revision. 63

64 HubSpot Stored Procedures User_Id SQL_VARCHAR(50) The ID of the user that was responsible for the revision. 64

65 HubSpot Stored Procedures GetSiteMapById() Retrieve a specified site map. Parameters Id SQL_VARCHAR(50) The ID of the site map to retrieve. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a table with a single row containing information about the site map with the specified ID. The table contains all columns of the table returned by ListSiteMaps(), as well as the following columns: Has_User_Changes SQL_BIT 1 if the site map has been changed by a user, 0 if it has not. Site_Id SQL_VARCHAR(50) The ID of the site that is represented by the site map. 65

66 HubSpot Stored Procedures ListSiteMapPreviousVersions() List all previous versions of a specified site map. Parameters Id SQL_VARCHAR(50) The ID of the site map. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a table representing the previous versions of the site map with the specified ID. The table contains all columns of the table returned by GetSiteMapById(), as well as the following columns: Version_Id SQL_VARCHAR(255) The version ID of the site map revision represented by this row in the table. Updated_At SQL_VARCHAR(50) The time in UNIX timestamp format that the update occurred to create a given revision. User_ SQL_VARCHAR(50) The address of the user that was responsible for the revision. User_Full_Name SQL_VARCHAR(50) The full name of the user that was responsible for the revision. User_Id SQL_VARCHAR(50) The ID of the user that was responsible for the revision. 66

67 HubSpot Stored Procedures ListAllSiteMaps() List all site maps that are associated with your HubSpot account. Parameters None Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a table with columns that contain data about all the site maps that are associated with your HubSpot account, including: Pages_Tree FILE_CONTENT, SQL_LONGVARCHAR( ) A JSON string that describes the structure of the site associated with a given row of the table. 67

68 HubSpot Stored Procedures LogEvents() Retrieve a history of events for a contact in a specific workflow. Parameters Workflow_Id SQL_VARCHAR(50) The ID of the workflow to retrieve. Limit_Date SQL_BIGINT(unsigned) The earliest date of an event that is returned, in Unix timestamp format. The default is 180 days before the current time. Offset SQL_BIGINT(unsigned) The latest of an event that is returned, in Unix timestamp format. The default is the current time. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Event_Data SQL_LONGVARCHAR( ) A JSON string that contains the history of events for a contact in the specified workflow. 68

69 HubSpot Stored Procedures MergeBlogTopics() Merge multiple blog topics. A new blog topic is created, and the existing blog topics are deleted. Parameters Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the blog topics to be merged. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 69

70 HubSpot Stored Procedures MergeContacts() Merge two contacts. The information in the secondary contact is added to the primary contact, and the secondary contact is deleted. Parameters Contact_Id SQL_VARCHAR(256) The ID of the primary contact to be merged. This is the contact that remains after the merger. Vid_To_Merge SQL_VARCHAR(256) The ID of the secondary contact to be merged. This is the contact that is merged into the primary contact. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 70

71 HubSpot Stored Procedures MoveFileToNewFolder() Moves a file to a new folder. Parameters File_Id Key Value SQL_VARCHAR(50) The ID of the file to be moved. SQL_VARCHAR(50) Either folder_path or folder_id depending on whether the Value is specified as a path or a folder ID. SQL_VARCHAR(255) The path or ID of the folder to which the file is to be moved. Must match Key above. New_Name SQL_VARCHAR(255) Optional. The new name of the file. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 71

72 HubSpot Stored Procedures PublishOrScheduleOrUnpublishBlogPost() Publish, schedule, or unpublish an existing blog post. Parameters Blog_Post_Id Action SQL_VARCHAR(50) The ID of the blog post to be published, scheduled, or unpublished. SQL_VARCHAR(50) The action to perform on the blog post. For a list of actions, see id_publish_action. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 72

73 HubSpot Stored Procedures PublishOrScheduleOrUnpublishPage() Publish, schedule, or unpublish an existing page. Parameters Page_Id Action SQL_VARCHAR(50) The ID of the page to be published, scheduled, or unpublished. SQL_VARCHAR(50) The action to perform on the page. For a list of actions, see publish_action. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 73

74 HubSpot Stored Procedures RemoveContactFromCompany() Remove a contact from a company. The contact is no longer associated with any company. Parameters Company_Id SQL_VARCHAR(50) The company that the contact is currently associated with, if any. Contact_Id SQL_VARCHAR(50) The ID of the contact to be removed from the company. Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 74

75 HubSpot Stored Procedures RemoveContactFromList() Remove a contact from a contact list, using the details that are stored in the specified JSON file. Note: This procedure cannot update a dynamic contact list. Parameters List_Id SQL_VARCHAR(50) The ID of the list from which the contact is removed. Body_File SQL_VARCHAR(2048) The full path to the JSON file that contains the contact. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 75

76 HubSpot Stored Procedures RemoveContactFromListContent() Remove a contact from a contact list, based on the details contained in the specified JSON string. Note: This procedure cannot update a dynamic contact list. Parameters List_Id SQL_VARCHAR(50) The ID of the list from which the contact is removed. File_Content SQL_LONGVARCHAR( ) The JSON string that contains the contact. For a description of the structure of the JSON file, see the HubSpot documentation at Returns If the procedure fails, it throws an exception. Otherwise, the procedure returns a single-row table with the following column: Return_Code SQL_BIT 1 for success, 0 for failure. 76