Discussed product features and pricing. Client showed interest in our enterprise package.
", "hs_body_preview_is_truncated": "false", "hs_call_body": "Discussed product features and pricing. Client showed interest in our enterprise package.", "hs_call_direction": "OUTBOUND", "hs_call_disposition": "INTERESTED", "hs_call_duration": "1800000", "hs_call_recording_url": "https://example.com/call-recordings/123456.mp3", "hs_call_status": "COMPLETED", "hs_call_title": "Follow-up call with potential client", "hs_call_to_number": "+14085559876", "hs_createdate": "2023-05-15T14:30:00.000Z", "hs_lastmodifieddate": "2023-05-15T14:30:00.000Z", "hs_object_id": "1234567890", "hs_timestamp": "2023-05-15T14:30:00.000Z", "hs_user_ids_of_all_owners": "51", "hubspot_owner_assigneddate": "2023-05-15T14:30:00.000Z", "hubspot_owner_id": "51" }, "createdAt": "2023-05-15T14:30:00.000Z", "updatedAt": "2023-05-15T14:30:00.000Z", "archived": false } ``` ### Create company Create a company. **Sample Input** ```json { "properties": [ { "name": "name", "value": "Acme Corporation" }, { "name": "description", "value": "A leading provider of innovative solutions" }, { "name": "industry", "value": "Technology" }, { "name": "numberOfEmployees", "value": 500 }, { "name": "annualRevenue", "value": 10000000 }, { "name": "city", "value": "San Francisco" }, { "name": "state", "value": "CA" }, { "name": "country", "value": "United States" } ] } ``` **Sample Output** ```json { "id": "1234567890", "properties": { "createdate": "2023-05-15T14:30:00.000Z", "description": "A leading provider of innovative solutions", "hs_lastmodifieddate": "2023-05-15T14:30:00.000Z", "hs_object_id": "1234567890", "hs_pipeline": "default", "lifecyclestage": "lead", "name": "Acme Corporation" }, "createdAt": "2023-05-15T14:30:00.000Z", "updatedAt": "2023-05-15T14:30:00.000Z", "archived": false } ``` ### Create contact Create a new contact in HubSpot. **Sample Input** **Sample Output** ### Create contact list Create new contact list. **Sample Input** **Sample Output** ### Create custom object Create a CRM object with the given properties and return a copy of the object, including the ID. Please define a schema in advance using the 'Create object schema' operation. **Sample Input** **Sample Output** ### Create deal Creates and tracks deals in HubSpot. It also allows you to connect HubSpot with an external CRM or other sales management software. **Sample Input** ```json { "properties": [ { "name": "dealname", "value": "New Software License Deal" }, { "name": "amount", "value": 50000 }, { "name": "dealstage", "value": "appointmentscheduled" }, { "name": "pipeline", "value": "default" }, { "name": "closedate", "value": "2023-12-31" } ] } ``` **Sample Output** ### Create email engagement Create an email with the given properties. **Sample Input** **Sample Output** ### Create line item Create a line item in your HubSpot account. **Sample Input** **Sample Output** ### Create marketing event (beta) Create a new marketing event in HubSpot. **Sample Input** **Sample Output** ```json { "eventName": "Advanced Marketing Strategies Webinar", "eventType": "WEBINAR", "startDateTime": "2023-09-15T14:00:00Z", "endDateTime": "2023-09-15T16:00:00Z", "eventOrganizer": "HubSpot Marketing Team", "eventDescription": "Join us for an in-depth webinar on advanced marketing strategies to boost your business growth.", "eventUrl": "https://www.hubspot.com/webinars/advanced-marketing-strategies", "eventCancelled": false, "customProperties": [ { "name": "max_attendees", "value": "500", "timestamp": 1631707200000, "sourceId": "WEBINAR2023", "sourceLabel": "HubSpot", "source": "API", "selectedByUser": false, "selectedByUserTimestamp": 1631707200000, "sourceVid": [ 123456 ], "sourceMetadata": "", "requestId": "abc123def456" }, { "name": "target_audience", "value": "Marketing Professionals", "timestamp": 1631707200000, "sourceId": "WEBINAR2023", "sourceLabel": "HubSpot", "source": "API", "selectedByUser": false, "selectedByUserTimestamp": 1631707200000, "sourceVid": [ 123456 ], "sourceMetadata": "", "requestId": "abc123def456" } ] } ``` ### Create meeting engagement Create a meeting with the given properties. **Sample Input** **Sample Output** ### Create note engagement Create a note with the given properties. **Sample Input** **Sample Output** ### Create object schema Define a new object schema, along with custom properties and associations. **Sample Input** **Sample Output** ### Create product Create a product in your HubSpot account. **Sample Input** **Sample Output** ```json { "id": "1234567", "properties": { "createdate": "2023-05-15T10:30:00.000Z", "description": "High-quality widget with advanced features", "hs_cost_of_goods_sold": "49.99", "hs_lastmodifieddate": "2023-05-15T10:30:00.000Z", "hs_object_id": "1234567", "name": "Premium Widget", "price": "99.99" }, "createdAt": "2023-05-15T10:30:00.000Z", "updatedAt": "2023-05-15T10:30:00.000Z", "archived": false } ``` ### Create property Create a property on an object type. **Sample Input** **Sample Output** ### Create property group Create a new property group for an object type. **Sample Input** **Sample Output** ### Create task engagement Create a task with the given properties. **Sample Input** ```json { "timestamp": "2023-05-15T14:30:00Z", "subject": "Follow up with client", "body": "Discuss project timeline and next steps", "hubspot_owner_id": "12345", "status": "NOT_STARTED", "priority": "HIGH", "type": "CALL" } ``` **Sample Output** ### Create ticket Create a ticket in your HubSpot account. **Sample Input** **Sample Output** ### Create/update contact If contact already exists update their data. Create a new contact if not i.e. Upsert **Sample Input** ```json { "email": "john.doe@example.com", "properties": [ { "property": "firstname", "value": "John" }, { "property": "lastname", "value": "Doe" }, { "property": "phone", "value": "+1 (555) 123-4567" }, { "property": "company", "value": "Acme Inc." }, { "property": "jobtitle", "value": "Software Engineer" } ] } ``` **Sample Output** ### Create/update marketing event (beta) If a marketing event already exists update the data. Create a new marketing event if it does not i.e. Upsert **Sample Input** **Sample Output** ```json { "eventName": "Advanced Marketing Strategies Webinar", "eventType": "WEBINAR", "startDateTime": "2023-09-15T14:00:00Z", "endDateTime": "2023-09-15T16:00:00Z", "eventOrganizer": "HubSpot Academy", "eventDescription": "Join us for an in-depth webinar on advanced marketing strategies to boost your business growth.", "eventUrl": "https://hubspot.com/webinars/advanced-marketing-strategies", "eventCancelled": false, "customProperties": [ { "name": "max_attendees", "value": "500", "timestamp": 1631721600000, "sourceId": "WEBINAR2023", "sourceLabel": "HubSpot", "source": "API", "selectedByUser": false, "selectedByUserTimestamp": 1631721600000, "sourceVid": [ 123456 ], "sourceMetadata": "", "requestId": "abc123def456" }, { "name": "target_audience", "value": "Marketing Professionals", "timestamp": 1631721600000, "sourceId": "WEBINAR2023", "sourceLabel": "HubSpot", "source": "API", "selectedByUser": false, "selectedByUserTimestamp": 1631721600000, "sourceVid": [ 123456 ], "sourceMetadata": "", "requestId": "abc123def456" } ] } ``` ### Delete associations from CRM objects Delete all associations between two records. **Sample Input** **Sample Output** ### Delete blog post Delete a specified blog post. **Sample Input** **Sample Output** ```json { "success": true } ``` ### Delete comment Mark the comment as deleted. **Sample Input** **Sample Output** ```json { "success": true } ``` ### Delete company Delete a company by the given ID. **Sample Input** **Sample Output** ### Delete contact Delete contact. **Sample Input** **Sample Output** ### Delete contact list Delete a contact list. **Sample Input** **Sample Output** ### Delete custom object association Delete a custom object association. **Sample Input** **Sample Output** ### Delete deal Delete a deal by the given ID. **Sample Input** **Sample Output** ```json { "success": true } ``` ### Delete line item Delete a line item by the given ID. **Sample Input** **Sample Output** ### Delete object schema Delete a schema. NB: Any existing records of this schema must be deleted first, otherwise this request will fail. **Sample Input** **Sample Output** ### Delete product Delete a product by the given ID. **Sample Input** **Sample Output** ### Delete ticket Delete a ticket by the given ID. **Sample Input** **Sample Output** ### Get app settings (beta) Retrieve the current settings for the application. **Sample Input** **Sample Output** ### Get blog post Retrieve a specified blog post. **Sample Input** **Sample Output** ### Get company Return a company by the given ID. **Sample Input** **Sample Output** ### Get company property Get a specific company property by its (internal) name. **Sample Input** **Sample Output** ### Get contact by email Return a contact by the given email address. **Sample Input** **Sample Output** ### Get contact by ID Return a contact by the given ID. **Sample Input** **Sample Output** ```json { "id": "51", "properties": { "createdate": "2023-05-15T10:30:00Z", "email": "john.doe@example.com", "firstname": "John", "hs_object_id": "51", "lastmodifieddate": "2023-05-20T14:45:00Z", "lastname": "Doe" }, "createdAt": "2023-05-15T10:30:00Z", "updatedAt": "2023-05-20T14:45:00Z", "archived": false } ``` ### Get contact list Return a contact list with the given ID. **Sample Input** **Sample Output** ### Get contact property Retrieve contact property. **Sample Input** **Sample Output** ### Get deal Retrieve a deal by the given ID. **Sample Input** **Sample Output** ### Get file import status Retrieve the status of a file import. **Sample Input** **Sample Output** ### Get line item Return a line item by the given ID. **Sample Input** **Sample Output** ### Get marketing event Retrieve details of the specified marketing event. **Sample Input** **Sample Output** ```json { "eventName": "Annual Tech Conference 2023", "eventType": "Conference", "startDateTime": "2023-09-15T09:00:00Z", "endDateTime": "2023-09-17T18:00:00Z", "eventOrganizer": "TechCorp Inc.", "eventDescription": "Join us for our annual tech conference featuring industry leaders and innovative workshops.", "eventUrl": "https://techcorp.com/annual-conference-2023", "eventCancelled": false, "customProperties": [ { "name": "Venue", "value": "San Francisco Convention Center", "sourceVid": [ 1234, 5678 ] }, { "name": "Main Speaker", "value": "Jane Doe", "sourceVid": [ 9876 ] } ], "externalEventId": "EVENT-2023-001", "registrants": 500, "attendees": 450, "cancellations": 30, "noShows": 20, "createdAt": "2023-03-01T10:30:00Z", "updatedAt": "2023-09-18T09:00:00Z", "id": "hubspot-event-id-12345" } ``` ### Get owner Read an owner by given ID or User ID. **Sample Input** **Sample Output** ### Get product Retrieve a product by the given ID. **Sample Input** **Sample Output** ### Get subscription status Retrieve the email subscription information for the given email address and portal. **Sample Input** **Sample Output** ### Get subscriptions timeline Retrieve a time-ordered list of subscription changes. **Sample Input** **Sample Output** ### Get ticket Retrieve a ticket by the given ID. **Sample Input** **Sample Output** ### List association definitions List all association types between two object types. **Sample Input** **Sample Output** ```json { "results": [ { "category": "HUBSPOT_DEFINED", "typeId": 4, "label": "Contact to deal" }, { "category": "USER_DEFINED", "typeId": 1001, "label": "Primary contact" }, { "category": "USER_DEFINED", "typeId": 1002, "label": "Decision maker" } ] } ``` ### List authors Retrieve a list of blog authors. **Sample Input** **Sample Output** ### List blog posts Retrieve a list of blog posts. **Sample Input** **Sample Output** ### List call engagement dispositions Return all possible dispositions for sales calls. **Sample Input** **Sample Output** ### List call engagements Return a list of call engagements. **Sample Input** ```json { "properties": [ "hs_call_title", "hs_call_body", "hs_call_duration", "hs_call_status" ], "properties_with_history": [ "hs_timestamp" ], "associations": [ "contact", "deal" ], "after": "1234567890", "limit": 5 } ``` **Sample Output** ### List changes for line items Return a list of changes to line items. **Sample Input** ```json { "line_item_id": 123456, "timestamp": "2023-05-01T12:00:00Z", "change_type": "UPDATED" } ``` **Sample Output** ### List changes for products Return a list of changes to products. **Sample Input** **Sample Output** ```json { "results": [ { "timestamp": 1683028800000, "changeType": "UPDATED", "objectId": 123456, "changes": { "changedProperties": [ "name", "price", "description" ], "newAssociations": [ "category_123" ], "removedAssociations": [ "category_456" ], "newListMemberships": [ "featured_products" ], "removedListMemberships": [ "clearance_items" ] } }, { "timestamp": 1683029100000, "changeType": "CREATED", "objectId": 789012, "changes": { "changedProperties": [ "name", "price", "description", "sku" ], "newAssociations": [ "category_789" ], "removedAssociations": [], "newListMemberships": [ "new_arrivals" ], "removedListMemberships": [] } } ] } ``` ### List comments Retrieve the comments from your HubSpot blogs. **Sample Input** ```json { "portal_id": "123456", "content_id": 7890123, "state": "APPROVED", "query": "great article", "reverse": false, "limit": 50, "offset": 0 } ``` **Sample Output** ### List companies Return a list of companies in your HubSpot account. **Sample Input** **Sample Output** ### List company properties Return company properties. **Sample Input** **Sample Output** ### List contact list contacts Retrieve a list of contacts on a particular list. **Sample Input** **Sample Output** ### List contact lists Retrieve contact lists for the account. **Sample Input** **Sample Output** ### List contact properties Return contact properties. **Sample Input** **Sample Output** ### List contacts Retrieve all the contacts that have been created in the account. **Sample Input** **Sample Output** ### List CRM object associations List all associations of a CRM object by object type. **Sample Input** **Sample Output** ### List custom objects Retrieve a list of custom objects of a specified type. **Sample Input** **Sample Output** ### List email engagements Return a list of email engagements. **Sample Input** ```json { "properties": [ "hs_email_subject", "hs_email_status", "hs_email_direction" ], "properties_with_history": [ "hs_email_status" ], "associations": [ "contact" ], "after": "1234567890", "limit": 5 } ``` **Sample Output** ### List meeting engagements Return a list of meeting engagements. **Sample Input** **Sample Output** ### List note engagements Return a list of note engagements. **Sample Input** **Sample Output** ### List owners Return all of the owners that exist inside of HubSpot. **Sample Input** **Sample Output** ```json { "results": [ { "id": "1", "email": "john.doe@example.com", "firstName": "John", "lastName": "Doe", "userId": 12345, "createdAt": "2023-05-01T10:00:00Z", "updatedAt": "2023-05-15T14:30:00Z", "archived": false }, { "id": "2", "email": "jane.smith@example.com", "firstName": "Jane", "lastName": "Smith", "userId": 67890, "createdAt": "2023-04-15T09:00:00Z", "updatedAt": "2023-05-10T11:45:00Z", "archived": false } ], "paging": { "next": { "after": "2345678901", "link": "https://api.hubspot.com/crm/v3/owners?after=2345678901&limit=50" } } } ``` ### List products Return a list of products in your HubSpot account. **Sample Input** **Sample Output** ### List properties List all properties for a given object type. **Sample Input** ```json { "object_type": "contacts" } ``` **Sample Output** ### List property groups List all property groups for a given object type. **Sample Input** **Sample Output** ### List recently modified deals Retrieve a list of deals in HubSpot, sorted by last modified date. **Sample Input** **Sample Output** ### List tickets Retrieve a list of all tickets. **Sample Input** **Sample Output** ### Raw HTTP request (advanced) Perform a raw HTTP request with some pre-configuration and processing by the connector, such as authentication. **Sample Input** **Sample Output** ### Search companies by domain Search for companies by domain name. **Sample Input** **Sample Output** ### Update blog post Update a single blog post. **Sample Input** **Sample Output** ```json { "id": "87654321", "slug": "updated-blog-post-title", "contentGroupId": "98765432", "name": "Updated Blog Post Title", "state": "PUBLISHED", "authorName": "John Doe", "createdById": "1122334455", "updatedById": "1122334455", "postBody": "This is the updated content of the blog post.
", "metaDescription": "An updated description for the blog post", "tagIds": [ 1234, 5678 ], "featuredImage": "https://example.com/updated-featured-image.jpg", "publishDate": "2023-06-15T10:00:00Z", "published": true, "url": "https://example.com/blog/updated-blog-post-title", "createdAt": "2023-06-01T09:00:00Z", "updatedAt": "2023-06-15T10:00:00Z" } ``` ### Update call engagement Update a call by ID. **Sample Input** **Sample Output** ### Update contact Update contact by ID. **Sample Input** **Sample Output** ### Update deal Update a deal by the given ID. **Sample Input** **Sample Output** ### Update marketing event (beta) Update an existing marketing event in HubSpot. **Sample Input** **Sample Output** ### Update object schema Update the details for an existing object schema. **Sample Input** **Sample Output** ### Update product Update a product by the given ID. **Sample Input** **Sample Output** ### Update task engagement Update a task by ID. **Sample Input** **Sample Output** ### Upload file from URL Asynchronously import a file at a given URL into the file manager. **Sample Input** **Sample Output** ## DDL operations ### List association definitions (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List associations (DDL) **Sample Input** **Sample Output** ### List blog posts (DDL) **Sample Input** **Sample Output** ### List call engagement dispositions (DDL) **Sample Input** **Sample Output** ```json { "results": [ { "label": "Completed", "value": "COMPLETED" }, { "label": "No answer", "value": "NO_ANSWER" }, { "label": "Busy", "value": "BUSY" }, { "label": "Left voicemail", "value": "LEFT_VOICEMAIL" }, { "label": "Wrong number", "value": "WRONG_NUMBER" } ] } ``` ### List call engagement properties (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** ```json {} ``` **Sample Output** ### List call engagements (DDL) **Sample Input** **Sample Output** ### List comments (DDL) **Sample Input** ```json {} ``` **Sample Output** ```json { "results": [ { "id": "123456", "hs_timestamp": "2023-05-15T10:30:00Z", "hs_created_by": "user@example.com", "hs_object_id": "789012", "hs_association_source_type": "DEAL", "comment": "Called the client to discuss the proposal. They seem interested and requested a follow-up meeting next week.", "hs_attachment_ids": [ "attachment1", "attachment2" ] }, { "id": "234567", "hs_timestamp": "2023-05-14T15:45:00Z", "hs_created_by": "anotheruser@example.com", "hs_object_id": "345678", "hs_association_source_type": "CONTACT", "comment": "Updated contact information. New phone number: +1 (555) 123-4567", "hs_attachment_ids": [] } ], "paging": { "next": { "after": "234567", "link": "https://api.hubapi.com/crm/v3/objects/comments?after=234567" } } } ``` ### List companies (DDL) **Sample Input** ```json {} ``` **Sample Output** ```json { "companies": [ { "id": "1234567", "name": "Acme Corporation", "domain": "acme.com" }, { "id": "2345678", "name": "Global Innovations Inc.", "domain": "globalinnovations.com" }, { "id": "3456789", "name": "Tech Solutions Ltd.", "domain": "techsolutions.com" } ] } ``` ### List company properties (DDL) **Sample Input** ```json {} ``` **Sample Output** ### List contact lists (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List contact properties (DDL) **Sample Input** **Sample Output** ### List contacts (DDL) **Sample Input** **Sample Output** ```json [ { "value": "1", "label": "John Doe" }, { "value": "2", "label": "Jane Smith" }, { "value": "3", "label": "Mike Johnson" }, { "value": "4", "label": "Emily Brown" }, { "value": "5", "label": "David Wilson" } ] ``` ### List crm object types (DDL) **Sample Input** **Sample Output** ```json { "options": [ { "value": "contacts", "label": "Contacts" }, { "value": "companies", "label": "Companies" }, { "value": "deals", "label": "Deals" }, { "value": "tickets", "label": "Tickets" }, { "value": "products", "label": "Products" }, { "value": "line_items", "label": "Line Items" }, { "value": "quotes", "label": "Quotes" }, { "value": "custom_object_1", "label": "Custom Object 1" }, { "value": "custom_object_2", "label": "Custom Object 2" } ] } ``` ### List deals (DDL) **Sample Input** **Sample Output** ### List folder IDs (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List folder paths (DDL) **Sample Input** **Sample Output** ### List line items (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List meeting engagement properties (DDL) **Sample Input** **Sample Output** ### List owner IDs (DDL) **Sample Input** ```json {} ``` **Sample Output** ### List property groups (DDL) **Sample Input** **Sample Output** ```json { "options": [ { "label": "Contact Information", "value": "contactinformation" }, { "label": "Social Media Information", "value": "socialmedia" }, { "label": "Lead Information", "value": "leadinformation" }, { "label": "Analytics Information", "value": "analyticsinformation" }, { "label": "Sales Information", "value": "salesinformation" } ] } ``` ### List task engagement properties (DDL) **Sample Input** ```json {} ``` **Sample Output** ### List task engagements (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ### List ticket pipelines (DDL) > **Warning:** Note that DDL operations can only be called directly by Connectors API, or when using CustomJS in the Embedded solution editor for e.g. DDL-dependent data mapping **Sample Input** **Sample Output** ```json { "results": [ { "id": "default", "label": "Support Pipeline", "active": true, "displayOrder": 0, "stages": [ { "id": "1", "label": "New", "displayOrder": 0 }, { "id": "2", "label": "In Progress", "displayOrder": 1 }, { "id": "3", "label": "Waiting on Customer", "displayOrder": 2 }, { "id": "4", "label": "Resolved", "displayOrder": 3 } ] }, { "id": "custom_pipeline_1", "label": "IT Help Desk", "active": true, "displayOrder": 1, "stages": [ { "id": "5", "label": "Submitted", "displayOrder": 0 }, { "id": "6", "label": "Triaged", "displayOrder": 1 }, { "id": "7", "label": "In Progress", "displayOrder": 2 }, { "id": "8", "label": "Resolved", "displayOrder": 3 } ] } ] } ```