{"openapi":"3.0.0","info":{"description":"CRM and marketing platform","version":[{"name":"v1","value":"v1"},{"name":"v2","value":"v2"},{"name":"v3","value":"v3"},{"name":"v4","value":"v4"}]},"servers":[{"description":"CRM and marketing platform","url":"https://api.apirails.com/hubspot"}],"paths":{"/automation/v4/flows/{flowId}":{"get":{"tags":["Automation Create And Manage Workflows Flows"],"parameters":[{"name":"flowId","in":"query","description":"The flowId of the flow to fetch","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/create-manage-workflows#get-%2Fautomation%2Fv4%2Fflows%2F%7Bflowid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/flows/{flowId}"},"summary":"Fetch all details for a single flow","description":"Fetch all details for a single flow","security":[{"bearerAuth":[]}]},"delete":{"tags":["Automation Create And Manage Workflows Flows"],"parameters":[{"name":"flowId","in":"path","description":"The flowId of the flow to fetch","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/create-manage-workflows#delete-%2Fautomation%2Fv4%2Fflows%2F%7Bflowid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/flows/{flowId}"},"summary":"Delete a single flow","description":"Delete a single flow","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/automation/v4/flows":{"get":{"tags":["Automation Create And Manage Workflows Flows"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/create-manage-workflows#get-%2Fautomation%2Fv4%2Fflows","api_endpoint":"https://api.hubapi.com/automation/v4/flows"},"summary":"Fetch the list of all flows in a portal","description":"Fetch the list of all flows in a portal","security":[{"bearerAuth":[]}]},"post":{"tags":["Automation Create And Manage Workflows Flows"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/create-manage-workflows#post-%2Fautomation%2Fv4%2Fflows","api_endpoint":"https://api.hubapi.com/automation/v4/flows"},"summary":"Create a new flow","description":"Create a new flow","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"enum","description":"Type","required":true,"enum":["CONTACT_FLOW","PLATFORM_FLOW"]},"actions":{"type":"array","description":"Action","items":{"type":"string"}},"blockedDates":{"type":"array","description":"Blocked Dates","items":{"type":"string"}},"canEnrollFromSalesforce":{"type":"boolean","description":"Can Enroll From Salesforce","required":true,"enum":[true,false]},"customProperties":{"type":"object","description":"Custom Properties","properties":{}},"description":{"type":"string","description":"Description"},"enrollmentCriteria":{"type":"object","description":"Enrollment Criteria","properties":{}},"enrollmentSchedule":{"type":"object","description":"Enrollment Schedule","properties":{}},"eventAnchor":{"type":"object","description":"Event Anchor","properties":{}},"flowType":{"type":"enum","description":"Flow Type","required":true,"enum":["UNKNOWN","ACTION_SET","WORKFLOW"]},"goalFilterBranch":{"type":"object","description":"Goal Filter Branch","properties":{}},"isEnabled":{"type":"boolean","description":"Is Enabled","required":true,"enum":[true,false]},"name":{"type":"string","description":"Name"},"objectTypeId":{"type":"string","description":"Object Type Id","required":true},"startActionId":{"type":"string","description":"Srart Action ID"},"suppressionListIds":{"type":"array","description":"Suppression ListIds","items":{"type":"string"}},"timeWindows":{"type":"array","description":"Time Windows","items":{"type":"string"}},"unEnrollmentSetting":{"type":"object","description":"Un-Enrollment Setting","properties":{}},"uuid":{"type":"string","description":"User ID"}}},"example":{"type":"","actions":[],"blockedDates":[],"canEnrollFromSalesforce":"","customProperties":{},"description":"","enrollmentCriteria":{},"enrollmentSchedule":{},"eventAnchor":{},"flowType":"","goalFilterBranch":{},"isEnabled":"","name":"","objectTypeId":"","startActionId":"","suppressionListIds":[],"timeWindows":[],"unEnrollmentSetting":{},"uuid":""}}}}}},"/events/v3/send/batch":{"post":{"tags":["Analytics And Events Custom Events Custom Event Completions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-completions#post-%2Fevents%2Fv3%2Fsend%2Fbatch","api_endpoint":"https://api.hubapi.com/events/v3/send/batch"},"summary":"Behavioral Events Tracking","description":"Behavioral Events Tracking","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Add Parameters in this filds","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/events/v3/send":{"post":{"tags":["Analytics And Events Custom Events Custom Event Completions"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-completions#post-%2Fevents%2Fv3%2Fsend","api_endpoint":"https://api.hubapi.com/events/v3/send"},"summary":"Send custom event completion","description":"Send custom event completion","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"Email of visitor"},"eventName":{"type":"string","description":"Internal name of the event-type to trigger","required":true},"objectId":{"type":"string","description":"The object id that this event occurred on. Could be a contact id or a visitor id"},"occurredAt":{"type":"string","description":"The time when this event occurred (if any). If this isn't set, the current time will be used"},"properties":{"type":"object","description":"Map of properties for the event in the format property internal name - property value","properties":{}},"utk":{"type":"string","description":"User token"},"uuid":{"type":"string","description":"User ID"}}},"example":{"email":"","eventName":"","objectId":"","occurredAt":"","properties":{},"utk":"","uuid":""}}}}}},"/events/v3/event-definitions/{eventName}":{"get":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[{"name":"eventName","in":"path","description":"The internal name of the custom event","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#get-%2Fevents%2Fv3%2Fevent-definitions%2F%7Beventname%7D","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions/{eventName}"},"summary":"Fetch a specific custom event definition","description":"Fetch a specific custom event definition","security":[{"bearerAuth":[]}]},"patch":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[{"name":"eventName","in":"path","description":"The internal name of the custom event","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#patch-%2Fevents%2Fv3%2Fevent-definitions%2F%7Beventname%7D","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions/{eventName}"},"summary":"Update a custom event definition","description":"Update a custom event definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the event that will be shown as help text in HubSpot"},"label":{"type":"string","description":"Human readable label for the event. Used in HubSpot UI"}}},"example":{"description":"","label":""}}}}},"delete":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[{"name":"eventName","in":"path","description":"The internal name of the custom event","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#delete-%2Fevents%2Fv3%2Fevent-definitions%2F%7Beventname%7D","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions/{eventName}"},"summary":"Delete a custom event definition","description":"Delete a custom event definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/events/v3/event-definitions":{"get":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"includeProperties","in":"query","description":"Include Properties","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"limit","in":"query","description":"The maximum number of results to display per page.","schema":{"type":"number","example":""}},{"name":"searchString","in":"query","description":"Characters in the event name that the user is searching for. This search is a naive “contains” search, no fuzzy matching is done.","schema":{"type":"string","example":""}},{"name":"sortOrder","in":"query","description":"Short Order","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#get-%2Fevents%2Fv3%2Fevent-definitions","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions"},"summary":"Query custom event definitions","description":"Query custom event definitions","security":[{"bearerAuth":[]}]},"post":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#post-%2Fevents%2Fv3%2Fevent-definitions","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions"},"summary":"Create custom event definition ","description":"Create custom event definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the event that will be shown as help text in HubSpot"},"label":{"type":"string","description":"Human readable label for the event. Used in HubSpot UI","required":true},"name":{"type":"string","description":"Internal event name, which must be used when referencing the event from the API"},"primaryObject":{"type":"enum","description":"The object type to associate this event to. Can be one of CONTACT, COMPANY, DEAL, TICKET. If no primaryObject is supplied, we will default to associating the event to CONTACT objects"},"propertyDefinitions":{"type":"array","description":"List of custom properties on event","required":true,"items":{"type":"string"}}}},"example":{"description":"","label":"","name":"","primaryObject":"","propertyDefinitions":[]}}}}}},"/events/v3/event-definitions/{eventName}/property":{"post":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[{"name":"eventName","in":"path","description":"The internal name of the custom event","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#post-%2Fevents%2Fv3%2Fevent-definitions%2F%7Beventname%7D%2Fproperty","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions/{eventName}/property"},"summary":"Create a new property for a custom event definition","description":"Create a new property for a custom event definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"enum","description":"The data type of the property. Can be one of the following: [string, number, enumeration, datetime]","required":true,"enum":["string","number","enumeration","datetime"]},"description":{"type":"string","description":"A description of the property that will be shown as help text in HubSpot"},"label":{"type":"string","description":"Human readable label for the property. Used in HubSpot UI","required":true},"name":{"type":"string","description":"Internal property name, which must be used when referencing the property from the API"},"options":{"type":"array","description":"A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties","required":true,"items":{"type":"string"}}}},"example":{"type":"","description":"","label":"","name":"","options":[]}}}}}},"/events/v3/event-definitions/{eventName}/property/{propertyName}":{"patch":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[{"name":"eventName","in":"path","description":"The internal name of the custom event","required":true,"schema":{"type":"string","example":""}},{"name":"propertyName","in":"path","description":"The internal name of the property to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#patch-%2Fevents%2Fv3%2Fevent-definitions%2F%7Beventname%7D%2Fproperty%2F%7Bpropertyname%7D","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions/{eventName}/property/{propertyName}"},"summary":"Update an existing custom event property","description":"Update an existing custom event property","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"A description of the event that will be shown as help text in HubSpot"},"label":{"type":"string","description":"Human readable label for the event. Used in HubSpot UI"},"options":{"type":"array","description":"A list of available options for the property if it is an enumeration. NOTE: This field is only applicable for enumerated properties","items":{"type":"string"}}}},"example":{"description":"","label":"","options":[]}}}}},"delete":{"tags":["Analytics And Events Custom Events Custom Event Definitions Event Definition"],"parameters":[{"name":"eventName","in":"path","description":"The internal name of the custom event","required":true,"schema":{"type":"string","example":""}},{"name":"propertyName","in":"path","description":"The internal name of the property to update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/custom-events/custom-event-definitions#delete-%2Fevents%2Fv3%2Fevent-definitions%2F%7Beventname%7D%2Fproperty%2F%7Bpropertyname%7D","api_endpoint":"https://api.hubapi.com/events/v3/event-definitions/{eventName}/property/{propertyName}"},"summary":"Delete a property from a custom event definition","description":"Delete a property from a custom event definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/email/public/v1/campaigns/by-id":{"get":{"tags":["Analytics And Events Email Analytics"],"parameters":[{"name":"limit","in":"query","description":"Limit the maximum number of results you would like returned","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"A key representing which page of results you would like","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/email-analytics#get-all-campaign-ids-for-a-portal","api_endpoint":"https://api.hubapi.com/email/public/v1/campaigns/by-id"},"summary":"Get all campaign IDs for a portal","description":"Get all campaign IDs for a portal","security":[{"bearerAuth":[]}]}},"/email/public/v1/campaigns":{"get":{"tags":["Analytics And Events Email Analytics"],"parameters":[{"name":"limit","in":"query","description":"Limit the maximum number of results you would like returned","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"A key representing which page of results you would like","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/email-analytics#get-campaign-ids-with-recent-activity-for-a-portal","api_endpoint":"https://api.hubapi.com/email/public/v1/campaigns"},"summary":"Get campaign IDs with recent activity for a portal","description":"Get campaign IDs with recent activity for a portal","security":[{"bearerAuth":[]}]}},"/email/public/v1/campaigns/:campaign_id":{"get":{"tags":["Analytics And Events Email Analytics"],"parameters":[{"name":"campaign_id","in":"path","description":"The Internal HubSpot ID of the email that you want to get the details for. Consult the section above this table to learn how to locate this ID.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/email-analytics#get-campaign-data-for-a-given-campaign","api_endpoint":"https://api.hubapi.com/email/public/v1/campaigns/:campaign_id"},"summary":"Get campaign data for a given campaign","description":"Get campaign data for a given campaign","security":[{"bearerAuth":[]}]}},"/email/public/v1/events":{"get":{"tags":["Analytics And Events Email Analytics"],"parameters":[{"name":"appId","in":"query","description":"Only return events which correspond to the given HubSpot Application ID","schema":{"type":"string","example":""}},{"name":"campaignId","in":"query","description":"Only return events from the given HubSpot Campaign ID","schema":{"type":"string","example":""}},{"name":"endTimestamp","in":"query","description":"Only return events which occurred at or before the given timestamp (in milliseconds since epoch)","schema":{"type":"string","example":""}},{"name":"eventType","in":"query","description":"Only return events of the specified type (case-sensitive)","schema":{"type":"string","example":""}},{"name":"excludeFilteredEvents","in":"query","description":"Only return events that have not been filtered out due to customer filtering settings. The default value is false","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of events to return. If omitted, the default value of 10 is used. The maximum allowed value is 1000","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"A key representing which page of results you would like","schema":{"type":"string","example":""}},{"name":"recipient","in":"query","description":"Only return events related to the given recipient","schema":{"type":"string","example":""}},{"name":"startTimestamp","in":"query","description":"Only return events which occurred at or after the given timestamp (in milliseconds since epoch)","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/email-analytics#get-email-events","api_endpoint":"https://api.hubapi.com/email/public/v1/events"},"summary":"Get email events","description":"Get email events","security":[{"bearerAuth":[]}]}},"/email/public/v1/events/:created/:id":{"get":{"tags":["Analytics And Events Email Analytics"],"parameters":[{"name":"created","in":"path","description":"The creation timestamp (in milliseconds since epoch) of the event to return","required":true,"schema":{"type":"string","example":""}},{"name":"id","in":"path","description":"The unique ID of the event to return","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/email-analytics#get-email-event-by-id","api_endpoint":"https://api.hubapi.com/email/public/v1/events/:created/:id"},"summary":"Get Email Event By ID","description":"Get Email Event By ID","security":[{"bearerAuth":[]}]}},"/events/v3/events/":{"get":{"tags":["Analytics And Events Event Analytics Events"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"Before","schema":{"type":"string","example":""}},{"name":"eventType","in":"query","description":"The event type name. A list of available event type names can be obtained from another API call","schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"ID of an event instance.","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"objectId","in":"query","description":"The ID of the CRM Object to filter event instances on. If filtering on objectId, you must also provide an objectType","schema":{"type":"number","example":""}},{"name":"objectType","in":"query","description":"The CRM Object type name to filter event instances on. Optionally, you can also provide an objectId in another param to filter to a specific CRM Object instance.","schema":{"type":"string","example":""}},{"name":"occurredAfter","in":"query","description":"Occurred After","schema":{"type":"object","example":""}},{"name":"occurredBefore","in":"query","description":"Occurred Before","schema":{"type":"object","example":""}},{"name":"sort","in":"query","description":"Sort direction based on the timestamp of the event instance, ASCENDING or DESCENDING.","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/event-analytics#get-%2Fevents%2Fv3%2Fevents%2F","api_endpoint":"https://api.hubapi.com/events/v3/events/"},"summary":"Event Instance Query","description":"Event Instance Query","security":[{"bearerAuth":[]}]}},"/events/v3/events/event-types":{"get":{"tags":["Analytics And Events Event Analytics Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/event-analytics#get-%2Fevents%2Fv3%2Fevents%2Fevent-types","api_endpoint":"https://api.hubapi.com/events/v3/events/event-types"},"summary":"Event Types","description":"Event Types","security":[{"bearerAuth":[]}]}},"/analytics/v2/reports/:breakdown_by/:time_period":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"breakdown_by","in":"path","description":"The category used to break down the analytics data","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["totals","sessions","sources","geolocation","utm-:utm_type"]}}},{"name":"time_period","in":"path","description":"The time period used to group the data","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["total","daily","weekly","monthly","summarize/daily","summarize/weekly","summarize/monthly"]}}},{"name":"d1","in":"query","description":"Used to drilldown into the data","schema":{"type":"string","example":""}},{"name":"d2","in":"query","description":"Used to further drill down into the data","schema":{"type":"string","example":""}},{"name":"e","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date for the data you want","schema":{"type":"string","example":""}},{"name":"f","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"filterId","in":"query","description":"The ID of an Analytics view","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Used to limit the number of results per request","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Used to get the next page of results if there are more results than the number specified in the limit parameter (or 350 if limit is not included)","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"If included, the results are sorted by the specified field","schema":{"type":"string","example":""}},{"name":"sortDir","in":"query","description":"If a &sort= value is included in the request, this parameter will control the direction of sorted results","schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The start date for the data you want","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-analytics-data-breakdowns","api_endpoint":"https://api.hubapi.com/analytics/v2/reports/:breakdown_by/:time_period"},"summary":"Get analytics data breakdowns","description":"Get analytics data breakdowns","security":[{"bearerAuth":[]}]}},"/analytics/v2/reports/:object_type/:time_period":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"object_type","in":"path","description":"The type of object that you want the analytics data for","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["event-completions","forms","pages","social-assists"]}}},{"name":"time_period","in":"path","description":"The time period used to group the data","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["total","daily","weekly","monthly","summarize/daily","summarize/weekly","summarize/monthly"]}}},{"name":"d1","in":"query","description":"Used to drilldown into the data","schema":{"type":"string","example":""}},{"name":"d2","in":"query","description":"Used to further drill down into the data","schema":{"type":"string","example":""}},{"name":"e","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date for the data you want","schema":{"type":"string","example":""}},{"name":"f","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"filterId","in":"query","description":"The ID of an Analytics view","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Used to limit the number of results per request","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Used to get the next page of results if there are more results than the number specified in the limit parameter (or 350 if limit is not included)","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"If included, the results are sorted by the specified field","schema":{"type":"string","example":""}},{"name":"sortDir","in":"query","description":"If a &sort= value is included in the request, this parameter will control the direction of sorted results","schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The start date for the data you want","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-analytics-data-for-specific-objects","api_endpoint":"https://api.hubapi.com/analytics/v2/reports/:object_type/:time_period"},"summary":"Get analytics data for specific objects","description":"Get analytics data for specific objects","security":[{"bearerAuth":[]}]}},"/analytics/v2/reports/:content_type/:time_period":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"content_type","in":"path","description":"The type of content that you want to get data for","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["landing-pages","standard-pages","blog-posts","listing-pages","knowledge-articles"]}}},{"name":"time_period","in":"path","description":"The time period used to group the data","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["total","daily","weekly","monthly","summarize/daily","summarize/weekly","summarize/monthly"]}}},{"name":"d1","in":"query","description":"Used to drilldown into the data","schema":{"type":"string","example":""}},{"name":"d2","in":"query","description":"Used to further drill down into the data","schema":{"type":"string","example":""}},{"name":"e","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date for the data you want","schema":{"type":"string","example":""}},{"name":"f","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"filterId","in":"query","description":"The ID of an Analytics view","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Used to limit the number of results per request","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Used to get the next page of results if there are more results than the number specified in the limit parameter (or 350 if limit is not included)","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"If included, the results are sorted by the specified field","schema":{"type":"string","example":""}},{"name":"sortDir","in":"query","description":"If a &sort= value is included in the request, this parameter will control the direction of sorted results","schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The start date for the data you want","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-data-for-hubspot-hosted-content","api_endpoint":"https://api.hubapi.com/analytics/v2/reports/:content_type/:time_period"},"summary":"Get data for HubSpot hosted content","description":"Get data for HubSpot hosted content","security":[{"bearerAuth":[]}]}},"/analytics/v2/reports/:content_type/:page_id/sources/:time_period":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"content_type","in":"path","description":"The type of content that you want to get data for","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["landing-pages","standard-pages","blog-posts","listing-pages","knowledge-articles"]}}},{"name":"page_id","in":"path","description":"A page ID can be included the URL to get sources data for a specific page. See the examples for details","required":true,"schema":{"type":"string","example":""}},{"name":"time_period","in":"path","description":"The time period used to group the data","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["total","daily","weekly","monthly","summarize/daily","summarize/weekly","summarize/monthly"]}}},{"name":"d1","in":"query","description":"Used to drilldown into the data","schema":{"type":"string","example":""}},{"name":"d2","in":"query","description":"Used to further drill down into the data","schema":{"type":"string","example":""}},{"name":"e","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date for the data you want","schema":{"type":"string","example":""}},{"name":"f","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"filterId","in":"query","description":"The ID of an Analytics view","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Used to limit the number of results per request","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Used to get the next page of results if there are more results than the number specified in the limit parameter (or 350 if limit is not included)","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"If included, the results are sorted by the specified field","schema":{"type":"string","example":""}},{"name":"sortDir","in":"query","description":"If a &sort= value is included in the request, this parameter will control the direction of sorted results","schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The start date for the data you want","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-data-for-hubspot-hosted-content","api_endpoint":"https://api.hubapi.com/analytics/v2/reports/:content_type/:page_id/sources/:time_period"},"summary":"Get data for HubSpot hosted Pages ","description":"Get data for HubSpot hosted Pages","security":[{"bearerAuth":[]}]}},"/analytics/v2/reports/:content_type/content-group/:blog_id/sources/:time_period":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"blog_id","in":"path","description":"A blog ID can be specified to get data for all content related to a specific blog","required":true,"schema":{"type":"string","example":""}},{"name":"content_type","in":"path","description":"The type of content that you want to get data for","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["landing-pages","standard-pages","blog-posts","listing-pages","knowledge-articles"]}}},{"name":"time_period","in":"path","description":"The time period used to group the data","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["total","daily","weekly","monthly","summarize/daily","summarize/weekly","summarize/monthly"]}}},{"name":"d1","in":"query","description":"Used to drilldown into the data","schema":{"type":"string","example":""}},{"name":"d2","in":"query","description":"Used to further drill down into the data","schema":{"type":"string","example":""}},{"name":"e","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"end","in":"query","description":"The end date for the data you want","schema":{"type":"string","example":""}},{"name":"f","in":"query","description":"May be included multiple times","schema":{"type":"string","example":""}},{"name":"filterId","in":"query","description":"The ID of an Analytics view","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Used to limit the number of results per request","schema":{"type":"string","example":""}},{"name":"offset","in":"query","description":"Used to get the next page of results if there are more results than the number specified in the limit parameter (or 350 if limit is not included)","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"If included, the results are sorted by the specified field","schema":{"type":"string","example":""}},{"name":"sortDir","in":"query","description":"If a &sort= value is included in the request, this parameter will control the direction of sorted results","schema":{"type":"string","example":""}},{"name":"start","in":"query","description":"The start date for the data you want","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-data-for-hubspot-hosted-content","api_endpoint":"https://api.hubapi.com/analytics/v2/reports/:content_type/content-group/:blog_id/sources/:time_period"},"summary":"Get data for HubSpot hosted Blogs","description":"Get data for HubSpot hosted Blogs","security":[{"bearerAuth":[]}]}},"/analytics/v2/reports/:objectType/exists":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"objectType","in":"path","description":"The object type that you want to check for analytics data","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#check-for-the-existence-of-analytics-data-for-an-object-type","api_endpoint":"https://api.hubapi.com/analytics/v2/reports/:objectType/exists"},"summary":"Check for the existence of analytics data for an object type","description":"Check for the existence of analytics data for an object type","security":[{"bearerAuth":[]}]}},"/reports/v2/events/:id":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"id","in":"path","description":"The ID of the specific event you're looking to pull","required":true,"schema":{"type":"string","example":""}},{"name":"includeDeletes","in":"query","description":"If specified as true, will return a deleted event","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-event-by-id","api_endpoint":"https://api.hubapi.com/reports/v2/events/:id"},"summary":"Get Event by ID","description":"Get Event by ID","security":[{"bearerAuth":[]}]}},"/reports/v2/events":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"includeDeletes","in":"query","description":"If specified as true, will return a deleted event","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-events","api_endpoint":"https://api.hubapi.com/reports/v2/events"},"summary":"Get events","description":"Get events","security":[{"bearerAuth":[]}]}},"/reports/v2/events/batch":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[{"name":"id","in":"query","description":"The ID of an event","required":true,"schema":{"type":"string","example":""}},{"name":"includeDeletes","in":"query","description":"If specified as true, will return a deleted event","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-a-group-of-events-by-id","api_endpoint":"https://api.hubapi.com/reports/v2/events/batch"},"summary":"Get a Group of Events by ID","description":"Get a Group of Events by ID","security":[{"bearerAuth":[]}]}},"/analytics/v2/views":{"get":{"tags":["Analytics And Events Reporting"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/analytics-and-events/reporting#get-all-analytics-views","api_endpoint":"https://api.hubapi.com/analytics/v2/views"},"summary":"Get all analytics views","description":"Get all analytics views","security":[{"bearerAuth":[]}]}},"/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}":{"get":{"tags":["App Management Feature Flags App Flags"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"sting","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#delete-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D%2Fportals%2F%7Bportalid%7D","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}"},"summary":"Delete an account's App Card Release flag state","description":"Delete an account's App Card Release flag state","security":[{"bearerAuth":[]}]},"put":{"tags":["App Management Feature Flags Portal Flag States"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"string","example":""}},{"name":"portalId","in":"path","description":"The ID of the account that installed the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#put-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D%2Fportals%2F%7Bportalid%7D","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}"},"summary":"Update an account's App Card Release flag state","description":"Update an account's App Card Release flag state","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"flagState":{"type":"enum","description":"The ID of the account that installed the app","required":true,"enum":["OFF","ON","ABSENT"]}}},"example":{"flagState":""}}}}},"delete":{"tags":["App Management Feature Flags Portal Flag States"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"string","example":""}},{"name":"portalId","in":"path","description":"The ID of the account that installed the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#delete-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D%2Fportals%2F%7Bportalid%7D","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}/portals/{portalId}"},"summary":"Delete an account's App Card Release flag state","description":"Delete an account's App Card Release flag state","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/delete":{"post":{"tags":["App Management Feature Flags Portal Flag States"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#post-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D%2Fportals%2Fbatch%2Fdelete","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/delete"},"summary":"Batch delete account-level App Card Release flag state","description":"Batch delete account-level App Card Release flag state","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"portalId":{"type":"array","description":"The ID of the account that installed the app","required":true,"items":{"type":"string"}}}},"example":{"portalId":[]}}}}}},"/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/upsert":{"post":{"tags":["App Management Feature Flags Portal Flag States"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#post-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D%2Fportals%2Fbatch%2Fupsert","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}/portals/batch/upsert"},"summary":"Batch set account App Card Release flag state","description":"Batch set account App Card Release flag state","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"portalId":{"type":"array","description":"The ID of the account that installed the app","required":true,"items":{"type":"string"}}}},"example":{"portalId":[]}}}}}},"/feature-flags/v3/{appId}/flags/{flagName}/portals":{"get":{"tags":["App Management Feature Flags App Flags"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return in a single request","required":true,"schema":{"type":"number","example":""}},{"name":"startPortalId","in":"query","description":"The initial account ID for listing, enabling pagination","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#get-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D%2Fportals","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}/portals"},"summary":"Get account Portal Flag State for the App Card Release flag","description":"Get account Portal Flag State for the App Card Release flag","security":[{"bearerAuth":[]}]}},"/feature-flags/v3/{appId}/flags/{flagName}":{"put":{"tags":["App Management Feature Flags App Flags"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"sting","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#put-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}"},"summary":"Update your app's App Card Release feature flag","description":"Update your app's App Card Release feature flag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"defaultState":{"type":"enum","description":"Default State","required":true,"enum":["OFF","ON","ABSENT"]},"overrideState":{"type":"enum","description":"Override State","enum":["OFF","ON","ABSENT"]}}},"example":{"defaultState":"","overrideState":""}}}}},"get":{"tags":["App Management Feature Flags App Flags"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"flagName","in":"path","description":"hs-release-app-cards","required":true,"schema":{"type":"sting","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/feature-flags#get-%2Ffeature-flags%2Fv3%2F%7Bappid%7D%2Fflags%2F%7Bflagname%7D","api_endpoint":"https://api.hubapi.com/feature-flags/v3/{appId}/flags/{flagName}"},"summary":"Get your app's App Card Release feature flag","description":"Get your app's App Card Release feature flag","security":[{"bearerAuth":[]}]}},"/oauth/v3/access-tokens/:token":{"get":{"tags":["App Management OAuth"],"parameters":[{"name":"token","in":"path","description":"The access token that you want to get the information for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/oauth#get-information-for-oauth-2.0-access-token","api_endpoint":"https://api.hubapi.com/oauth/v3/access-tokens/:token"},"summary":"Get Information for OAuth 2.0 Access Token","description":"Get Information for OAuth 2.0 Access Token","security":[{"bearerAuth":[]}]}},"/oauth/v3/refresh-tokens/:token":{"get":{"tags":["App Management OAuth"],"parameters":[{"name":"token","in":"path","description":"The refresh token that you want to get the information for","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/oauth#get-information-for-oauth-2.0-refresh-token","api_endpoint":"https://api.hubapi.com/oauth/v3/refresh-tokens/:token"},"summary":"Get Information for OAuth 2.0 Refresh Token","description":"Get Information for OAuth 2.0 Refresh Token","security":[{"bearerAuth":[]}]},"delete":{"tags":["App Management OAuth"],"parameters":[{"name":"token","in":"path","description":"The refresh token that you want to get the information for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/oauth#refresh-oauth-2.0-access-token","api_endpoint":"https://api.hubapi.com/oauth/v3/refresh-tokens/:token"},"summary":"Delete OAuth 2.0 Refresh Token","description":"Delete OAuth 2.0 Refresh Token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_id":{"type":"string","description":"The Client ID of your app","required":true},"client_secret":{"type":"string","description":"The Client Secret of your app","required":true},"grant_type":{"type":"string","description":"The grant type of the request, must be refresh_token when refreshing an access token","required":true},"refresh_token":{"type":"string","description":"The refresh token obtained when initially authenticating your OAuth integration","required":true}}},"example":{"client_id":"","client_secret":"","grant_type":"","refresh_token":""}}}}}},"/oauth/v3/token":{"post":{"tags":["App Management OAuth"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/oauth#refresh-oauth-2.0-access-token","api_endpoint":"https://api.hubapi.com/oauth/v3/token"},"summary":"Refresh OAuth 2.0 access token","description":"Refresh OAuth 2.0 access token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"client_id":{"type":"string","description":"The Client ID of your app","required":true},"client_secret":{"type":"string","description":"The Client Secret of your app","required":true},"grant_type":{"type":"string","description":"The grant type of the request, must be refresh_token when refreshing an access token","required":true},"refresh_token":{"type":"string","description":"The refresh token obtained when initially authenticating your OAuth integration","required":true}}},"example":{"client_id":"","client_secret":"","grant_type":"","refresh_token":""}}}}}},"/webhooks/v3/{appId}/settings":{"get":{"tags":["App Management Webhooks Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#get-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsettings","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/settings"},"summary":"Read webhook settings","description":"Read webhook settings","security":[{"bearerAuth":[]}]},"put":{"tags":["App Management Webhooks Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#put-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsettings","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/settings"},"summary":"Update webhook settings","description":"Update webhook settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"targetUrl":{"type":"string","description":"A publicly available URL for HubSpot to call where event payloads will be delivered","required":true},"throttling":{"type":"object","description":"Configuration details for webhook throttling","required":true,"properties":{}}}},"example":{"targetUrl":"","throttling":{}}}}}},"delete":{"tags":["App Management Webhooks Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#delete-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsettings","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/settings"},"summary":"Delete webhook settings","description":"Delete webhook settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/webhooks/v3/{appId}/subscriptions/{subscriptionId}":{"get":{"tags":["App Management Webhooks Subscription"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"subscriptionId","in":"path","description":"The ID of the event subscription.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#get-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsubscriptions%2F%7Bsubscriptionid%7D","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/subscriptions/{subscriptionId}"},"summary":"Read an event subscription","description":"Read an event subscription","security":[{"bearerAuth":[]}]},"put":{"tags":["App Management Webhooks Subscription"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"subscriptionId","in":"path","description":"The ID of the event subscription.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#patch-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsubscriptions%2F%7Bsubscriptionid%7D","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/subscriptions/{subscriptionId}"},"summary":"Update an event subscription","description":"Update an event subscription","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Determines if the subscription is active or paused","enum":[true,false]}}},"example":{"active":""}}}}},"delete":{"tags":["App Management Webhooks Subscription"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"subscriptionId","in":"path","description":"The ID of the event subscription.","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#delete-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsubscriptions%2F%7Bsubscriptionid%7D","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/subscriptions/{subscriptionId}"},"summary":"Delete event subscription","description":"Delete event subscription","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/webhooks/v3/{appId}/subscriptions":{"get":{"tags":["App Management Webhooks Subscription"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#get-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsubscriptions","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/subscriptions"},"summary":"Read event subscriptions","description":"Read event subscriptions","security":[{"bearerAuth":[]}]},"post":{"tags":["App Management Webhooks Subscription"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#post-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsubscriptions","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/subscriptions"},"summary":"Create an event subscription","description":"Create an event subscription","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"active":{"type":"boolean","description":"Determines if the subscription is active or paused","enum":[true,false]},"eventType":{"type":"string","description":"Type of event to listen for","required":true},"objectTypeId":{"type":"string","description":"Inputs"},"propertyName":{"type":"string","description":"The internal name of the property to monitor for changes"}}},"example":{"active":"","eventType":"","objectTypeId":"","propertyName":""}}}}}},"/webhooks/v3/{appId}/subscriptions/batch/update":{"post":{"tags":["App Management Webhooks Subscription"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/app-management/webhooks#post-%2Fwebhooks%2Fv3%2F%7Bappid%7D%2Fsubscriptions%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/webhooks/v3/{appId}/subscriptions/batch/update"},"summary":"Batch create event subscriptions","description":"Batch create event subscriptions","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputs","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/automation/v4/actions/callbacks/complete":{"post":{"tags":["Automation Custom Workflow Actions Callbacks"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#post-%2Fautomation%2Fv4%2Factions%2Fcallbacks%2Fcomplete","api_endpoint":"https://api.hubapi.com/automation/v4/actions/callbacks/complete"},"summary":"Completes a batch of callbacks","description":"Completes a batch of callbacks","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputs","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/automation/v4/actions/callbacks/{callbackId}/complete":{"post":{"tags":["Automation Custom Workflow Actions Callbacks"],"parameters":[{"name":"callbackId","in":"path","description":"Callback Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#post-%2Fautomation%2Fv4%2Factions%2Fcallbacks%2F%7Bcallbackid%7D%2Fcomplete","api_endpoint":"https://api.hubapi.com/automation/v4/actions/callbacks/{callbackId}/complete"},"summary":"Completes a single callback","description":"Completes a single callback","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"outputFields":{"type":"object","description":"Output Fields","required":true,"properties":{}}}},"example":{"outputFields":{}}}}}}},"/automation/v4/actions/{appId}/{definitionId}":{"get":{"tags":["Automation Custom Workflow Actions Definitions"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#get-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}"},"summary":"Get extension definition by Id","description":"Get extension definition by Id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Automation Custom Workflow Actions Definitions"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#patch-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}"},"summary":"Patch an existing extension definition","description":"Patch an existing extension definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"actionUrl":{"type":"string","description":"Action Url"},"executionRules":{"type":"string","description":"Execution Rules"},"inputFieldDependencies":{"type":"string","description":"Can only contain these supported types","enum":["SINGLE_FIELD","CONDITIONAL_SINGLE_FIELD"]},"inputFields":{"type":"string","description":"Input Fields"},"labels":{"type":"string","description":"labels"},"objectRequestOptions":{"type":"string","description":"Object RequestOptions"},"objectTypes":{"type":"string","description":"Object Types"},"outputFields":{"type":"string","description":"Output Fields"},"published":{"type":"string","description":"Published"}}},"example":{"actionUrl":"","executionRules":"","inputFieldDependencies":"","inputFields":"","labels":"","objectRequestOptions":"","objectTypes":"","outputFields":"","published":""}}}}},"delete":{"tags":["Automation Custom Workflow Actions Definitions"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#delete-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}"},"summary":"Archive an extension definition","description":"Archive an extension definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/automation/v4/actions/{appId}":{"get":{"tags":["Automation Custom Workflow Actions Definitions"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#get-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}"},"summary":"Get paged extension definitions","description":"Get paged extension definitions","security":[{"bearerAuth":[]}]},"post":{"tags":["Automation Custom Workflow Actions Definitions"],"parameters":[{"name":"appId","in":"path","description":"The ID of the app","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#post-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}"},"summary":"Create a new extension definition","description":"Create a new extension definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}":{"get":{"tags":["Automation Custom Workflow Actions Functions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionId","in":"path","description":"Function Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionType","in":"path","description":"Function Type","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["PRE_FETCH_OPTIONS","PRE_ACTION_EXECUTION","POST_FETCH_OPTIONS","POST_ACTION_EXECUTION"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#get-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Ffunctions%2F%7Bfunctiontype%7D%2F%7Bfunctionid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}"},"summary":"Get a function for a given definition","description":"Get a function for a given definition","security":[{"bearerAuth":[]}]},"put":{"tags":["Automation Custom Workflow Actions Functions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionId","in":"path","description":"Function Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionType","in":"path","description":"Function Type","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["PRE_FETCH_OPTIONS","PRE_ACTION_EXECUTION","POST_FETCH_OPTIONS","POST_ACTION_EXECUTION"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#put-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Ffunctions%2F%7Bfunctiontype%7D%2F%7Bfunctionid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}"},"summary":"Insert a function for a definition","description":"Insert a function for a definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Automation Custom Workflow Actions Functions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionId","in":"path","description":"Function Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionType","in":"path","description":"Function Type","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["PRE_FETCH_OPTIONS","PRE_ACTION_EXECUTION","POST_FETCH_OPTIONS","POST_ACTION_EXECUTION"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#delete-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Ffunctions%2F%7Bfunctiontype%7D%2F%7Bfunctionid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}/{functionId}"},"summary":"Archive a function for a definition","description":"Archive a function for a definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}":{"get":{"tags":["Automation Custom Workflow Actions Functions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionType","in":"path","description":"Function Type","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["PRE_FETCH_OPTIONS","PRE_ACTION_EXECUTION","POST_FETCH_OPTIONS","POST_ACTION_EXECUTION"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#get-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Ffunctions%2F%7Bfunctiontype%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}"},"summary":"Get all functions by a type for a given definition","description":"Get all functions by a type for a given definition","security":[{"bearerAuth":[]}]},"put":{"tags":["Automation Custom Workflow Actions Functions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionType","in":"path","description":"Function Type","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["PRE_FETCH_OPTIONS","PRE_ACTION_EXECUTION","POST_FETCH_OPTIONS","POST_ACTION_EXECUTION"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#put-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Ffunctions%2F%7Bfunctiontype%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}"},"summary":"Insert all function for a definition","description":"Insert all function for a definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Automation Custom Workflow Actions Functions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"functionId","in":"path","description":"Function Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#delete-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Ffunctions%2F%7Bfunctiontype%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/functions/{functionType}"},"summary":"Delete a function for a definition","description":"Delete a function for a definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/automation/v4/actions/{appId}/{definitionId}/functions":{"get":{"tags":["Automation Custom Workflow Actions Functions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#get-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Ffunctions","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/functions"},"summary":" Get all functions for a given definition","description":"Get all functions for a given definition","security":[{"bearerAuth":[]}]}},"/automation/v4/actions/{appId}/{definitionId}/revisions":{"get":{"tags":["Automation Custom Workflow Actions Revisions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","required":true,"schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#get-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Frevisions","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/revisions"},"summary":"Get all revisions for a given definition","description":"Get all revisions for a given definition","security":[{"bearerAuth":[]}]}},"/automation/v4/actions/{appId}/{definitionId}/revisions/{revisionId}":{"get":{"tags":["Automation Custom Workflow Actions Revisions"],"parameters":[{"name":"appId","in":"path","description":"App Id","required":true,"schema":{"type":"number","example":""}},{"name":"definitionId","in":"path","description":"Definition Id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"Revision Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/custom-workflow-actions#get-%2Fautomation%2Fv4%2Factions%2F%7Bappid%7D%2F%7Bdefinitionid%7D%2Frevisions%2F%7Brevisionid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/actions/{appId}/{definitionId}/revisions/{revisionId}"},"summary":"Gets a revision for a given definition by revision id","description":"Gets a revision for a given definition by revision id","security":[{"bearerAuth":[]}]}},"/automation/v4/sequences/enrollments/contact/{contactId}":{"get":{"tags":["Automation Sequences Public_Enrollments"],"parameters":[{"name":"contactId","in":"path","description":"Contact Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/sequences#get-%2Fautomation%2Fv4%2Fsequences%2Fenrollments%2Fcontact%2F%7Bcontactid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/sequences/enrollments/contact/{contactId}"},"summary":"Get a enrollment","description":"Get a enrollment","security":[{"bearerAuth":[]}]}},"/automation/v4/sequences/enrollments":{"post":{"tags":["Automation Sequences Public_Enrollments"],"parameters":[{"name":"userId","in":"query","description":"User Id","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/sequences#post-%2Fautomation%2Fv4%2Fsequences%2Fenrollments","api_endpoint":"https://api.hubapi.com/automation/v4/sequences/enrollments"},"summary":"Create a new enrollments","description":"Create a new enrollments","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contactId":{"type":"string","description":"Contact Id"},"senderEmail":{"type":"string","description":"Email Sender"},"sequenceId":{"type":"string","description":"Sequence Id"}}},"example":{"contactId":"","senderEmail":"","sequenceId":""}}}}}},"/automation/v4/sequences":{"get":{"tags":["Automation Sequences Public_Sequences"],"parameters":[{"name":"after","in":"query","description":"After","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Limit","schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"Name","schema":{"type":"string","example":""}},{"name":"userId","in":"query","description":"User Id","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/sequences#get-%2Fautomation%2Fv4%2Fsequences%2F","api_endpoint":"https://api.hubapi.com/automation/v4/sequences"},"summary":"Get all Sequences","description":"Get all Sequences","security":[{"bearerAuth":[]}]}},"/automation/v4/sequences/{sequenceId}":{"get":{"tags":["Automation Sequences Public_Sequences"],"parameters":[{"name":"sequenceId","in":"path","description":"Sequence Id","required":true,"schema":{"type":"string","example":""}},{"name":"userId","in":"query","description":"User Id","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/automation/sequences#get-%2Fautomation%2Fv4%2Fsequences%2F%7Bsequenceid%7D","api_endpoint":"https://api.hubapi.com/automation/v4/sequences/{sequenceId}"},"summary":"Get a Sequences","description":"Get a Sequences","security":[{"bearerAuth":[]}]}},"/content/api/v2/blogs":{"get":{"tags":["CMS Blogs Blog Details"],"parameters":[{"name":"archived_at","in":"query","description":"The offset set to start returning rows from","schema":{"example":""}},{"name":"created","in":"query","description":"The id of a topic you wish to filter blog posts by. Topic IDs can be found using the topics endpoint","schema":{"example":""}},{"name":"limit","in":"query","description":"exact, in - The internal name of the blog","schema":{"example":""}},{"name":"name","in":"query","description":"The number of items to return","schema":{"example":""}},{"name":"offset","in":"query","description":"exact, gt, gte - When the post was deleted, in milliseconds since the epoch. Zero if the blog post was never deleted. Use a DELETE request to delete the post, do not set this directly","schema":{"example":""}},{"name":"topic_id","in":"query","description":"exact, range, gt, gte, lt, lte - When the post was first created, in milliseconds since the epoch","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-details#list-blogs","api_endpoint":"https://api.hubapi.com/content/api/v2/blogs"},"summary":"List blogs","description":"List blogs","security":[{"bearerAuth":[]}]}},"/content/api/v2/blogs/:blog_id":{"get":{"tags":["CMS Blogs Blog Details"],"parameters":[{"name":"blog_id","in":"path","description":"The ID of the blog to get","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-details#get-a-blog-by-id","api_endpoint":"https://api.hubapi.com/content/api/v2/blogs/:blog_id"},"summary":"Get a blog by ID","description":"Get a blog by ID","security":[{"bearerAuth":[]}]}},"/content/api/v2/blogs/:blog_id/versions":{"get":{"tags":["CMS Blogs Blog Details"],"parameters":[{"name":"blog_id","in":"path","description":"The ID of the blog to get","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-details#get-a-blog-by-id","api_endpoint":"https://api.hubapi.com/content/api/v2/blogs/:blog_id/versions"},"summary":"List previous versions of the blog","description":"List previous versions of the blog","security":[{"bearerAuth":[]}]}},"/content/api/v2/blogs/:blog_id/versions/:version_id":{"get":{"tags":["CMS Blogs Blog Details"],"parameters":[{"name":"blog_id","in":"path","description":"The ID of the blog to get","required":true,"schema":{"example":""}},{"name":"version_id","in":"path","description":"Identifier of the version to look up","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-details#get-the-previous-version-of-the-blog","api_endpoint":"https://api.hubapi.com/content/api/v2/blogs/:blog_id/versions/:version_id"},"summary":"Get the previous version of the blog","description":"Get the previous version of the blog","security":[{"bearerAuth":[]}]}},"/cms/v3/blogs/authors":{"get":{"tags":["CMS Blogs Blog Authors"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results.","schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Authors. Defaults to false.","schema":{"example":""}},{"name":"createdAfter","in":"query","description":"Only return Blog Authors created after the specified time.","schema":{"example":""}},{"name":"createdAt","in":"query","description":"Only return Blog Authors created at exactly the specified time.","schema":{"example":""}},{"name":"createdBefore","in":"query","description":"Only return Blog Authors created before the specified time.","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return. Default is 100.","schema":{"example":""}},{"name":"property","in":"query","description":"Property","schema":{"example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results.","schema":{"example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return Blog Authors last updated after the specified time.","schema":{"example":""}},{"name":"updatedAt","in":"query","description":"Only return Blog Authors last updated at exactly the specified time.","schema":{"example":""}},{"name":"updatedBefore","in":"query","description":"Only return Blog Authors last updated before the specified time.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#get-%2Fcms%2Fv3%2Fblogs%2Fauthors","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors"},"summary":"Get all Blog Authors","description":"Get all Blog Authors","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors"},"summary":"Create a new Blog Author","description":"Create a new Blog Author","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BlogAuthor":{"type":"object","description":"Model definition for a Blog Author","properties":{}}}},"example":{"BlogAuthor":{}}}}}}},"/cms/v3/blogs/authors/{objectId}":{"get":{"tags":["CMS Blogs Blog Authors"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Author id","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Authors.","schema":{"example":""}},{"name":"property","in":"query","description":"Property","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#get-%2Fcms%2Fv3%2Fblogs%2Fauthors%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/{objectId}"},"summary":"Retrieve a Blog Author","description":"Retrieve a Blog Author","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Blogs Blog Authors"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Author id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to update deleted Blog Authors","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#patch-%2Fcms%2Fv3%2Fblogs%2Fauthors%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/{objectId}"},"summary":"Update a Blog Author","description":"Update a Blog Author","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BlogAuthor":{"type":"object","description":"Model definition for a Blog Author","properties":{}}}},"example":{"BlogAuthor":{}}}}}},"delete":{"tags":["CMS Blogs Blog Authors"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Author id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to update deleted Blog Authors","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#delete-%2Fcms%2Fv3%2Fblogs%2Fauthors%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/{objectId}"},"summary":"Delete a Blog Author","description":"Delete a Blog Author","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/authors/multi-language/attach-to-lang-group":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fmulti-language%2Fattach-to-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/multi-language/attach-to-lang-group"},"summary":"Attach a Blog Author to a multi-language group","description":"Attach a Blog Author to a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AttachToLangPrimaryRequestVNext":{"type":"string","description":"Request body object for attaching objects to multi-language groups"}}},"example":{"AttachToLangPrimaryRequestVNext":""}}}}}},"/cms/v3/blogs/authors/batch/create":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/batch/create"},"summary":"Create a batch of Blog Authors","description":"Create a batch of Blog Authors","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BatchInputBlogAuthor":{"type":"object","description":"Wrapper for providing an array of blog authors as inputs","properties":{}}}},"example":{"BatchInputBlogAuthor":{}}}}}}},"/cms/v3/blogs/authors/multi-language/create-language-variation":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fmulti-language%2Fcreate-language-variation","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/multi-language/create-language-variation"},"summary":"Create a new language variation","description":"Create a new language variation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"blogAuthor":{"type":"object","description":"Request body object for cloning blog authors","properties":{}}}},"example":{"blogAuthor":{}}}}}}},"/cms/v3/blogs/authors/batch/archive":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/batch/archive"},"summary":"Delete a batch of Blog Authors","description":"Delete a batch of Blog Authors","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BatchInputString":{"type":"object","description":"Wrapper for providing an array of strings as inputs","properties":{}}}},"example":{"BatchInputString":{}}}}}}},"/cms/v3/blogs/authors/multi-language/detach-from-lang-group":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fmulti-language%2Fdetach-from-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/multi-language/detach-from-lang-group"},"summary":"Detach a Blog Author from a multi-language group","description":"Detach a Blog Author from a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DetachFromLangGroupRequestVNext":{"type":"object","description":"Request body object for detaching objects from multi-language groups","properties":{}}}},"example":{"DetachFromLangGroupRequestVNext":{}}}}}}},"/cms/v3/blogs/authors/batch/read":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Authors","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/batch/read"},"summary":"Retrieve a batch of Blog Authors","description":"Retrieve a batch of Blog Authors","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BatchInputString":{"type":"object","description":"Wrapper for providing an array of strings as inputs","properties":{}}}},"example":{"BatchInputString":{}}}}}}},"/cms/v3/blogs/authors/batch/update":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Authors","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/batch/update"},"summary":"Update a batch of Blog Authors","description":"Update a batch of Blog Authors","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BatchInputJsonNode":{"type":"object","description":"Wrapper for providing an array of JSON nodes as inputs","properties":{}}}},"example":{"BatchInputJsonNode":{}}}}}}},"/cms/v3/blogs/authors/multi-language/update-languages":{"post":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#post-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fmulti-language%2Fupdate-languages","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/multi-language/update-languages"},"summary":"Update languages of multi-language group","description":"Update languages of multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"UpdateLanguagesRequestVNext":{"type":"object","description":"Request object for updating languages within a multi-language group","properties":{}}}},"example":{"UpdateLanguagesRequestVNext":{}}}}}}},"/cms/v3/blogs/authors/multi-language/set-new-lang-primary":{"put":{"tags":["CMS Blogs Blog Authors"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-authors#put-%2Fcms%2Fv3%2Fblogs%2Fauthors%2Fmulti-language%2Fset-new-lang-primary","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/authors/multi-language/set-new-lang-primary"},"summary":"Set a new primary language","description":"Set a new primary language","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"SetNewLanguagePrimaryRequestVNext":{"type":"object","description":"Request body object for setting a new primary language","properties":{}}}},"example":{"SetNewLanguagePrimaryRequestVNext":{}}}}}}},"/cms/v3/blogs/posts":{"get":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results.","schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Posts.","schema":{"example":""}},{"name":"createdAfter","in":"query","description":"Only return Blog Posts created after the specified time.","schema":{"example":""}},{"name":"createdAt","in":"query","description":"Only return Blog Posts created at exactly the specified time.","schema":{"example":""}},{"name":"createdBefore","in":"query","description":"Only return Blog Posts created before the specified time.","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"example":""}},{"name":"property","in":"query","description":"Property","schema":{"example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results.","schema":{"example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return Blog Posts last updated after the specified time.","schema":{"example":""}},{"name":"updatedAt","in":"query","description":"Only return Blog Posts last updated at exactly the specified time.","schema":{"example":""}},{"name":"updatedBefore","in":"query","description":"Only return Blog Posts last updated before the specified time.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#get-%2Fcms%2Fv3%2Fblogs%2Fposts","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts"},"summary":"Get all Blog Posts","description":"Get all Blog Posts","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts"},"summary":"Create a new Blog Post","description":"Create a new Blog Post","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BlogPost":{"type":"string","description":"Blog Post"}}},"example":{"BlogPost":""}}}}}},"/cms/v3/blogs/posts/{objectId}":{"get":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Posts.","schema":{"example":""}},{"name":"property","in":"query","description":"Property","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#get-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}"},"summary":"Retrieve a Blog Post","description":"Retrieve a Blog Post","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Posts.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#patch-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}"},"summary":"Update a Blog Post","description":"Update a Blog Post","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Blogpost":{"type":"string","description":"Blog Post"}}},"example":{"Blogpost":""}}}}},"delete":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Posts.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#delete-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}"},"summary":"Delete a Blog Post","description":"Delete a Blog Post","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/posts/{objectId}/draft":{"get":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#get-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/draft"},"summary":"Retrieve the full draft version of the Blog Post","description":"Retrieve the full draft version of the Blog Post","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#patch-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/draft"},"summary":"Update a Blog Post draft","description":"Update a Blog Post draft","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Blogpost":{"type":"string","description":"Blog Post"}}},"example":{"Blogpost":""}}}}}},"/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}":{"get":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"example":""}},{"name":"revisionId","in":"path","description":"The Blog Post version id","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#get-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}"},"summary":"Retrieves a previous version of a blog post","description":"Retrieves a previous version of a blog post","security":[{"bearerAuth":[]}]}},"/cms/v3/blogs/posts/{objectId}/revisions":{"get":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"example":""}},{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"example":""}},{"name":"before","in":"query","description":"he cursor token value to get the previous set of results","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#get-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Frevisions","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/revisions"},"summary":"Retrieves all the previous versions of a blog post","description":"Retrieves all the previous versions of a blog post","security":[{"bearerAuth":[]}]}},"/cms/v3/blogs/posts/multi-language/attach-to-lang-group":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fmulti-language%2Fattach-to-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/multi-language/attach-to-lang-group"},"summary":"Attach a Blog Post to a multi-language group","description":"Attach a Blog Post to a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"AttachToLangPrimaryRequestVNext":{"type":"string","description":"Request body object for attaching objects to multi-language groups"}}},"example":{"AttachToLangPrimaryRequestVNext":""}}}}}},"/cms/v3/blogs/posts/clone":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fclone","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/clone"},"summary":"Clone a Blog Post","description":"Clone a Blog Post","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ContentCloneRequestVNext":{"type":"string","description":"Request body object for cloning content"}}},"example":{"ContentCloneRequestVNext":""}}}}}},"/cms/v3/blogs/posts/batch/create":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/batch/create"},"summary":"Create a batch of Blog Posts","description":"Create a batch of Blog Posts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BatchInputBlogPost":{"type":"string","description":"Wrapper for providing an array of blog posts as inputs"}}},"example":{"BatchInputBlogPost":""}}}}}},"/cms/v3/blogs/posts/multi-language/create-language-variation":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fmulti-language%2Fcreate-language-variation","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/multi-language/create-language-variation"},"summary":"Create a new language variation","description":"Create a new language variation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BlogPostLanguageCloneRequestVNext":{"type":"string","description":"Request body object for creating new blog post language variant"}}},"example":{"BlogPostLanguageCloneRequestVNext":""}}}}}},"/cms/v3/blogs/posts/batch/archive":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/batch/archive"},"summary":"Delete a batch of Blog Posts","description":"Delete a batch of Blog Posts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/posts/multi-language/detach-from-lang-group":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fmulti-language%2Fdetach-from-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/multi-language/detach-from-lang-group"},"summary":"Detach a Blog Post from a multi-language group","description":"Detach a Blog Post from a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"DetachFromLangGroupRequestVNext":{"type":"object","description":"Request body object for detaching objects from multi-language groups","properties":{}}}},"example":{"DetachFromLangGroupRequestVNext":{}}}}}}},"/cms/v3/blogs/posts/{objectId}/draft/push-live":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The id of the Blog Post for which it's draft will be pushed live","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Fdraft%2Fpush-live","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/draft/push-live"},"summary":"Push Blog Post draft edits live","description":"Push Blog Post draft edits live","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/posts/{objectId}/draft/reset":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The id of the Blog Post for which it's draft will be pushed live","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Fdraft%2Freset","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/draft/reset"},"summary":"Reset the Blog Post draft to the live version","description":"Reset the Blog Post draft to the live version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Blog Post version id to restore","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Fdraft%2Freset","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore"},"summary":"Restore a previous version of a blog post","description":"Restore a previous version of a blog post","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore-to-draft":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Blog Post version id to restore","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore-to-draft","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore-to-draft"},"summary":"Restore a previous version of a blog post, to the draft version of the blog post","description":"Restore a previous version of a blog post, to the draft version of the blog post","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/posts/batch/read":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Posts.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/batch/read"},"summary":"Retrieve a batch of Blog Posts","description":"Retrieve a batch of Blog Posts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BatchInputString":{"type":"string","description":"Wrapper for providing an array of strings as inputs"}}},"example":{"BatchInputString":""}}}}}},"/cms/v3/blogs/posts/schedule":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fschedule","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/schedule"},"summary":"Schedule a Blog Post to be Published","description":"Schedule a Blog Post to be Published","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"ContentScheduleRequestVNext":{"type":"string","description":"Request body object for scheduling the publish of content"}}},"example":{"ContentScheduleRequestVNext":""}}}}}},"/cms/v3/blogs/posts/batch/update":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Posts.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/batch/update"},"summary":"Update a batch of Blog Posts","description":"Update a batch of Blog Posts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"BatchInputJsonNode":{"type":"string","description":"Wrapper for providing an array of JSON nodes as inputs"}}},"example":{"BatchInputJsonNode":""}}}}}},"/cms/v3/blogs/posts/multi-language/update-languages":{"post":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#post-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fmulti-language%2Fupdate-languages","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/multi-language/update-languages"},"summary":"Update languages of multi-language group","description":"Update languages of multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/posts/multi-language/set-new-lang-primary":{"put":{"tags":["CMS Blogs Blog Posts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-posts#put-%2Fcms%2Fv3%2Fblogs%2Fposts%2Fmulti-language%2Fset-new-lang-primary","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/posts/multi-language/set-new-lang-primary"},"summary":"Set a new primary language","description":"Set a new primary language","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags":{"get":{"tags":["CMS Blogs Blog Tags"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results.","schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Tags","schema":{"example":""}},{"name":"createdAfter","in":"query","description":"Only return Blog Tags created after the specified time.","schema":{"example":""}},{"name":"createdAt","in":"query","description":"Only return Blog Tags created at exactly the specified time.","schema":{"example":""}},{"name":"createdBefore","in":"query","description":"Only return Blog Tags created before the specified time.","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"example":""}},{"name":"property","in":"query","description":"Property","schema":{"example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results.","schema":{"example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return Blog Tags last updated after the specified time.","schema":{"example":""}},{"name":"updatedAt","in":"query","description":"Only return Blog Tags last updated at exactly the specified time.","schema":{"example":""}},{"name":"updatedBefore","in":"query","description":"Only return Blog Tags last updated before the specified time.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#get-%2Fcms%2Fv3%2Fblogs%2Ftags","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags"},"summary":"Get all Blog Tags","description":"Get all Blog Tags","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags"},"summary":"Create a new Blog Tag","description":"Create a new Blog Tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/{objectId}":{"get":{"tags":["CMS Blogs Blog Tags"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Tag id","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Tags","schema":{"example":""}},{"name":"property","in":"query","description":"Property","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#get-%2Fcms%2Fv3%2Fblogs%2Ftags%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/{objectId}"},"summary":"Retrieve a Blog Tag","description":"Retrieve a Blog Tag","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Blogs Blog Tags"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#patch-%2Fcms%2Fv3%2Fblogs%2Ftags%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/{objectId}"},"summary":"Update a Blog Tag","description":"Update a Blog Tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["CMS Blogs Blog Tags"],"parameters":[{"name":"objectId","in":"path","description":"The Blog Post id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Tags","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#delete-%2Fcms%2Fv3%2Fblogs%2Ftags%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/{objectId}"},"summary":"Delete a Blog Tag","description":"Delete a Blog Tag","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/multi-language/attach-to-lang-group":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fmulti-language%2Fattach-to-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/multi-language/attach-to-lang-group"},"summary":"Attach a Blog Tag to a multi-language group","description":"Attach a Blog Tag to a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/batch/create":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/batch/create"},"summary":"Create a batch of Blog Tags","description":"Create a batch of Blog Tags","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/multi-language/create-language-variation":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fmulti-language%2Fcreate-language-variation","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/multi-language/create-language-variation"},"summary":"Create a new language variation","description":"Create a new language variation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/batch/archive":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/batch/archive"},"summary":"Delete a batch of Blog Tags","description":"Delete a batch of Blog Tags","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/multi-language/detach-from-lang-group":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fmulti-language%2Fdetach-from-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/multi-language/detach-from-lang-group"},"summary":"Detach a Blog Tag from a multi-language group","description":"Detach a Blog Tag from a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/batch/read":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Tags","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/batch/read"},"summary":"Retrieve a batch of Blog Tags","description":"Retrieve a batch of Blog Tags","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/batch/update":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Blog Tags","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/batch/update"},"summary":"Update a batch of Blog Tags","description":"Update a batch of Blog Tags","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/multi-language/update-languages":{"post":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#post-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fmulti-language%2Fupdate-languages","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/multi-language/update-languages"},"summary":"Update languages of multi-language group  post","description":"Update languages of multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/blogs/tags/multi-language/set-new-lang-primary":{"put":{"tags":["CMS Blogs Blog Tags"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-tags#put-%2Fcms%2Fv3%2Fblogs%2Ftags%2Fmulti-language%2Fset-new-lang-primary","api_endpoint":"https://api.hubapi.com/cms/v3/blogs/tags/multi-language/set-new-lang-primary"},"summary":"Set a new primary language","description":"Set a new primary language","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/blogs/v3/topics":{"get":{"tags":["CMS Blogs Blog Topics"],"parameters":[{"name":"casing","in":"query","description":"Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default.","schema":{"example":""}},{"name":"created","in":"query","description":"Filter results by creation date, in milliseconds since the epoch","schema":{"example":""}},{"name":"id","in":"query","description":"Search for topics by id","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of items to return","schema":{"example":""}},{"name":"name","in":"query","description":"Search for topics by name","schema":{"example":""}},{"name":"offset","in":"query","description":"The offset from the beginning of the result set from which to start returning results","schema":{"example":""}},{"name":"slug","in":"query","description":"Search for topics by slug","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-topics#list-blog-topics","api_endpoint":"https://api.hubapi.com/blogs/v3/topics"},"summary":"List blog topics","description":"List blog topics","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Blogs Blog Topics"],"parameters":[{"name":"casing","in":"query","description":"Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-topics#create-a-new-blog-topic","api_endpoint":"https://api.hubapi.com/blogs/v3/topics"},"summary":"Create a new blog topic","description":"Create a new blog topic","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The topic description"},"name":{"type":"string","description":"The topic name"}}},"example":{"description":"","name":""}}}}}},"/blogs/v3/topics/search":{"get":{"tags":["CMS Blogs Blog Topics"],"parameters":[{"name":"active","in":"query","description":"Filter topics by whether or not they are associated with any published blog posts (true or false)","schema":{"example":""}},{"name":"blog","in":"query","description":"Filter topics by a blog they are used on (value is a blog ID)","schema":{"example":""}},{"name":"casing","in":"query","description":"Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default.","schema":{"example":""}},{"name":"created","in":"query","description":"Filter results by creation date, in milliseconds since the epoch","schema":{"example":""}},{"name":"id","in":"query","description":"Search for topics by id","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of items to return","schema":{"example":""}},{"name":"name","in":"query","description":"Search for topics by name","schema":{"example":""}},{"name":"offset","in":"query","description":"The offset from the beginning of the result set from which to start returning results","schema":{"example":""}},{"name":"q","in":"query","description":"Search for topics whose names or url slugs contain the given string","schema":{"example":""}},{"name":"slug","in":"query","description":"Search for topics by slug","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-topics#search-blog-topics","api_endpoint":"https://api.hubapi.com/blogs/v3/topics/search"},"summary":"Search blog topics","description":"Search blog topics","security":[{"bearerAuth":[]}]}},"/blogs/v3/topics/:topic-id":{"get":{"tags":["CMS Blogs Blog Topics"],"parameters":[{"name":"topic-id","in":"path","description":"Unique identifier for a particular topic","required":true,"schema":{"example":""}},{"name":"casing","in":"query","description":"Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-topics#get-a-blog-topic-by-id","api_endpoint":"https://api.hubapi.com/blogs/v3/topics/:topic-id"},"summary":"Get a blog topic by ID","description":"Get a blog topic by ID","security":[{"bearerAuth":[]}]},"put":{"tags":["CMS Blogs Blog Topics"],"parameters":[{"name":"topic-id","in":"path","description":"Unique identifier for a particular topic","required":true,"schema":{"example":""}},{"name":"casing","in":"query","description":"Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-topics#update-a-blog-topic","api_endpoint":"https://api.hubapi.com/blogs/v3/topics/:topic-id"},"summary":"Update a blog topic","description":"Update a blog topic","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"description":{"type":"string","description":"The topic description"},"name":{"type":"string","description":"The topic name"}}},"example":{"description":"","name":""}}}}}},"/blogs/v3/topics/group-topics":{"post":{"tags":["CMS Blogs Blog Topics"],"parameters":[{"name":"casing","in":"query","description":"Use the casing=snake parameter to change the API's casing for all query parameters (including those above) and JSON fields (below) to snake_case, rather than camelCase, which is the default.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-topics#group-blog-topics","api_endpoint":"https://api.hubapi.com/blogs/v3/topics/group-topics"},"summary":"Group blog topics","description":"Group blog topics","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"groupedTopicName":{"type":"string","description":"The new name of the combined topics"},"topicIds":{"type":"string","description":"The List of topic ids to merge"}}},"example":{"groupedTopicName":"","topicIds":""}}}}}},"/blogs/v3/topics/:topic-iid":{"delete":{"tags":["CMS Blogs Blog Topics"],"parameters":[{"name":"topic-id","in":"path","description":"Unique identifier for a particular topic","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-topics#delete-blog-topic","api_endpoint":"https://api.hubapi.com/blogs/v3/topics/:topic-iid"},"summary":"Delete blog topic","description":"Delete blog topic","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/comments/v3/comments":{"get":{"tags":["CMS Blogs Blog Comments"],"parameters":[{"name":"contentId","in":"query","description":"Allows you get comments for a specific blog post","schema":{"example":""}},{"name":"limit","in":"query","description":"The number of items to return","schema":{"example":""}},{"name":"offset","in":"query","description":"The offset set to start returning rows from","schema":{"example":""}},{"name":"portalId","in":"query","description":"The portal number associated with your api key/token","schema":{"example":""}},{"name":"query","in":"query","description":"Matches arbitrary text within a comment","schema":{"example":""}},{"name":"reverse","in":"query","description":"If you want comments oldest to newest","schema":{"example":""}},{"name":"state","in":"query","description":"Comment state","schema":{"example":"","items":{"type":"string","enum":["APPROVED","SPAM","REJECTED","PENDING_MODERATION"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-comments#list-comments","api_endpoint":"https://api.hubapi.com/comments/v3/comments"},"summary":"List comments","description":"List comments","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Blogs Blog Comments"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-comments#create-a-new-comment","api_endpoint":"https://api.hubapi.com/comments/v3/comments"},"summary":"Create a new comment","description":"Create a new comment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"collectionId":{"type":"string","description":"The ID of the blog that the post is a part of. You can get the blog ID through the Blog API","required":true},"comment":{"type":"string","description":"The full text of the comment","required":true},"contentAuthorEmail":{"type":"string","description":"The email address of the blog post author","required":true},"contentAuthorName":{"type":"string","description":"The name of the blog post author","required":true},"contentId":{"type":"string","description":"The id of the parent blog post","required":true},"contentPermalink":{"type":"string","description":"URL to the blog post","required":true},"contentTitle":{"type":"string","description":"Title of the blog post","required":true},"userEmail":{"type":"string","description":"The email address of the comment author","required":true},"userName":{"type":"string","description":"The name of the comment author","required":true},"userUrl":{"type":"string","description":"The homepage of the comment author"}}},"example":{"collectionId":"","comment":"","contentAuthorEmail":"","contentAuthorName":"","contentId":"","contentPermalink":"","contentTitle":"","userEmail":"","userName":"","userUrl":""}}}}}},"/comments/v3/comments/:comment_id":{"get":{"tags":["CMS Blogs Blog Comments"],"parameters":[{"name":"comment_id","in":"path","description":"Unique identifier for a particular comment","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-comments#get-a-blog-comment-by-id","api_endpoint":"https://api.hubapi.com/comments/v3/comments/:comment_id"},"summary":"Get a blog comment by ID","description":"Get a blog comment by ID","security":[{"bearerAuth":[]}]},"delete":{"tags":["CMS Blogs Blog Comments"],"parameters":[{"name":"comment_id","in":"path","description":"Unique identifier for a particular comment","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-comments#delete-the-comment","api_endpoint":"https://api.hubapi.com/comments/v3/comments/:comment_id"},"summary":"Delete the comment","description":"Delete the comment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/comments/v3/comments/:comment_id/restore":{"post":{"tags":["CMS Blogs Blog Comments"],"parameters":[{"name":"comment_id","in":"path","description":"Unique identifier for a particular comment","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/blogs/blog-comments#restores-a-previously-deleted-comment","api_endpoint":"https://api.hubapi.com/comments/v3/comments/:comment_id/restore"},"summary":"Restores a previously deleted comment","description":"Restores a previously deleted comment","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/audit-logs":{"get":{"tags":["CMS Content Audit Audit Logs"],"parameters":[{"name":"after","in":"query","description":"Timestamp after which audit logs will be returned","schema":{"example":""}},{"name":"before","in":"query","description":"Timestamp before which audit logs will be returned","schema":{"example":""}},{"name":"eventType","in":"query","description":"Comma separated list of event types to filter by (CREATED, UPDATED, PUBLISHED, DELETED, UNPUBLISHED).","schema":{"example":"","items":{"type":"string","enum":["CREATED","UPDATED","PUBLISHED","DELETED","UNPUBLISHED"]}}},{"name":"limit","in":"query","description":"The number of logs to return.","schema":{"example":""}},{"name":"objectId","in":"query","description":"Comma separated list of object ids to filter by.","schema":{"example":""}},{"name":"objectType","in":"query","description":"Comma separated list of object types to filter by (BLOG, LANDING_PAGE, DOMAIN, HUBDB_TABLE etc.)","schema":{"example":"","items":{"type":"string","enum":["BLOG","LANDING_PAGE","DOMAIN","HUBDB_TABLE"]}}},{"name":"sort","in":"query","description":"The sort direction for the audit logs.","schema":{"example":""}},{"name":"userId","in":"query","description":"Comma separated list of user ids to filter by","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/content-audit#get-%2Fcms%2Fv3%2Faudit-logs%2F","api_endpoint":"https://api.hubapi.com/cms/v3/audit-logs"},"summary":"Query audit logs","description":"Query audit logs","security":[{"bearerAuth":[]}]}},"/cms/v3/domains/{domainId}":{"get":{"tags":["CMS Domains"],"parameters":[{"name":"domainId","in":"path","description":"The unique ID of domain","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/domains#get-%2Fcms%2Fv3%2Fdomains%2F%7Bdomainid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/domains/{domainId}"},"summary":"Get a single domain","description":"Get a single domain","security":[{"bearerAuth":[]}]}},"/cms/v3/domains":{"get":{"tags":["CMS Domains"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results.","schema":{"example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived.","schema":{"example":""}},{"name":"createdAfter","in":"query","description":"Only return domains created after the specified time.","schema":{"example":""}},{"name":"createdAt","in":"query","description":"Only return domains created at exactly the specified time.","schema":{"example":""}},{"name":"createdBefore","in":"query","description":"Only return domains created before the specified time.","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results.","schema":{"example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return domains last updated after the specified time.","schema":{"example":""}},{"name":"updatedAt","in":"query","description":"Only return domains last updated at exactly the specified time.","schema":{"example":""}},{"name":"updatedBefore","in":"query","description":"Only return domains last updated before the specified time.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/domains#get-%2Fcms%2Fv3%2Fdomains%2F","api_endpoint":"https://api.hubapi.com/cms/v3/domains"},"summary":"Get current domains","description":"Get current domains","security":[{"bearerAuth":[]}]}},"/cms/v3/hubdb/tables/{tableIdOrName}/draft/export":{"get":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to export","required":true,"schema":{"example":""}},{"name":"format","in":"query","description":"The file format to export. Possible values include CSV, XLSX, and XLS","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Fdraft%2Fexport","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft/export"},"summary":"Export a draft table","description":"Export a draft table","security":[{"bearerAuth":[]}]}},"/cms/v3/hubdb/tables/{tableIdOrName}/export":{"get":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to export","required":true,"schema":{"example":""}},{"name":"format","in":"query","description":"The file format to export. Possible values include CSV, XLSX, and XLS","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Fdraft%2Fexport","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/export"},"summary":"Export a published version of a table","description":"Export a published version of a table","security":[{"bearerAuth":[]}]}},"/cms/v3/hubdb/tables":{"get":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results.","schema":{"example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived.","schema":{"example":""}},{"name":"contentType","in":"query","description":"Content Type","schema":{"example":""}},{"name":"createdAfter","in":"query","description":"Only return domains created after the specified time.","schema":{"example":""}},{"name":"createdAt","in":"query","description":"Only return domains created at exactly the specified time.","schema":{"example":""}},{"name":"createdBefore","in":"query","description":"Only return domains created before the specified time.","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results.","schema":{"example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return domains last updated after the specified time.","schema":{"example":""}},{"name":"updatedAt","in":"query","description":"Only return domains last updated at exactly the specified time.","schema":{"example":""}},{"name":"updatedBefore","in":"query","description":"Only return domains last updated before the specified time.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables"},"summary":"Get all published tables","description":"Get all published tables","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS HubDB Tables"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables"},"summary":"Create a new table","description":"Create a new table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowChildTables":{"type":"string","description":"Specifies creation of multi-level dynamic pages using child tables"},"allowPublicApiAccess":{"type":"string","description":"Specifies whether the table can be read by public without authorization"},"columns":{"type":"string","description":"List of columns in the table"},"dynamicMetaTags":{"type":"string","description":"Specifies the key value pairs of the metadata fields with the associated column IDs"},"enableChildTablePages":{"type":"string","description":"Specifies whether child tables can be created"},"label":{"type":"string","description":"Label of the table"},"name":{"type":"string","description":"Name of the table"},"useForPages":{"type":"string","description":"pecifies whether the table can be used for creation of dynamic pages"}}},"example":{"allowChildTables":"","allowPublicApiAccess":"","columns":"","dynamicMetaTags":"","enableChildTablePages":"","label":"","name":"","useForPages":""}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/draft":{"get":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to export","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived.","schema":{"example":""}},{"name":"includeForeignIds","in":"query","description":"Include Foreign Ids","schema":{"example":""}},{"name":"isGetLocalizedSchema","in":"query","description":"Is Get Localized Schema","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft"},"summary":"Get details for a draft table","description":"Get details for a draft table","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to update","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to return archived tables","schema":{"example":""}},{"name":"includeForeignIds","in":"query","description":"Set this to true to populate foreign ID values in the result","schema":{"example":""}},{"name":"isGetLocalizedSchema","in":"query","description":"Is Get Localized Schema","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#patch-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft"},"summary":"Update an existing table","description":"Update an existing table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"allowChildTables":{"type":"string","description":"Specifies creation of multi-level dynamic pages using child tables"},"allowPublicApiAccess":{"type":"string","description":"Specifies whether the table can be read by public without authorization"},"columns":{"type":"string","description":"List of columns in the table"},"dynamicMetaTags":{"type":"string","description":"Specifies the key value pairs of the metadata fields with the associated column IDs"},"enableChildTablePages":{"type":"string","description":"Specifies creation of multi-level dynamic pages using child tables"},"label":{"type":"string","description":"Label of the table"},"name":{"type":"string","description":"Name of the table"},"useForPages":{"type":"string","description":"pecifies whether the table can be used for creation of dynamic pages"}}},"example":{"allowChildTables":"","allowPublicApiAccess":"","columns":"","dynamicMetaTags":"","enableChildTablePages":"","label":"","name":"","useForPages":""}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}":{"get":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to export","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Set this to true to return details for an archived table","schema":{"example":""}},{"name":"includeForeignIds","in":"query","description":"Set this to true to populate foreign ID values in the result","schema":{"example":""}},{"name":"isGetLocalizedSchema","in":"query","description":"Is Get Localized Schema","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}"},"summary":"Get details of a published table","description":"Get details of a published table","security":[{"bearerAuth":[]}]},"delete":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to update","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#delete-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}"},"summary":"Archive a table","description":"Archive a table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/hubdb/tables/draft":{"get":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"archived","in":"query","description":"Set this to true to return details for an archived table","schema":{"example":""}},{"name":"includeForeignIds","in":"query","description":"Set this to true to populate foreign ID values in the result","schema":{"example":""}},{"name":"isGetLocalizedSchema","in":"query","description":"Is Get Localized Schema","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/draft"},"summary":"Return all draft tables","description":"Return all draft tables","security":[{"bearerAuth":[]}]}},"/cms/v3/hubdb/tables/{tableIdOrName}/draft/clone":{"post":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to export","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft/clone"},"summary":"Clone a table","description":"Clone a table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"copyRows":{"type":"string","description":"Specifies whether to copy the rows during clone","required":true},"isHubspotDefined":{"type":"string","description":"The maximum number of results to return","required":true},"newLabel":{"type":"string","description":"The new label for the cloned table"},"newName":{"type":"string","description":"The new name for the cloned table"}}},"example":{"copyRows":"","isHubspotDefined":"","newLabel":"","newName":""}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/draft/import":{"post":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to reset","required":true,"schema":{"example":""}},{"name":"includeForeignIds","in":"query","description":"Set this to true to populate foreign ID values in the response","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Fdraft%2Freset","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/draft/import"},"summary":"Reset a draft table","description":"Reset a draft table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/unpublish":{"post":{"tags":["CMS HubDB Tables"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table to publish","required":true,"schema":{"example":""}},{"name":"includeForeignIds","in":"query","description":"Set this to true to populate foreign ID values in the response","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Funpublish","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/unpublish"},"summary":"Unpublish a table","description":"Unpublish a table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft":{"get":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"rowId","in":"path","description":"The ID of the row","required":true,"schema":{"example":""}},{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2F%7Browid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft"},"summary":"Get a row from the draft table","description":"Get a row from the draft table","security":[{"bearerAuth":[]}]},"put":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"rowId","in":"path","description":"The ID of the row","required":true,"schema":{"example":""}},{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#put-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2F%7Browid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft"},"summary":"Replaces an existing row","description":"Replaces an existing row","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Specifies the value for hs_name column, which will be used as title in the dynamic pages"}}},"example":{"name":""}}}}},"patch":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"rowId","in":"path","description":"The ID of the row","required":true,"schema":{"example":""}},{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#patch-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2F%7Browid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft"},"summary":"Updates an existing row","description":"Updates an existing row","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Specifies the value for hs_name column, which will be used as title in the dynamic pages"}}},"example":{"name":""}}}}},"delete":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"rowId","in":"path","description":"The ID of the row","required":true,"schema":{"example":""}},{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#delete-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2F%7Browid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft"},"summary":"Permanently deletes a row","description":"Permanently deletes a row","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}":{"get":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"rowId","in":"path","description":"The ID of the row","required":true,"schema":{"example":""}},{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2F%7Browid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}"},"summary":"Get a table row","description":"Get a table row","security":[{"bearerAuth":[]}]}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows":{"get":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}},{"name":"after","in":"query","description":"The cursor token value to get the next set of results.","schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to copy the rows during clone","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"example":""}},{"name":"offset","in":"query","description":"OFF Set","schema":{"example":""}},{"name":"properties","in":"query","description":"Specify the column names to get results containing only the required columns instead of all column details","schema":{"example":""}},{"name":"sort","in":"query","description":"Specifies the column names to sort the results by.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows"},"summary":"Get rows for a table","description":"Get rows for a table","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows"},"summary":"Add a new row to a table","description":"Add a new row to a table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"path":{"type":"string","description":"Specifies the value for hs_path column, which will be used as slug in the dynamic pages"},"childTableId":{"type":"string","description":"Specifies the value for the column child table id"},"displayIndex":{"type":"string","description":"Display Index"},"name":{"type":"string","description":"Specifies the value for hs_name column, which will be used as title in the dynamic pages"},"values":{"type":"string","description":"List of key value pairs with the column name and column value"}}},"example":{"path":"","childTableId":"","displayIndex":"","name":"","values":""}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft":{"get":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}},{"name":"after","in":"query","description":"The cursor token value to get the next set of results.","schema":{"example":""}},{"name":"archived","in":"query","description":"Specifies whether to copy the rows during clone","schema":{"example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"example":""}},{"name":"offset","in":"query","description":"OFF Set","schema":{"example":""}},{"name":"properties","in":"query","description":"Specify the column names to get results containing only the required columns instead of all column details","schema":{"example":""}},{"name":"sort","in":"query","description":"Specifies the column names to sort the results by.","schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#get-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft"},"summary":"Get rows from draft table","description":"Get rows from draft table","security":[{"bearerAuth":[]}]}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone":{"post":{"tags":["CMS HubDB Rows"],"parameters":[{"name":"rowId","in":"path","description":"The ID of the row","required":true,"schema":{"example":""}},{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2F%7Browid%7D%2Fdraft%2Fclone","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/{rowId}/draft/clone"},"summary":"Clone a row","description":"Clone a row","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Specifies the value for hs_name column, which will be used as title in the dynamic pages"}}},"example":{"name":""}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/clone":{"post":{"tags":["CMS HubDB Rows Batch"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fdraft%2Fbatch%2Fclone","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/clone"},"summary":"Clone rows in batch","description":"Clone rows in batch","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputes","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/create":{"post":{"tags":["CMS HubDB Rows Batch"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fdraft%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/create"},"summary":"Create rows in batch","description":"Create rows in batch","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputes","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/batch/read":{"post":{"tags":["CMS HubDB Rows Batch"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/batch/read"},"summary":"Get a set of rows","description":"Get a set of rows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputes","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/read":{"post":{"tags":["CMS HubDB Rows Batch"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fdraft%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/read"},"summary":"Get a set of rows from draft table","description":"Get a set of rows from draft table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputes","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/purge":{"post":{"tags":["CMS HubDB Rows Batch"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fdraft%2Fbatch%2Fpurge","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/purge"},"summary":"Permanently deletes rows","description":"Permanently deletes rows","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputes","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/replace":{"post":{"tags":["CMS HubDB Rows Batch"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fdraft%2Fbatch%2Freplace","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/replace"},"summary":"Replace rows in batch in draft table","description":"Replace rows in batch in draft table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputes","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/update":{"post":{"tags":["CMS HubDB Rows Batch"],"parameters":[{"name":"tableIdOrName","in":"path","description":"The ID or name of the table","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/hubdb#post-%2Fcms%2Fv3%2Fhubdb%2Ftables%2F%7Btableidorname%7D%2Frows%2Fdraft%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/cms/v3/hubdb/tables/{tableIdOrName}/rows/draft/batch/update"},"summary":"Update rows in batch in draft table","description":"Update rows in batch in draft table","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Inputes","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/content/api/v2/layouts":{"get":{"tags":["CMS Layouts"],"parameters":[{"name":"path","in":"query","description":"exact","schema":{"type":"string","example":""}},{"name":"attached_stylesheets","in":"query","description":"List of references to stylesheets that are attached directly to the layout.","schema":{"type":"string","example":""}},{"name":"category_id","in":"query","description":"exact","schema":{"type":"string","example":""}},{"name":"created","in":"query","description":"exact, range, gt, gte, lt, lte","schema":{"type":"string","example":""}},{"name":"custom_head","in":"query","description":"Custom HTML added to the head of pages using the layout.","schema":{"type":"string","example":""}},{"name":"deleted_at","in":"query","description":"Use a DELETE request to delete the layout - do not set this directly.","schema":{"type":"string","example":""}},{"name":"enable_domain_stylesheet","in":"query","description":"Flag to include the domain stylesheets for a page using the layout.","schema":{"type":"string","example":""}},{"name":"id","in":"query","description":"exact, in","schema":{"type":"string","example":""}},{"name":"include_default_custom_css","in":"query","description":"Flag to include the Primary CSS stylesheet.","schema":{"type":"string","example":""}},{"name":"label","in":"query","description":"exact","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to return.","schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"The offset set to start returning rows from.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/layouts#list-layouts","api_endpoint":"https://api.hubapi.com/content/api/v2/layouts"},"summary":"List layouts","description":"List layouts","security":[{"bearerAuth":[]}]}},"/content/api/v2/layouts/:layout_id":{"get":{"tags":["CMS Layouts"],"parameters":[{"name":"layout_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/layouts#get-the-layout-by-id","api_endpoint":"https://api.hubapi.com/content/api/v2/layouts/:layout_id"},"summary":"Get the layout by ID","description":"Get the layout by ID","security":[{"bearerAuth":[]}]}},"/content/api/v2/layouts/:layout_id/buffer":{"get":{"tags":["CMS Layouts"],"parameters":[{"name":"layout_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/layouts#gets-the-current-contents-of-the-auto-save-buffer","api_endpoint":"https://api.hubapi.com/content/api/v2/layouts/:layout_id/buffer"},"summary":"Gets the current contents of the auto-save buffer","description":"Gets the current contents of the auto-save buffer","security":[{"bearerAuth":[]}]}},"/content/api/v2/layouts/:layout_id/has-buffered-changes":{"get":{"tags":["CMS Layouts"],"parameters":[{"name":"layout_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/layouts#determine-if-the-auto-save-buffer-differs-from-the-live-layout","api_endpoint":"https://api.hubapi.com/content/api/v2/layouts/:layout_id/has-buffered-changes"},"summary":"Determine if the auto-save buffer differs from the live layout","description":"Determine if the auto-save buffer differs from the live layout","security":[{"bearerAuth":[]}]}},"/content/api/v2/layouts/:layout_id/versions":{"get":{"tags":["CMS Layouts"],"parameters":[{"name":"layout_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/layouts#list-previous-versions-of-the-layout","api_endpoint":"https://api.hubapi.com/content/api/v2/layouts/:layout_id/versions"},"summary":"List previous versions of the layout","description":"List previous versions of the layout","security":[{"bearerAuth":[]}]}},"/content/api/v2/layouts/:layout_id/versions/:version_id":{"get":{"tags":["CMS Layouts"],"parameters":[{"name":"layout_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}},{"name":"version_id","in":"path","description":"Version id is the id of the version from the list previous versions endpoint","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/layouts#get-the-previous-version-of-the-layout","api_endpoint":"https://api.hubapi.com/content/api/v2/layouts/:layout_id/versions/:version_id"},"summary":"Get the previous version of the layout","description":"Get the previous version of the layout","security":[{"bearerAuth":[]}]}},"/media-bridge/v1/{appId}/settings/event-visibility":{"get":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Fevent-visibility","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/event-visibility"},"summary":"/media-bridge/v1/{appId}/settings/event-visibility","description":"/media-bridge/v1/{appId}/settings/event-visibility","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#patch-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Fevent-visibility","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/event-visibility"},"summary":"/media-bridge/v1/{appId}/settings/event-visibility","description":"/media-bridge/v1/{appId}/settings/event-visibility","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"eventType":{"type":"enum","description":"Event Type","enum":["MEDIA_PLAYS","MEDIA_PLAYS_PERCENT","ATTENTION_SPAN","ALL"]},"showInReporting":{"type":"boolean","description":"Show In Reporting","enum":[true,false]},"showInTimeline":{"type":"boolean","description":"Show In Timeline","enum":[true,false]},"showInWorkflows":{"type":"boolean","description":"Show In Workflows","enum":[true,false]},"updatedAt":{"type":"number","description":"Updated At"}}},"example":{"eventType":"","showInReporting":"","showInTimeline":"","showInWorkflows":"","updatedAt":""}}}}}},"/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}":{"get":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"mediaType","in":"path","description":"Type of media","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["VIDEO","AUDIO","IMAGE","DOCUMENT","OTHER"]}}},{"name":"includeFullDefinition","in":"query","description":"Include Full Definition","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Fobject-definitions%2F%7Bmediatype%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}"},"summary":"/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}","description":"/media-bridge/v1/{appId}/settings/object-definitions/{mediaType}","security":[{"bearerAuth":[]}]}},"/media-bridge/v1/{appId}/settings/oembed-domains":{"post":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Foembed-domains","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/oembed-domains"},"summary":"/media-bridge/v1/{appId}/settings/oembed-domains","description":"/media-bridge/v1/{appId}/settings/oembed-domains","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"endpoints":{"type":"object","description":"Endpoints","properties":{}},"portalId":{"type":"number","description":"Portal Id"}}},"example":{"endpoints":{},"portalId":""}}}}},"patch":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"domainPortalId","in":"query","description":"Domain Portal Id","schema":{"type":"number","example":""}},{"name":"id","in":"query","description":"ID","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#delete-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Foembed-domains","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/oembed-domains"},"summary":"/media-bridge/v1/{appId}/settings/oembed-domains","description":"/media-bridge/v1/{appId}/settings/oembed-domains","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}":{"get":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"oEmbedDomainId","in":"path","description":"Embed Domain Id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Foembed-domains%2F%7Boembeddomainid%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}"},"summary":"/media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}","description":"/media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"oEmbedDomainId","in":"path","description":"Embed DomainId","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#patch-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Foembed-domains%2F%7Boembeddomainid%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}"},"summary":"/media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}","description":"/media-bridge/v1/{appId}/settings/oembed-domains/{oEmbedDomainId}","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"endpoints":{"type":"object","description":"Endpoints","properties":{}},"portalId":{"type":"number","description":"Portal Id"}}},"example":{"endpoints":{},"portalId":""}}}}}},"/media-bridge/v1/{appId}/settings/object-definitions":{"post":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Fobject-definitions","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/object-definitions"},"summary":"/media-bridge/v1/{appId}/settings/object-definitions","description":"/media-bridge/v1/{appId}/settings/object-definitions","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"mediaType":{"type":"enum","description":"Type of media","required":true,"enum":["VIDEO","AUDIO","IMAGE","DOCUMENT","OTHER"]}}},"example":{"mediaType":""}}}}}},"/media-bridge/v1/{appId}/settings/register":{"post":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings%2Fregister","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings/register"},"summary":"/media-bridge/v1/{appId}/settings/register","description":"/media-bridge/v1/{appId}/settings/register","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"updatedAt":{"type":"number","description":"Updated At"}}},"example":{"name":"","updatedAt":""}}}}}},"/media-bridge/v1/{appId}/settings":{"put":{"tags":["CMS Media Bridge Integrator Settings"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#put-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fsettings","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/settings"},"summary":"/media-bridge/v1/{appId}/settings","description":"/media-bridge/v1/{appId}/settings\n\n","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"string","description":"Name"},"updatedAt":{"type":"number","description":"Updated At"}}},"example":{"name":"","updatedAt":""}}}}}},"/media-bridge/v1/{appId}/schemas":{"get":{"tags":["CMS Media Bridge Schemas"],"parameters":[{"name":"archived","in":"query","description":"hether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fschemas","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/schemas"},"summary":"/media-bridge/v1/{appId}/schemas","description":"/media-bridge/v1/{appId}/schemas","security":[{"bearerAuth":[]}]}},"/media-bridge/v1/{appId}/schemas/{objectType}":{"get":{"tags":["CMS Media Bridge Schemas"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fschemas%2F%7Bobjecttype%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/schemas/{objectType}"},"summary":"/media-bridge/v1/{appId}/schemas/{objectType}","description":"/media-bridge/v1/{appId}/schemas/{objectType}","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Media Bridge Schemas"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#patch-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fschemas%2F%7Bobjecttype%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/schemas/{objectType}"},"summary":"/media-bridge/v1/{appId}/schemas/{objectType}","description":"/media-bridge/v1/{appId}/schemas/{objectType}","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"clearDescription":{"type":"boolean","description":"Clear Description","enum":[true,false]},"description":{"type":"string","description":"Description"},"labels":{"type":"object","description":"Labels","properties":{}},"primaryDisplayProperty":{"type":"string","description":"Primary Display Property"},"requiredProperties":{"type":"array","description":"Required Properties","items":{"type":"string"}},"restorable":{"type":"boolean","description":"Restorable","enum":[true,false]},"searchableProperties":{"type":"array","description":"Searchable Properties","items":{"type":"string"}},"secondaryDisplayProperties":{"type":"array","description":"Secondary Display Properties","items":{"type":"string"}}}},"example":{"clearDescription":"","description":"","labels":{},"primaryDisplayProperty":"","requiredProperties":[],"restorable":"","searchableProperties":[],"secondaryDisplayProperties":[]}}}}}},"/media-bridge/v1/{appId}/schemas/{objectType}/associations":{"post":{"tags":["CMS Media Bridge Schemas"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fschemas%2F%7Bobjecttype%7D%2Fassociations","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/schemas/{objectType}/associations"},"summary":"/media-bridge/v1/{appId}/schemas/{objectType}/associations","description":"/media-bridge/v1/{appId}/schemas/{objectType}/associations","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"fromObjectTypeId":{"type":"string","description":"From Object Type Id"},"name":{"type":"string","description":"Name"},"toObjectTypeId":{"type":"string","description":"To Object Type Id"}}},"example":{"fromObjectTypeId":"","name":"","toObjectTypeId":""}}}}}},"/media-bridge/v1/{appId}/schemas/{objectType}/associations/{associationId}":{"delete":{"tags":["CMS Media Bridge Schemas"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"associationId","in":"path","description":"Association Id","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#delete-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fschemas%2F%7Bobjecttype%7D%2Fassociations%2F%7Bassociationid%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/schemas/{objectType}/associations/{associationId}"},"summary":"/media-bridge/v1/{appId}/schemas/{objectType}/associations/{associationId}","description":"/media-bridge/v1/{appId}/schemas/{objectType}/associations/{associationId}","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media-bridge/v1/{appId}/properties/{objectType}":{"get":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}","description":"/media-bridge/v1/{appId}/properties/{objectType}","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}","description":"/media-bridge/v1/{appId}/properties/{objectType}","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"type"},"calculationFormula":{"type":"string","description":"calculationFormula"},"description":{"type":"string","description":"description"},"displayOrder":{"type":"number","description":"displayOrder"},"externalOptions":{"type":"boolean","description":"externalOptions","enum":[true,false]},"fieldType":{"type":"enum","description":"fieldType","enum":["file","radio","select","booleancheckbox","textarea","text","html","checkbox","date","number","calculation_equation"]},"formField":{"type":"boolean","description":"formField","enum":[true,false]},"groupName":{"type":"string","description":"groupName"},"hasUniqueValue":{"type":"boolean","description":"hasUniqueValue","enum":[true,false]},"hidden":{"type":"boolean","description":"hidden","enum":[true,false]},"label":{"type":"string","description":"label"},"name":{"type":"string","description":"name"},"options":{"type":"array","description":"options","items":{"type":"string"}},"referencedObjectType":{"type":"string","description":"referencedObjectType"}}},"example":{"type":"","calculationFormula":"","description":"","displayOrder":"","externalOptions":"","fieldType":"","formField":"","groupName":"","hasUniqueValue":"","hidden":"","label":"","name":"","options":[],"referencedObjectType":""}}}}}},"/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}":{"get":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}},{"name":"propertyName","in":"path","description":"Property Name","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"properties","in":"query","description":"Properties","schema":{"type":"strign","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2F%7Bpropertyname%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}","description":"/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}","security":[{"bearerAuth":[]}]},"delete":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}},{"name":"propertyName","in":"path","description":"Property Name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#delete-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2F%7Bpropertyname%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}","description":"/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media-bridge/v1/{appId}/properties/{objectType}/batch/archive":{"post":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/batch/archive"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}/batch/archive","description":"/media-bridge/v1/{appId}/properties/{objectType}/batch/archive","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/media-bridge/v1/{appId}/properties/{objectType}/batch/create":{"post":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/batch/create"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}/batch/create","description":"/media-bridge/v1/{appId}/properties/{objectType}/batch/create","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/media-bridge/v1/{appId}/properties/{objectType}/batch/read":{"post":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/batch/read"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}/batch/read","description":"/media-bridge/v1/{appId}/properties/{objectType}/batch/read","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"archived":{"type":"boolean","description":"whether to return only results that have been archived","enum":[true,false]},"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"archived":"","inputs":[]}}}}},"patch":{"tags":["CMS Media Bridge Propertie"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Object Type","required":true,"schema":{"type":"string","example":""}},{"name":"propertyName","in":"path","description":"Property Name","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#patch-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2F%7Bpropertyname%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/batch/read"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}","description":"/media-bridge/v1/{appId}/properties/{objectType}/{propertyName}","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"type":{"type":"string","description":"type"},"calculationFormula":{"type":"string","description":"calculationFormula"},"description":{"type":"string","description":"description"},"displayOrder":{"type":"number","description":"displayOrder"},"fieldType":{"type":"enum","description":"fieldType","enum":["file","radio","select","booleancheckbox","textarea","text","html","checkbox","date","number","calculation_equation"]},"formField":{"type":"boolean","description":"formField","enum":[true,false]},"groupName":{"type":"string","description":"groupName"},"hasUniqueValue":{"type":"boolean","description":"hasUniqueValue","enum":[true,false]},"hidden":{"type":"boolean","description":"hidden","enum":[true,false]},"label":{"type":"string","description":"label"},"name":{"type":"string","description":"name"},"options":{"type":"array","description":"options","items":{"type":"string"}},"referencedObjectType":{"type":"string","description":"referencedObjectType"}}},"example":{"type":"","calculationFormula":"","description":"","displayOrder":"","fieldType":"","formField":"","groupName":"","hasUniqueValue":"","hidden":"","label":"","name":"","options":[],"referencedObjectType":""}}}}}},"/media-bridge/v1/events/attention-span":{"post":{"tags":["CMS Media Bridge Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2Fevents%2Fattention-span","api_endpoint":"https://api.hubapi.com/media-bridge/v1/events/attention-span"},"summary":"/media-bridge/v1/events/attention-span","description":"/media-bridge/v1/events/attention-span","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media-bridge/v1/events/media-played":{"post":{"tags":["CMS Media Bridge Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2Fevents%2Fmedia-played","api_endpoint":"https://api.hubapi.com/media-bridge/v1/events/media-played"},"summary":"/media-bridge/v1/events/media-played","description":"/media-bridge/v1/events/media-played","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media-bridge/v1/events/media-played-percent":{"post":{"tags":["CMS Media Bridge Events"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2Fevents%2Fmedia-played-percent","api_endpoint":"https://api.hubapi.com/media-bridge/v1/events/media-played-percent"},"summary":"/media-bridge/v1/events/media-played-percent","description":"/media-bridge/v1/events/media-played-percent","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/media-bridge/v1/{appId}/properties/{objectType}/groups":{"get":{"tags":["CMS Media Bridge Groups"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Type of Object","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fgroups","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/groups"},"summary":"/media-bridge/v1/{appId}/properties/{objectType}/groups","description":"/media-bridge/v1/{appId}/properties/{objectType}/groups","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Media Bridge Groups"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Type of Object","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fgroups","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/groups"},"summary":"Create a Group","description":"Create a Group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"displayOrder":{"type":"number","description":"displayOrder"},"label":{"type":"string","description":"label"},"name":{"type":"name","description":"The ID of app"}}},"example":{"displayOrder":"","label":"","name":""}}}}}},"/media-bridge/v1/{appId}/properties/{objectType}/groups/{groupName}":{"get":{"tags":["CMS Media Bridge Groups"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"groupName","in":"path","description":"groupName","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Type of Object","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#get-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fgroups%2F%7Bgroupname%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/groups/{groupName}"},"summary":"Get a Group by Gorup Name","description":"Get a Group by Gorup Name","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Media Bridge Groups"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"groupName","in":"path","description":"groupName","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Type of Object","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#post-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fgroups","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/groups/{groupName}"},"summary":"Update a Group","description":"Update a Group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"displayOrder":{"type":"number","description":"displayOrder"},"label":{"type":"string","description":"label"}}},"example":{"displayOrder":"","label":""}}}}},"delete":{"tags":["CMS Media Bridge Groups"],"parameters":[{"name":"appId","in":"path","description":"The ID of app","required":true,"schema":{"type":"string","example":""}},{"name":"groupName","in":"path","description":"groupName","required":true,"schema":{"type":"string","example":""}},{"name":"objectType","in":"path","description":"Type of Object","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/media-bridge#delete-%2Fmedia-bridge%2Fv1%2F%7Bappid%7D%2Fproperties%2F%7Bobjecttype%7D%2Fgroups%2F%7Bgroupname%7D","api_endpoint":"https://api.hubapi.com/media-bridge/v1/{appId}/properties/{objectType}/groups/{groupName}"},"summary":"Delete a Group","description":"Delete a Group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/content/api/v4/custom_widgets/:id":{"get":{"tags":["CMS Modules"],"parameters":[{"name":"id","in":"path","description":"The ID of the module to fetch the details for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/modules#get-the-details-for-a-module-by-id","api_endpoint":"https://api.hubapi.com/content/api/v4/custom_widgets/:id"},"summary":"Get the details for a module by ID","description":"Get the details for a module by ID","security":[{"bearerAuth":[]}]}},"/content/api/v4/custom_widgets/by-path/:path":{"get":{"tags":["CMS Modules"],"parameters":[{"name":"path","in":"path","description":"The path of the module to fetch the details for","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/modules#get-the-details-for-a-module-by-path","api_endpoint":"https://api.hubapi.com/content/api/v4/custom_widgets/by-path/:path"},"summary":"Get the details for a module by path","description":"Get the details for a module by path","security":[{"bearerAuth":[]}]}},"/cms/v3/site-search/indexed-data/{contentId}":{"get":{"tags":["CMS Site Search Public"],"parameters":[{"name":"contentId","in":"path","description":"ID of the target document when searching for indexed properties","required":true,"schema":{"type":"string","example":""}},{"name":"type","in":"query","description":"The type of document","schema":{"type":"enum","example":"","items":{"type":"string","enum":["SITE_PAGE","BLOG_POST","KNOWLEDGE_ARTICLE","LANDING_PAGE"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/site-search#get-%2Fcms%2Fv3%2Fsite-search%2Findexed-data%2F%7Bcontentid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/site-search/indexed-data/{contentId}"},"summary":"Get indexed properties","description":"Get indexed properties","security":[{"bearerAuth":[]}]}},"/cms/v3/site-search/search":{"get":{"tags":["CMS Site Search Public"],"parameters":[{"name":"type","in":"query","description":"Specifies the type of content to search.","schema":{"type":"enum","example":"","items":{"type":"string","enum":["SITE_PAGE","BLOG_POST","KNOWLEDGE_ARTICLE","LANDING_PAGE","LISTING_PAGE"]}}},{"name":"autocomplete","in":"query","description":"Specifies whether or not you are showing autocomplete results. ","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"boostLimit","in":"query","description":"Specifies the maximum amount a result will be boosted based on its view count.","schema":{"type":"number","example":""}},{"name":"boostRecent","in":"query","description":"Specifies a relative time window where scores of documents published outside this time window decay. ","schema":{"type":"string","example":""}},{"name":"domain","in":"query","description":"A domain to match search results for.","schema":{"type":"string","example":""}},{"name":"groupId","in":"query","description":"Specifies which blog(s) to be searched by blog ID.","schema":{"type":"number","example":""}},{"name":"hubdbQuery","in":"query","description":"Specify a HubDB query to further filter the search results.","schema":{"type":"string","example":""}},{"name":"language","in":"query","description":"Specifies the language of content to be searched. ","schema":{"type":"string","example":""}},{"name":"length","in":"query","description":"Specifies the length of the search results.","schema":{"type":"enum","example":"","items":{"type":"string","enum":["SHORT","LONG"]}}},{"name":"limit","in":"query","description":"Specifies the number of results to be returned in a single response. ","schema":{"type":"number","example":""}},{"name":"matchPrefix","in":"query","description":"Inverts the behavior of the pathPrefix filter when set to false. ","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"offset","in":"query","description":"Used to page through the results.","schema":{"type":"number","example":""}},{"name":"pathPrefix","in":"query","description":"Specifies a path prefix to filter search results. Will only return results with URL paths that start with the specified parameter.","schema":{"type":"array","example":""}},{"name":"popularityBoost","in":"query","description":"Specifies how strongly a result is boosted based on its view count. ","schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"Specifies which properties to include in the search. Options include title, description, and html.","schema":{"type":"array","example":""}},{"name":"q","in":"query","description":"The term to search for.","schema":{"type":"string","example":""}},{"name":"tableId","in":"query","description":"Specifies a specific HubDB table to search.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/site-search#get-%2Fcms%2Fv3%2Fsite-search%2Fsearch","api_endpoint":"https://api.hubapi.com/cms/v3/site-search/search"},"summary":"Search your site","description":"Search your site","security":[{"bearerAuth":[]}]}},"/cms/v3/pages/site-pages":{"get":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Site Pages","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"createdAfter","in":"query","description":"Only return Site Pages created after the specified time.","schema":{"type":"string","example":""}},{"name":"createdAt","in":"query","description":"Only return Site Pages created at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"createdBefore","in":"query","description":"Only return Site Pages created before the specified time.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"property","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results","schema":{"type":"enum","example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return Site Pages last updated after the specified time.","schema":{"type":"string","example":""}},{"name":"updatedAt","in":"query","description":"Only return Site Pages last updated at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"updatedBefore","in":"query","description":"Only return Site Pages last updated before the specified time.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Fsite-pages","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages"},"summary":"Get all Site Pages","description":"Get all Site Pages","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages"},"summary":"Create a new Site Page","description":"Create a new Site Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"object","description":"Page","properties":{}}}},"example":{"page":{}}}}}}},"/cms/v3/pages/site-pages/{objectId}":{"get":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Site Pages","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"property","in":"query","description":"property","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}"},"summary":"Retrieve a Site Page","description":"Retrieve a Site Page","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Folders.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#patch-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}"},"summary":"Update a Site Page","description":"Update a Site Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"object","description":"Page","properties":{}}}},"example":{"page":{}}}}}},"delete":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Folders.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#delete-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}"},"summary":"Delete a Site Page","description":"Delete a Site Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/site-pages/{objectId}/draft":{"get":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/draft"},"summary":"Retrieve the full draft version of the Site Page","description":"Retrieve the full draft version of the Site Page","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#patch-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/draft"},"summary":"Update a Site Page draft","description":"Update a Site Page draft","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"object","description":"Page","properties":{}}}},"example":{"page":{}}}}}}},"/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}":{"get":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}"},"summary":"Retrieves a previous version of a Site Page","description":"Retrieves a previous version of a Site Page","security":[{"bearerAuth":[]}]}},"/cms/v3/pages/site-pages/{objectId}/revisions":{"get":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"Before","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/revisions"},"summary":"Retrieves all the previous versions of a Site Page","description":"Retrieves all the previous versions of a Site Page","security":[{"bearerAuth":[]}]}},"/cms/v3/pages/site-pages/multi-language/attach-to-lang-group":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fmulti-language%2Fattach-to-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/multi-language/attach-to-lang-group"},"summary":"Attach a site page to a multi-language group","description":"Attach a site page to a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"ID of the object to add to a multi-language group"},"language":{"type":"string","description":"Designated language of the object to add to a multi-language group"},"primaryId":{"type":"string","description":"ID of primary language object in multi-language group"},"primaryLanguage":{"type":"string","description":"Primary language of the multi-language group"}}},"example":{"id":"","language":"","primaryId":"","primaryLanguage":""}}}}}},"/cms/v3/pages/site-pages/clone":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fclone","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/clone"},"summary":"Clone a Site Page","description":"Clone a Site Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cloneName":{"type":"string","description":"Name of the cloned object"},"id":{"type":"string","description":"ID of the object to be cloned"}}},"example":{"cloneName":"","id":""}}}}}},"/cms/v3/pages/site-pages/batch/create":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/batch/create"},"summary":"Create a batch of Site Pages","description":"Create a batch of Site Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"string","description":"Pages to input"}}},"example":{"inputs":""}}}}}},"/cms/v3/pages/site-pages/ab-test/create-variation":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fab-test%2Fcreate-variation","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/ab-test/create-variation"},"summary":"Create a new A/B test variation","description":"Create a new A/B test variation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentId":{"type":"string","description":"ID of the object to test","required":true},"variationName":{"type":"string","description":"Name of A/B test variation","required":true}}},"example":{"contentId":"","variationName":""}}}}}},"/cms/v3/pages/site-pages/multi-language/create-language-variation":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fmulti-language%2Fcreate-language-variation","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/multi-language/create-language-variation"},"summary":"Create a new language variation","description":"Create a new language variation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"ID of content to clone","required":true},"language":{"type":"string","description":"Target language of new variant"},"primaryLanguage":{"type":"string","description":"Language of primary content to clone"}}},"example":{"id":"","language":"","primaryLanguage":""}}}}}},"/cms/v3/pages/site-pages/batch/archive":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/batch/archive"},"summary":"Delete a batch of Site Pages","description":"Delete a batch of Site Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Strings to input","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/site-pages/multi-language/detach-from-lang-group":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fmulti-language%2Fdetach-from-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/multi-language/detach-from-lang-group"},"summary":"Detach a site page from a multi-language group","description":"Detach a site page from a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"ID of the object to remove from a multi-language group","required":true}}},"example":{"id":""}}}}}},"/cms/v3/pages/site-pages/ab-test/end":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fab-test%2Fend","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/ab-test/end"},"summary":"End an active A/B test","description":"End an active A/B test","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"abTestId":{"type":"string","description":"ID of the test to end","required":true},"winnerId":{"type":"string","description":"ID of the object to designate as the test winner","required":true}}},"example":{"abTestId":"","winnerId":""}}}}}},"/cms/v3/pages/site-pages/{objectId}/draft/push-live":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Fdraft%2Fpush-live","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/draft/push-live"},"summary":"Push Site Page draft edits live","description":"Push Site Page draft edits live","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/site-pages/ab-test/rerun":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fab-test%2Frerun","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/ab-test/rerun"},"summary":"Rerun a previous A/B test","description":"Rerun a previous A/B test","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"abTestId":{"type":"string","description":"ID of the test to rerun","required":true},"variationId":{"type":"string","description":"ID of the object to reactivate as a test variation","required":true}}},"example":{"abTestId":"","variationId":""}}}}}},"/cms/v3/pages/site-pages/{objectId}/draft/reset":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Fdraft%2Freset","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/draft/reset"},"summary":"Reset the Site Page draft to the live version","description":"Reset the Site Page draft to the live version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Site Page version id to restore","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore"},"summary":"Restore a previous version of a Site Page","description":"Restore a previous version of a Site Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Site Page id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Site Page version id to restore","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore-to-draft","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/{objectId}/revisions/{revisionId}/restore-to-draft"},"summary":"Restore a previous version of a Site Page, to the draft version of the Site Page","description":"Restore a previous version of a Site Page, to the draft version of the Site Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/site-pages/schedule":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fschedule","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/schedule"},"summary":"Schedule a Site Page to be Published","description":"Schedule a Site Page to be Published","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"The ID of the object to be scheduled","required":true},"publishDate":{"type":"string","description":"The date the object should transition from scheduled to published","required":true}}},"example":{"id":"","publishDate":""}}}}}},"/cms/v3/pages/site-pages/batch/update":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/batch/update"},"summary":"Update a batch of Site Pages","description":"Update a batch of Site Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"JSON nodes to input","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/site-pages/multi-language/update-languages":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fmulti-language%2Fupdate-languages","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/multi-language/update-languages"},"summary":"Update languages of multi-language group","description":"Update languages of multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"languages":{"type":"object","description":"Map of object IDs to associated languages of object in the multi-language group","required":true,"properties":{}},"primaryId":{"type":"string","description":"D of the primary object in the multi-language group","required":true}}},"example":{"languages":{},"primaryId":""}}}}}},"/cms/v3/pages/site-pages/multi-language/set-new-lang-primary":{"put":{"tags":["CMS Pages Site Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#put-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fmulti-language%2Fset-new-lang-primary","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/multi-language/set-new-lang-primary"},"summary":"Set a new primary language","description":"Set a new primary language","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"ID of object to set as primary in multi-language group","required":true}}},"example":{"id":""}}}}}},"/cms/v3/pages/site-pages/batch/read":{"post":{"tags":["CMS Pages Site Pages"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Folders.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Fsite-pages%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/pages/site-pages/batch/read"},"summary":"Retrieve a batch of Site Pages","description":"Retrieve a batch of Site Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"String to input","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/landing-pages/folders":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Folders","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"createdAfter","in":"query","description":"Only return Folders created after the specified time.","schema":{"type":"string","example":""}},{"name":"createdAt","in":"query","description":"Only return Folders created at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"createdBefore","in":"query","description":"Only return Folders created before the specified time.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"property","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results","schema":{"type":"enum","example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return Folders last updated after the specified time.","schema":{"type":"string","example":""}},{"name":"updatedAt","in":"query","description":"Only return Folders last updated at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"updatedBefore","in":"query","description":"Only return Folders last updated before the specified time.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders"},"summary":"Get all Landing Page Folders","description":"Get all Landing Page Folders","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders"},"summary":"Create a new Folder","description":"Create a new Folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"category":{"type":"number","description":"The type of object this folder applies to. Should always be LANDING_PAGE."},"created":{"type":"string","description":"Created"},"deletedAt":{"type":"string","description":"The timestamp (ISO8601 format) when this content folder was deleted."},"id":{"type":"string","description":"The unique ID of the content folder."},"name":{"type":"string","description":"The name of the folder which will show up in the app dashboard"},"parentFolderId":{"type":"number","description":"The ID of the content folder this folder is nested under"},"updated":{"type":"string","description":"Updated"}}},"example":{"category":"","created":"","deletedAt":"","id":"","name":"","parentFolderId":"","updated":""}}}}}},"/cms/v3/pages/landing-pages":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Landing Pages","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"createdAfter","in":"query","description":"Only return Landing Pages created after the specified time.","schema":{"type":"string","example":""}},{"name":"createdAt","in":"query","description":"Only return Landing Pages created at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"createdBefore","in":"query","description":"Only return Landing Pages created before the specified time.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"property","schema":{"type":"string","example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results","schema":{"type":"enum","example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return Landing Pages last updated after the specified time.","schema":{"type":"string","example":""}},{"name":"updatedAt","in":"query","description":"Only return Landing Pages last updated at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"updatedBefore","in":"query","description":"Only return Landing Pages last updated before the specified time.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages"},"summary":"Get all Landing Pages","description":"Get all Landing Pages","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages"},"summary":"Create a new Landing Page","description":"Create a new Landing Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"object","description":"Page","properties":{}}}},"example":{"page":{}}}}}}},"/cms/v3/pages/landing-pages/folders/{objectId}":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Folder id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Folders","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"property","in":"query","description":"Property","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/{objectId}"},"summary":"Retrieve a Folder","description":"Retrieve a Folder","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The id of Folder","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#delete-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/{objectId}"},"summary":"Delete a Folder","description":"Delete a Folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/landing-pages/{objectId}":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Landing Page id","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Landing Pages","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"property","in":"query","description":"Property","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}"},"summary":"Retrieve a Landing Page","description":"Retrieve a Landing Page","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The id of Landing Page","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted Landing Pages.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#patch-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}"},"summary":"Update a Landing Page","description":"Update a Landing Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"object","description":"Page","properties":{}}}},"example":{"page":{}}}}}}},"/cms/v3/pages/landing-pages/{objectId}/draft":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Landing Page id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/draft"},"summary":"Retrieve the full draft version of the Landing Page","description":"Retrieve the full draft version of the Landing Page","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The id of Landing Page","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#patch-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/draft"},"summary":"Update a Landing Page draft","description":"Update a Landing Page draft","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"page":{"type":"object","description":"Page","properties":{}}}},"example":{"page":{}}}}}}},"/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Folder id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Folder version id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}"},"summary":"Retrieves a previous version of a Folder","description":"Retrieves a previous version of a Folder","security":[{"bearerAuth":[]}]}},"/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Landing Page id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Landing Pag version id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}"},"summary":"Retrieves a previous version of a Landing Page","description":"Retrieves a previous version of a Landing Page","security":[{"bearerAuth":[]}]}},"/cms/v3/pages/landing-pages/{objectId}/revisions":{"get":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Landing Page id","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"Before","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#get-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Frevisions","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/revisions"},"summary":"Retrieves all the previous versions of a Landing Page","description":"Retrieves all the previous versions of a Landing Page","security":[{"bearerAuth":[]}]}},"/cms/v3/pages/landing-pages/multi-language/attach-to-lang-group":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fmulti-language%2Fattach-to-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/multi-language/attach-to-lang-group"},"summary":"Attach a landing page to a multi-language group","description":"Attach a landing page to a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"ID of the object to add to a multi-language group","required":true},"language":{"type":"string","description":"Designated language of the object to add to a multi-language group","required":true},"primaryId":{"type":"string","description":"ID of primary language object in multi-language group","required":true},"primaryLanguage":{"type":"string","description":"Primary language of the multi-language group","required":true}}},"example":{"id":"","language":"","primaryId":"","primaryLanguage":""}}}}}},"/cms/v3/pages/landing-pages/clone":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fclone","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/clone"},"summary":"Clone a Landing Page","description":"Clone a Landing Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cloneName":{"type":"string","description":"Name of the cloned object"},"id":{"type":"string","description":"ID of the object to be cloned","required":true}}},"example":{"cloneName":"","id":""}}}}}},"/cms/v3/pages/landing-pages/folders/batch/create":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/batch/create"},"summary":"Create a batch of Folders","description":"Create a batch of Folders","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Content folders to input","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/landing-pages/batch/create":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/batch/create"},"summary":"Create a batch of Landing Pages","description":"Create a batch of Landing Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"Content folders to input","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/landing-pages/ab-test/create-variation":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fab-test%2Fcreate-variation","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/ab-test/create-variation"},"summary":"Create a new A/B test variation","description":"Create a new A/B test variation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentId":{"type":"string","description":"ID of the object to test"},"variationName":{"type":"strign","description":"Name of A/B test variation"}}},"example":{"contentId":"","variationName":""}}}}}},"/cms/v3/pages/landing-pages/multi-language/create-language-variation":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fmulti-language%2Fcreate-language-variation","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/multi-language/create-language-variation"},"summary":"Create a new language variation","description":"Create a new language variation","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"Target language of new variant"},"language":{"type":"string","description":"Target language of new variant"},"primaryLanguage":{"type":"string","description":"Language of primary content to clone"}}},"example":{"id":"","language":"","primaryLanguage":""}}}}}},"/cms/v3/pages/landing-pages/folders/batch/archive":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/batch/archive"},"summary":"Delete a batch of Folders","description":"Delete a batch of Folders","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"String to input","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/landing-pages/batch/archive":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/batch/archive"},"summary":"Delete a batch of Landing Pages","description":"Delete a batch of Landing Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"String to input","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/landing-pages/multi-language/detach-from-lang-group":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fmulti-language%2Fdetach-from-lang-group","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/multi-language/detach-from-lang-group"},"summary":"Detach a landing page from a multi-language group","description":"Detach a landing page from a multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"ID of the object to remove from a multi-language group"}}},"example":{"id":""}}}}}},"/cms/v3/pages/landing-pages/ab-test/end":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fab-test%2Fend","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/ab-test/end"},"summary":"End an active A/B test","description":"End an active A/B test","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"abTestId":{"type":"string","description":"ID of the test to end","required":true},"winnerId":{"type":"string","description":"ID of the object to designate as the test winner","required":true}}},"example":{"abTestId":"","winnerId":""}}}}}},"/cms/v3/pages/landing-pages/{objectId}/draft/push-live":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The id of the Landing Page for which it's draft will be pushed live","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Fdraft%2Fpush-live","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/draft/push-live"},"summary":"Push Landing Page draft edits live","description":"Push Landing Page draft edits live","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/landing-pages/ab-test/rerun":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fab-test%2Frerun","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/ab-test/rerun"},"summary":"Rerun a previous A/B test","description":"Rerun a previous A/B test","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"abTestId":{"type":"string","description":"ID of the test to rerun","required":true},"variationId":{"type":"string","description":"ID of the object to reactivate as a test variation","required":true}}},"example":{"abTestId":"","variationId":""}}}}}},"/cms/v3/pages/landing-pages/{objectId}/draft/reset":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The id of the Landing Page for which it's draft will be reset.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Fdraft%2Freset","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/draft/reset"},"summary":"Reset the Landing Page draft to the live version","description":"Reset the Landing Page draft to the live version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}/restore":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Folder id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Folder version id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/{objectId}/revisions/{revisionId}/restore"},"summary":"Restore a previous version of a Folder","description":"Restore a previous version of a Folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Landing Page id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Landing Page version id","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore"},"summary":"Restore a previous version of a Landing Page","description":"Restore a previous version of a Landing Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"objectId","in":"path","description":"The Landing Page id","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The Landing Page version id to restore","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2F%7Bobjectid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore-to-draft","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/{objectId}/revisions/{revisionId}/restore-to-draft"},"summary":"Restore a previous version of a Landing Page, to the draft version of the Landing Page","description":"Restore a previous version of a Landing Page, to the draft version of the Landing Page","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/pages/landing-pages/folders/batch/read":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Folders.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/batch/read"},"summary":"Retrieve a batch of Folders","description":"Retrieve a batch of Folders","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"string","description":"String to input","required":true}}},"example":{"inputs":""}}}}}},"/cms/v3/pages/landing-pages/batch/read":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Landing Pages.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/batch/read"},"summary":"Retrieve a batch of Landing Pages","description":"Retrieve a batch of Landing Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"string","description":"String to input","required":true}}},"example":{"inputs":""}}}}}},"/cms/v3/pages/landing-pages/schedule":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Landing Pages.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fschedule","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/schedule"},"summary":"Schedule a Landing Page to be Published","description":"Schedule a Landing Page to be Published","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"The ID of the object to be scheduled","required":true},"publishDate":{"type":"string","description":"The date the object should transition from scheduled to published.","required":true}}},"example":{"id":"","publishDate":""}}}}}},"/cms/v3/pages/landing-pages/folders/batch/update":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Ffolders%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/folders/batch/update"},"summary":"Update a batch of Folders","description":"Update a batch of Folders","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"JSON nodes to input","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/landing-pages/batch/update":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[{"name":"archived","in":"query","description":"Specifies whether to return deleted Landing Pages.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/batch/update"},"summary":"Update a batch of Landing Pages","description":"Update a batch of Landing Pages","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"JSON nodes to input","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/cms/v3/pages/landing-pages/multi-language/update-languages":{"post":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#post-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fmulti-language%2Fupdate-languages","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/multi-language/update-languages"},"summary":"Update languages of multi-language group","description":"Update languages of multi-language group","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"languages":{"type":"objcet","description":"Map of object IDs to associated languages of object in the multi-language group","required":true},"primaryId":{"type":"string","description":"ID of the primary object in the multi-language group","required":true}}},"example":{"languages":"","primaryId":""}}}}}},"/cms/v3/pages/landing-pages/multi-language/set-new-lang-primary":{"put":{"tags":["CMS Pages Landing Pages"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/pages#put-%2Fcms%2Fv3%2Fpages%2Flanding-pages%2Fmulti-language%2Fset-new-lang-primary","api_endpoint":"https://api.hubapi.com/cms/v3/pages/landing-pages/multi-language/set-new-lang-primary"},"summary":"Set a new primary language","description":"Set a new primary language","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"Id":{"type":"string","description":"ID of object to set as primary in multi-language group","required":true}}},"example":{"Id":""}}}}}},"/cms/v3/source-code/{environment}/content/{path}":{"get":{"tags":["CMS Source Code Content"],"parameters":[{"name":"path","in":"path","description":"The file system location of the file","required":true,"schema":{"type":"string","example":""}},{"name":"environment","in":"path","description":"The environment of the file ('draft' or 'published')","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#get-%2Fcms%2Fv3%2Fsource-code%2F%7Benvironment%7D%2Fcontent%2F%7Bpath%7D","api_endpoint":"https://api.hubapi.com/cms/v3/source-code/{environment}/content/{path}"},"summary":"Download a file","description":"Download a file","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Source Code Content"],"parameters":[{"name":"path","in":"path","description":"The file system location of the file","required":true,"schema":{"type":"string","example":""}},{"name":"environment","in":"path","description":"The environment of the file ('draft' or 'published')","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#post-%2Fcms%2Fv3%2Fsource-code%2F%7Benvironment%7D%2Fcontent%2F%7Bpath%7D","api_endpoint":"https://api.hubapi.com/cms/v3/source-code/{environment}/content/{path}"},"summary":"Create a file","description":"Create a file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"Binary string test values are not supported","required":true}}},"example":{"file":"(binary)"}}}}},"put":{"tags":["CMS Source Code Content"],"parameters":[{"name":"path","in":"path","description":"The file system location of the file","required":true,"schema":{"type":"string","example":""}},{"name":"environment","in":"path","description":"The environment of the file ('draft' or 'published')","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#put-%2Fcms%2Fv3%2Fsource-code%2F%7Benvironment%7D%2Fcontent%2F%7Bpath%7D","api_endpoint":"https://api.hubapi.com/cms/v3/source-code/{environment}/content/{path}"},"summary":"Create or update a file","description":"Create or update a file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"Binary string test values are not supported","required":true}}},"example":{"file":"(binary)"}}}}},"delete":{"tags":["CMS Source Code Content"],"parameters":[{"name":"path","in":"path","description":"The file system location of the file","required":true,"schema":{"type":"string","example":""}},{"name":"environment","in":"path","description":"The environment of the file ('draft' or 'published')","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#delete-%2Fcms%2Fv3%2Fsource-code%2F%7Benvironment%7D%2Fcontent%2F%7Bpath%7D","api_endpoint":"https://api.hubapi.com/cms/v3/source-code/{environment}/content/{path}"},"summary":"Delete a file","description":"Delete a file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/source-code/{environment}/metadata/{path}":{"get":{"tags":["CMS Source Code Metadata"],"parameters":[{"name":"path","in":"path","description":"The file system location of the file","required":true,"schema":{"type":"string","example":""}},{"name":"environment","in":"path","description":"The environment of the file ('draft' or 'published')","required":true,"schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"Properties","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#get-%2Fcms%2Fv3%2Fsource-code%2F%7Benvironment%7D%2Fmetadata%2F%7Bpath%7D","api_endpoint":"https://api.hubapi.com/cms/v3/source-code/{environment}/metadata/{path}"},"summary":"Get the metadata for a file","description":"Get the metadata for a file","security":[{"bearerAuth":[]}]}},"/docs/reference/api/cms/source-code":{"post":{"tags":["CMS Source Code Validation"],"parameters":[{"name":"path","in":"path","description":"The file system location of the file","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#post-%2Fcms%2Fv3%2Fsource-code%2F%7Benvironment%7D%2Fvalidate%2F%7Bpath%7D","api_endpoint":"https://developers.hubspot.com/docs/reference/api/cms/source-code#post-%2Fcms%2Fv3%2Fsource-code%2F%7Benvironment%7D%2Fvalidate%2F%7Bpath%7D"},"summary":"Validate the contents of a file","description":"Validate the contents of a file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"file":{"type":"string","format":"binary","description":"Binary string test values are not supported"}}},"example":{"file":"(binary)"}}}}}},"/cms/v3/source-code/extract/async/tasks/{taskId}/status":{"get":{"tags":["CMS Source Code Extract"],"parameters":[{"name":"taskId","in":"path","description":"The extraction task ID returned by the initial extract/async request","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#get-%2Fcms%2Fv3%2Fsource-code%2Fextract%2Fasync%2Ftasks%2F%7Btaskid%7D%2Fstatus","api_endpoint":"https://api.hubapi.com/cms/v3/source-code/extract/async/tasks/{taskId}/status"},"summary":"Get extraction status","description":"Get extraction status","security":[{"bearerAuth":[]}]}},"/cms/v3/source-code/extract/async":{"post":{"tags":["CMS Source Code Extract"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/source-code#post-%2Fcms%2Fv3%2Fsource-code%2Fextract%2Fasync","api_endpoint":"https://api.hubapi.com/cms/v3/source-code/extract/async"},"summary":"Extract a zip file","description":"Extract a zip file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"path":{"type":"string","description":"File path","required":true}}},"example":{"path":""}}}}}},"/content/api/v2/templates":{"get":{"tags":["CMS Templates"],"parameters":[{"name":"path","in":"query","description":"Path","schema":{"type":"string","example":""}},{"name":"deleted_at","in":"query","description":"Deleted at","schema":{"type":"number","example":""}},{"name":"id","in":"query","description":"ID","schema":{"type":"number","example":""}},{"name":"is_available_for_new_content","in":"query","description":"Is available for new content","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"label","in":"query","description":"Label","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The number of items to return. Defaults to 20.","schema":{"type":"number","example":""}},{"name":"offset","in":"query","description":"The offset set to start returning rows from. Defaults to 0.","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#list-templates","api_endpoint":"https://api.hubapi.com/content/api/v2/templates"},"summary":"List Templates","description":"List Templates","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS Templates"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#create-a-new-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates"},"summary":"Create a new Template","description":"Create a new Template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"path":{"type":"number","description":"The Design Manager path to the directory that contains the file being created"},"category_id":{"type":"number","description":"This parameter category type: 0 - Unmapped, 1 - Landing Pages, 2 - Email, 3 - Blog Post,4 - Site Page"},"folder":{"type":"number","description":"The name of the folder to save the template in Design Manager"},"is_available_for_new_content":{"type":"string","description":"Is available for new content"},"source":{"type":"boolean","description":"The source code of the file","enum":[true,false]},"template_type":{"type":"number","description":"This parameter accepts a numeric value and sets the type of template that is created . The following numbers correspond to specific template types: 2 - Email template, 4 - Page template, 11 - Error template, 12 - Subscription preferences template, 13 - Backup unsubscribe page template, 14 - Subscriptions update confirmation template, 19 - Password prompt page template, 27 - Search results template, 29 - Membership login template, 30 - Membership registration template, 31 - Membership reset password confirmation template, 32 - Membership reset password request template"}}},"example":{"path":"","category_id":"","folder":"","is_available_for_new_content":"","source":"","template_type":""}}}}}},"/content/api/v2/templates/:template_id":{"get":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"The unique id of the template","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#get-the-template-by-id","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id"},"summary":"Get the Template by ID","description":"Get the Template by ID","security":[{"bearerAuth":[]}]},"put":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#update-the-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id"},"summary":"Update the Template","description":"Update the Template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#delete-selected-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id"},"summary":"Delete Selected Template","description":"Delete Selected Template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/content/api/v2/templates/:template_id/buffer":{"get":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"The unique id of the template","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#gets-the-current-contents-of-the-auto-save-buffer","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/buffer"},"summary":"Gets the current contents of the auto-save buffer","description":"Gets the current contents of the auto-save buffer","security":[{"bearerAuth":[]}]},"put":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#updates-the-auto-save-buffer","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/buffer"},"summary":"Updates the auto-save buffer","description":"Updates the auto-save buffer","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/content/api/v2/templates/:template_id/has-buffered-changes":{"get":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#determine-if-the-auto-save-buffer-differs-from-the-live-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/has-buffered-changes"},"summary":"Determine if the auto-save buffer differs from the live Template","description":"Determine if the auto-save buffer differs from the live Template","security":[{"bearerAuth":[]}]}},"/content/api/v2/templates/:template_id/versions":{"get":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#list-previous-versions-of-the-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/versions"},"summary":"List previous versions of the Template","description":"List previous versions of the Template","security":[{"bearerAuth":[]}]}},"/content/api/v2/templates/:template_id/versions/:version_id":{"get":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}},{"name":"version_id","in":"path","description":"Unique identifier for a specific version","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#get-the-previous-version-of-the-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/versions/:version_id"},"summary":"Get the previous version of the Template","description":"Get the previous version of the Template","security":[{"bearerAuth":[]}]}},"/content/api/v2/templates/:template_id/push-buffer-live":{"post":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#copy-the-contents-of-the-auto-save-buffer-into-the-live-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/push-buffer-live"},"summary":"Copy the contents of the auto-save buffer into the live Template","description":"Copy the contents of the auto-save buffer into the live Template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/content/api/v2/templates/:template_id/restore-deleted":{"post":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#restores-a-previously-deleted-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/restore-deleted"},"summary":"Restores a previously deleted Template","description":"Restores a previously deleted Template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/content/api/v2/templates/:template_id/versions/restore":{"post":{"tags":["CMS Templates"],"parameters":[{"name":"template_id","in":"path","description":"Unique identifier for a particular blog","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/templates#restore-a-previous-version-of-the-template","api_endpoint":"https://api.hubapi.com/content/api/v2/templates/:template_id/versions/restore"},"summary":"Restore a previous version of the Template","description":"Restore a previous version of the Template","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/cms/v3/url-redirects":{"get":{"tags":["CMS URL Redirects Redirects"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return deleted redirects","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"createdAfter","in":"query","description":"Only return redirects created after the specified time.","schema":{"type":"string","example":""}},{"name":"createdAt","in":"query","description":"Only return redirects created at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"createdBefore","in":"query","description":"Only return redirects created before the specified time.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"Specifies which fields to use for sorting results","schema":{"type":"enum","example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return redirects last updated after the specified time.","schema":{"type":"string","example":""}},{"name":"updatedAt","in":"query","description":"Only return redirects last updated at exactly the specified time.","schema":{"type":"string","example":""}},{"name":"updatedBefore","in":"query","description":"Only return redirects last updated before the specified time.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/url-redirects#get-%2Fcms%2Fv3%2Furl-redirects%2F","api_endpoint":"https://api.hubapi.com/cms/v3/url-redirects"},"summary":"Get current redirects","description":"Get current redirects","security":[{"bearerAuth":[]}]},"post":{"tags":["CMS URL Redirects Redirects"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/url-redirects#post-%2Fcms%2Fv3%2Furl-redirects%2F","api_endpoint":"https://api.hubapi.com/cms/v3/url-redirects"},"summary":"Create a redirect","description":"Create a redirect","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"destination":{"type":"string","description":"The destination URL, where the target URL should be redirected if it matches the routePrefix"},"isMatchFullUrl":{"type":"boolean","description":"Whether the routePrefix should match on the entire URL, including the domain","enum":[true,false]},"isMatchQueryString":{"type":"boolean","description":"Whether the routePrefix should match on the entire URL path, including the query string","enum":[true,false]},"isOnlyAfterNotFound":{"type":"boolean","description":"Whether the URL redirect mapping should apply only if a live page on the URL isn't found","enum":[true,false]},"isPattern":{"type":"boolean","description":"Whether the routePrefix should match based on pattern","enum":[true,false]},"isProtocolAgnostic":{"type":"boolean","description":"isProtocolAgnostic","enum":[true,false]},"isTrailingSlashOptional":{"type":"boolean","description":"Whether a trailing slash will be ignored.","enum":[true,false]},"precedence":{"type":"number","description":"Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the lower precedence will be used"},"redirectStyle":{"type":"number","description":"The type of redirect to create"},"routePrefix":{"type":"string","description":"The target incoming URL, path, or pattern to match for redirection"}}},"example":{"destination":"","isMatchFullUrl":"","isMatchQueryString":"","isOnlyAfterNotFound":"","isPattern":"","isProtocolAgnostic":"","isTrailingSlashOptional":"","precedence":"","redirectStyle":"","routePrefix":""}}}}}},"/cms/v3/url-redirects/{urlRedirectId}":{"get":{"tags":["CMS URL Redirects Redirects"],"parameters":[{"name":"urlRedirectId","in":"path","description":"The ID of the target redirect","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/url-redirects#get-%2Fcms%2Fv3%2Furl-redirects%2F%7Burlredirectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/url-redirects/{urlRedirectId}"},"summary":"Get details for a redirect","description":"Get details for a redirect","security":[{"bearerAuth":[]}]},"patch":{"tags":["CMS URL Redirects Redirects"],"parameters":[{"name":"urlRedirectId","in":"path","description":"The ID of the target redirect","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/url-redirects#patch-%2Fcms%2Fv3%2Furl-redirects%2F%7Burlredirectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/url-redirects/{urlRedirectId}"},"summary":"Update a redirect","description":"Update a redirect","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"created":{"type":"string","description":"created"},"destination":{"type":"string","description":"The destination URL, where the target URL should be redirected if it matches the routePrefix"},"id":{"type":"string","description":"The unique ID of this URL redirect"},"isMatchFullUrl":{"type":"boolean","description":"Whether the routePrefix should match on the entire URL, including the domain","enum":[true,false]},"isMatchQueryString":{"type":"boolean","description":"Whether the routePrefix should match on the entire URL path, including the query string","enum":[true,false]},"isOnlyAfterNotFound":{"type":"boolean","description":"Whether the URL redirect mapping should apply only if a live page on the URL isn't found","enum":[true,false]},"isPattern":{"type":"boolean","description":"Whether the routePrefix should match based on pattern","enum":[true,false]},"isProtocolAgnostic":{"type":"boolean","description":"Whether the routePrefix should match both HTTP and HTTPS protocols","enum":[true,false]},"isTrailingSlashOptional":{"type":"boolean","description":"Whether a trailing slash will be ignored.","enum":[true,false]},"precedence":{"type":"number","description":"Used to prioritize URL redirection. If a given URL matches more than one redirect, the one with the lower precedence will be used"},"redirectStyle":{"type":"number","description":"The type of redirect to create"},"routePrefix":{"type":"string","description":"The target incoming URL, path, or pattern to match for redirection"},"updated":{"type":"string","description":"updated"}}},"example":{"created":"","destination":"","id":"","isMatchFullUrl":"","isMatchQueryString":"","isOnlyAfterNotFound":"","isPattern":"","isProtocolAgnostic":"","isTrailingSlashOptional":"","precedence":"","redirectStyle":"","routePrefix":"","updated":""}}}}},"delete":{"tags":["CMS URL Redirects Redirects"],"parameters":[{"name":"urlRedirectId","in":"path","description":"The ID of the target redirect","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/cms/url-redirects#delete-%2Fcms%2Fv3%2Furl-redirects%2F%7Burlredirectid%7D","api_endpoint":"https://api.hubapi.com/cms/v3/url-redirects/{urlRedirectId}"},"summary":"Delete a redirect","description":"Delete a redirect","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/conversations/v3/custom-channels/{channelId}":{"get":{"tags":["Conversations Create Custom Channels Channel"],"parameters":[{"name":"channelId","in":"path","description":"The ID of the channel","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#get-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}"},"summary":"Get a custom channel","description":"Get a custom channel","security":[{"bearerAuth":[]}]},"delete":{"tags":["Conversations Create Custom Channels Channel"],"parameters":[{"name":"channelId","in":"path","description":"The ID of the channel","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#delete-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}"},"summary":"Archive a custom channel","description":"Archive a custom channel","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/conversations/v3/custom-channels":{"get":{"tags":["Conversations Create Custom Channels Channel"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"defaultPageLength","in":"query","description":"Default page length","schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"short","in":"query","description":"Short","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#get-%2Fconversations%2Fv3%2Fcustom-channels%2F","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels"},"summary":"Get all channels for app","description":"Get all channels for app","security":[{"bearerAuth":[]}]},"post":{"tags":["Conversations Create Custom Channels Channel"],"parameters":[{"name":"capabilities","in":"query","description":"Capabilities","required":true,"schema":{"type":"object","example":""}},{"name":"channelAccountConnectionRedirectUrl","in":"query","description":"Channel account connection redirect url","schema":{"type":"string","example":""}},{"name":"name","in":"query","description":"Name","required":true,"schema":{"type":"string","example":""}},{"name":"webhookUrl","in":"query","description":"Webhook Url","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#post-%2Fconversations%2Fv3%2Fcustom-channels%2F","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels"},"summary":"Create a custom channel","description":"Create a custom channel","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/conversations/v3/custom-channels/{channelId}/messages/{messageId}":{"get":{"tags":["Conversations Create Custom Channels Messages"],"parameters":[{"name":"channelId","in":"path","description":"The channel the message was sent over","required":true,"schema":{"type":"number","example":""}},{"name":"messageId","in":"path","description":"The id of the message","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#get-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fmessages%2F%7Bmessageid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/messages/{messageId}"},"summary":"Get a message","description":"Get a message","security":[{"bearerAuth":[]}]},"patch":{"tags":["Conversations Create Custom Channels Messages"],"parameters":[{"name":"channelId","in":"path","description":"The channel the message was sent over","required":true,"schema":{"type":"number","example":""}},{"name":"messageId","in":"path","description":"The id of the message","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#patch-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fmessages%2F%7Bmessageid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/messages/{messageId}"},"summary":"Update message","description":"Update message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"errorMessage":{"type":"string","description":"Message error"},"statusType":{"type":"enum","description":"Valid status are SENT, FAILED, and READ","enum":["SENT","FAILED","READ"]}}},"example":{"errorMessage":"","statusType":""}}}}}},"/conversations/v3/custom-channels/{channelId}/messages":{"post":{"tags":["Conversations Create Custom Channels Messages"],"parameters":[{"name":"channelId","in":"path","description":"The channel the message was sent over","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#post-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fmessages","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/messages"},"summary":"Publish a message","description":"Publish a message","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"text","required":true},"attachments":{"type":"enum","description":"Can only contain these supported types","required":true,"enum":["FILE","LOCATION","CONTACT","UNSUPPORTED_CONTENT","MESSAGE_HEADER","QUICK_REPLIES"]},"channelAccountId":{"type":"string","description":"Channel account id","required":true},"inReplyToId":{"type":"string","description":"In reply to id"},"integrationIdempotencyId":{"type":"string","description":"Integration idempotency id"},"integrationThreadId":{"type":"string","description":"Integration thread id","required":true},"messageDirection":{"type":"enum","description":"Message direction","required":true,"enum":["INCOMING","OUTGOING"]},"recipients":{"type":"array","description":"Recipients","required":true,"items":{"type":"string"}},"richText":{"type":"string","description":"Rich text"},"senders":{"type":"array","description":"Senders","required":true,"items":{"type":"string"}},"timestamp":{"type":"string","description":"Timestamp","required":true}}},"example":{"text":"","attachments":"","channelAccountId":"","inReplyToId":"","integrationIdempotencyId":"","integrationThreadId":"","messageDirection":"","recipients":[],"richText":"","senders":[],"timestamp":""}}}}}},"/conversations/v3/custom-channels/{channelId}/channel-account-staging-tokens/{accountToken}":{"patch":{"tags":["Conversations Create Custom Channels Channel Account Staging Tokens"],"parameters":[{"name":"accountToken","in":"path","description":"The token of account","required":true,"schema":{"type":"string","example":""}},{"name":"channelId","in":"path","description":"The channel the message was sent over","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#patch-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fchannel-account-staging-tokens%2F%7Baccounttoken%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/channel-account-staging-tokens/{accountToken}"},"summary":"Update a channel account staging token","description":"Update a channel account staging token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"accountName":{"type":"string","description":"Account Name"},"deliveryIdentifier":{"type":"object","description":"Delivery Identifier","properties":{}}}},"example":{"accountName":"","deliveryIdentifier":{}}}}}}},"/conversations/v3/custom-channels/{channelId}/channel-accounts/{channelAccountId}":{"get":{"tags":["Conversations Create Custom Channels Channel Accounts"],"parameters":[{"name":"channelAccountId","in":"path","description":"The id of the Channel Account","required":true,"schema":{"type":"number","example":""}},{"name":"channelId","in":"path","description":"The id of the Channel","required":true,"schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#get-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fchannel-accounts%2F%7Bchannelaccountid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/channel-accounts/{channelAccountId}"},"summary":"Get a channel account by id","description":"Get a channel account by id","security":[{"bearerAuth":[]}]},"patch":{"tags":["Conversations Create Custom Channels Channel Accounts"],"parameters":[{"name":"channelAccountId","in":"path","description":"The id of the Channel Account","required":true,"schema":{"type":"number","example":""}},{"name":"channelId","in":"path","description":"The id of the Channel","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#patch-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fchannel-accounts%2F%7Bchannelaccountid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/channel-accounts/{channelAccountId}"},"summary":"Update a channel account","description":"Update a channel account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"authorized":{"type":"boolean","description":"Authorized","enum":[true,false]},"name":{"type":"string","description":"Name"}}},"example":{"authorized":"","name":""}}}}}},"/conversations/v3/custom-channels/{channelId}/channel-accounts":{"get":{"tags":["Conversations Create Custom Channels Channel Accounts"],"parameters":[{"name":"channelId","in":"path","description":"The id of the Channel","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"After","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"booleam","example":""}},{"name":"defaultPageLength","in":"query","description":"Default page length","schema":{"type":"number","example":""}},{"name":"deliveryIdentifierType","in":"query","description":"Delivery identifier Type","schema":{"type":"array","example":""}},{"name":"deliveryIdentifierValue","in":"query","description":"Delivery identifier value","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"Limit","schema":{"type":"number","example":""}},{"name":"short","in":"query","description":"Short","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#get-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fchannel-accounts%2F%7Bchannelaccountid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/channel-accounts"},"summary":"Query channel accounts","description":"Query channel accounts","security":[{"bearerAuth":[]}]},"post":{"tags":["Conversations Create Custom Channels Channel Accounts"],"parameters":[{"name":"channelId","in":"path","description":"The id of the Channel","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/create-custom-channels#post-%2Fconversations%2Fv3%2Fcustom-channels%2F%7Bchannelid%7D%2Fchannel-accounts","api_endpoint":"https://api.hubapi.com/conversations/v3/custom-channels/{channelId}/channel-accounts"},"summary":"Create a channel account","description":"Create a channel account","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"authorized":{"type":"boolean","description":"Authorized","enum":[true,false]},"deliveryIdentifier":{"type":"object","description":"Delivery identifier","properties":{}},"inboxId":{"type":"string","description":"Inbox Id"},"name":{"type":"string","description":"Name"}}},"example":{"authorized":"","deliveryIdentifier":{},"inboxId":"","name":""}}}}}},"/conversations/v3/conversations/actors/{actorId}":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"actorId","in":"path","description":"The unique ID of the actor.","required":true,"schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"Property","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Factors%2F%7Bactorid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/actors/{actorId}"},"summary":"Get a single actor","description":"Get a single actor","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/channel-accounts/{channelAccountId}":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"channelAccountId","in":"path","description":"The unique ID of the channel account","required":true,"schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fchannel-accounts%2F%7Bchannelaccountid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/channel-accounts/{channelAccountId}"},"summary":"Get a single channel account","description":"Get a single channel account","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/channels/{channelId}":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"channelId","in":"path","description":"The unique ID of the channel","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fchannels%2F%7Bchannelid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/channels/{channelId}"},"summary":"Get a single channel","description":"Get a single channel","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/inboxes/{inboxId}":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"inboxId","in":"path","description":"The unique ID of the inbox","required":true,"schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Finboxes%2F%7Binboxid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/inboxes/{inboxId}"},"summary":"Get a single conversations inbox","description":"Get a single conversations inbox","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/threads/{threadId}/messages/{messageId}":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"messageId","in":"path","description":"The unique ID of the message","required":true,"schema":{"type":"number","example":""}},{"name":"threadId","in":"path","description":"The unique ID of the thread","required":true,"schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"Property","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fthreads%2F%7Bthreadid%7D%2Fmessages%2F%7Bmessageid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}/messages/{messageId}"},"summary":"Get a single message","description":"Get a single message","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/threads/{threadId}":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"threadId","in":"path","description":"The unique ID of the thread","required":true,"schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"association","in":"query","description":"ou can specify an association type here of TICKET","schema":{"type":"enum","example":""}},{"name":"property","in":"query","description":"Property","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fthreads%2F%7Bthreadid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}"},"summary":"Get a single thread","description":"Get a single thread","security":[{"bearerAuth":[]}]},"patch":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"thredId","in":"path","description":"The unique ID of the thred","required":true,"schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether the thread to update is archived. Default is false. A thread's status property can not be updated if the thread is archived.","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#patch-%2Fconversations%2Fv3%2Fconversations%2Fthreads%2F%7Bthreadid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}"},"summary":"Update a thread","description":"Update a thread","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archived":{"type":"boolean","description":"Whether this thread is archived. Set to false to restore the thread","enum":[true,false]},"status":{"type":"enum","description":"The thread's status: OPEN or CLOSED","enum":["OPEN","CLOSED"]}}},"example":{"archived":"","status":""}}}}},"delete":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"thredId","in":"path","description":"The unique ID of the thred","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#delete-%2Fconversations%2Fv3%2Fconversations%2Fthreads%2F%7Bthreadid%7D","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}"},"summary":"Archives a thread","description":"Archives a thread","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/conversations/v3/conversations/channel-accounts":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"number","example":""}},{"name":"channelId","in":"query","description":"Limits results to channel accounts within a particular channel","schema":{"type":"number","example":""}},{"name":"defaultPageLength","in":"query","description":"defaultPageLength","schema":{"type":"number","example":""}},{"name":"inboxId","in":"query","description":"Limits results to channel accounts within a particular inbox.","schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fchannel-accounts","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/channel-accounts"},"summary":"Get channel accounts","description":"Get channel accounts","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/channels":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"number","example":""}},{"name":"defaultPageLength","in":"query","description":"defaultPageLength","schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fchannels","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/channels"},"summary":"Get channels","description":"Get channels","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/inboxes":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"defaultPageLength","in":"query","description":"defaultPageLength","schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Finboxes","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/inboxes"},"summary":"Get conversations inboxes","description":"Get conversations inboxes","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/threads/{threadId}/messages":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"threadId","in":"path","description":"The unique ID of the thread","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"property","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"sort","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fthreads%2F%7Bthreadid%7D%2Fmessages","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}/messages"},"summary":"Get message history for a thread","description":"Get message history for a thread","security":[{"bearerAuth":[]}]},"post":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"thredId","in":"path","description":"The unique ID of the thred","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#post-%2Fconversations%2Fv3%2Fconversations%2Fthreads%2F%7Bthreadid%7D%2Fmessages","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}/messages"},"summary":"Send a message to a thread","description":"Send a message to a thread","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"text":{"type":"string","description":"text"},"type":{"type":"enum","description":"type","enum":["MESSAGE"]},"attachments":{"type":"array","description":"attachments","items":{"type":"string"}},"channelAccountId":{"type":"string","description":"channelAccountId"},"channelId":{"type":"string","description":"channelId"},"recipients":{"type":"array","description":"recipients","items":{"type":"string"}},"richText":{"type":"string","description":"richText"},"senderActorId":{"type":"string","description":"senderActorId"},"subject":{"type":"string","description":"subject"}}},"example":{"text":"","type":"","attachments":[],"channelAccountId":"","channelId":"","recipients":[],"richText":"","senderActorId":"","subject":""}}}}}},"/conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"messageId","in":"path","description":"The unique ID of the message","required":true,"schema":{"type":"string","example":""}},{"name":"threadId","in":"path","description":"The unique ID of the thread","required":true,"schema":{"type":"number","example":""}},{"name":"property","in":"query","description":"property","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fthreads%2F%7Bthreadid%7D%2Fmessages%2F%7Bmessageid%7D%2Foriginal-content","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads/{threadId}/messages/{messageId}/original-content"},"summary":"Get the original content of a single message","description":"Get the original content of a single message","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/threads":{"get":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"messageId","in":"path","description":"The unique ID of the message","required":true,"schema":{"type":"string","example":""}},{"name":"threadId","in":"path","description":"The unique ID of the thread","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associatedContactId","in":"query","description":"The ID of a contact you can optionally include to retrieve a filtered list of conversations for","schema":{"type":"number","example":""}},{"name":"association","in":"query","description":"You can specify an association type here of TICKET","schema":{"type":"enum","example":"","items":{"type":"string","enum":["TICKET"]}}},{"name":"inboxId","in":"query","description":"Limits results to channel accounts within a particular inbox.","schema":{"type":"number","example":""}},{"name":"latestMessageTimestampAfter","in":"query","description":"The minimum latestMessageTimestamp","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"Set the sort order of the response","schema":{"type":"number","example":""}},{"name":"threadStatus","in":"query","description":"The status of the associated conversations to filter by (either OPEN or CLOSED)","schema":{"type":"enum","example":"","items":{"type":"string","enum":["OPEN","CLOSED"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#get-%2Fconversations%2Fv3%2Fconversations%2Fthreads","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/threads"},"summary":"Get threads","description":"Get threads","security":[{"bearerAuth":[]}]}},"/conversations/v3/conversations/actors/batch/read":{"post":{"tags":["Conversations Inbox And Messages Conversations"],"parameters":[{"name":"property","in":"query","description":"property","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/inbox-and-messages#post-%2Fconversations%2Fv3%2Fconversations%2Factors%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/conversations/v3/conversations/actors/batch/read"},"summary":"Get actors","description":"Get actors","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/visitor-identification/v3/tokens/create":{"post":{"tags":["Conversations Visitor Identification Generate"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/conversations/visitor-identification#post-%2Fvisitor-identification%2Fv3%2Ftokens%2Fcreate","api_endpoint":"https://api.hubapi.com/visitor-identification/v3/tokens/create"},"summary":"Generate a token","description":"Generate a token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The email of the visitor that you wish to identify","required":true},"firstName":{"type":"string","description":"The first name of the visitor that you wish to identifT"},"lastName":{"type":"string","description":"The last name of the visitor that you wish to identify"}}},"example":{"email":"","firstName":"","lastName":""}}}}}},"/account-info/v3/activity/audit-logs":{"get":{"tags":["Settings Account Activity Activity"],"parameters":[{"name":"actingUserId","in":"query","description":"actingUserId","schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"occurredAfter","in":"query","description":"occurredAfter","schema":{"type":"number","example":""}},{"name":"occurredBefore","in":"query","description":"occurredBefore","schema":{"type":"string","example":""}},{"name":"short","in":"query","description":"Short","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/account-activity-api#get-%2Faccount-info%2Fv3%2Factivity%2Faudit-logs","api_endpoint":"https://api.hubapi.com/account-info/v3/activity/audit-logs"},"summary":"/account-info/v3/activity/audit-logs","description":"/account-info/v3/activity/audit-logs","security":[{"bearerAuth":[]}]}},"/account-info/v3/activity/login":{"get":{"tags":["Settings Account Activity Activity"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"userId","in":"query","description":"Identifier of user to retrieve activities fo","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/account-activity-api#get-%2Faccount-info%2Fv3%2Factivity%2Flogin","api_endpoint":"https://api.hubapi.com/account-info/v3/activity/login"},"summary":"Get login activity for a HubSpot account","description":"Get login activity for a HubSpot account","security":[{"bearerAuth":[]}]}},"/account-info/v3/activity/security":{"get":{"tags":["Settings Account Activity Activity"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"fromTimestamp","in":"query","description":"Limit to activities created after this epoch timestamp","schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"toTimestamp","in":"query","description":"Limit to activities created after this epoch timestamp","schema":{"type":"number","example":""}},{"name":"userId","in":"query","description":"Identifier of user to retrieve activities fo","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/account-activity-api#get-%2Faccount-info%2Fv3%2Factivity%2Fsecurity","api_endpoint":"https://api.hubapi.com/account-info/v3/activity/security"},"summary":"Get security activity for a HubSpot account","description":"Get security activity for a HubSpot account","security":[{"bearerAuth":[]}]}},"/account-info/v3/api-usage/daily/private-apps":{"get":{"tags":["Settings Account Information Usage"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/account-information-api#get-%2Faccount-info%2Fv3%2Fapi-usage%2Fdaily%2Fprivate-apps","api_endpoint":"https://api.hubapi.com/account-info/v3/api-usage/daily/private-apps"},"summary":"Get the daily API usage of Private Apps and limits for a HubSpot account","description":"Get the daily API usage of Private Apps and limits for a HubSpot account","security":[{"bearerAuth":[]}]}},"/account-info/v3/details":{"get":{"tags":["Settings Account Information Details"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/account-information-api#get-%2Faccount-info%2Fv3%2Fdetails","api_endpoint":"https://api.hubapi.com/account-info/v3/details"},"summary":"Get account details for a HubSpot account","description":"Get account details for a HubSpot account","security":[{"bearerAuth":[]}]}},"/business-units/v3/business-units/user/{userId}":{"get":{"tags":["Settings Business Units"],"parameters":[{"name":"userId","in":"path","description":"Identifier of user to retrieve","required":true,"schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"The names of Business Units to retrieve","schema":{"type":"array","example":""}},{"name":"properties","in":"query","description":"The names of properties to optionally include in the response body. The only valid value is logoMetadata","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/business-units-api#get-%2Fbusiness-units%2Fv3%2Fbusiness-units%2Fuser%2F%7Buserid%7D","api_endpoint":"https://api.hubapi.com/business-units/v3/business-units/user/{userId}"},"summary":"Get Business Units for a user","description":"Get Business Units for a user","security":[{"bearerAuth":[]}]}},"/settings/v3/currencies/codes":{"get":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#get-%2Fsettings%2Fv3%2Fcurrencies%2Fcodes","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/codes"},"summary":"/settings/v3/currencies/codes","description":"/settings/v3/currencies/codes","security":[{"bearerAuth":[]}]}},"/settings/v3/currencies/company-currency":{"get":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#get-%2Fsettings%2Fv3%2Fcurrencies%2Fcompany-currency","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/company-currency"},"summary":"/settings/v3/currencies/company-currency","description":"/settings/v3/currencies/company-currency","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#put-%2Fsettings%2Fv3%2Fcurrencies%2Fcompany-currency","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/company-currency"},"summary":"/settings/v3/currencies/company-currency","description":"/settings/v3/currencies/company-currency","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"currencyCode":{"type":"string","description":"currencyCode"}}},"example":{"currencyCode":""}}}}}},"/settings/v3/currencies/exchange-rates/current":{"get":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#get-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates%2Fcurrent","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates/current"},"summary":"/settings/v3/currencies/exchange-rates/current","description":"/settings/v3/currencies/exchange-rates/current","security":[{"bearerAuth":[]}]}},"/settings/v3/currencies/exchange-rates":{"post":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#post-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates"},"summary":"/settings/v3/currencies/exchange-rates","description":"/settings/v3/currencies/exchange-rates","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"conversionRate":{"type":"string","description":"conversionRate"},"effectiveAt":{"type":"number","description":"effectiveAt"},"fromCurrencyCode":{"type":"string","description":"fromCurrencyCode"}}},"example":{"conversionRate":"","effectiveAt":"","fromCurrencyCode":""}}}}}},"/settings/v3/currencies/exchange-rates/batch/create":{"post":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#post-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates/batch/create"},"summary":"/settings/v3/currencies/exchange-rates/batch/create","description":"/settings/v3/currencies/exchange-rates/batch/create","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/settings/v3/currencies/exchange-rates/batch/read":{"post":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#post-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates/batch/read"},"summary":"/settings/v3/currencies/exchange-rates/batch/read","description":"/settings/v3/currencies/exchange-rates/batch/read","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/settings/v3/currencies/exchange-rates/batch/update":{"post":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#post-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates/batch/update"},"summary":"/settings/v3/currencies/exchange-rates/batch/update","description":"/settings/v3/currencies/exchange-rates/batch/update","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/settings/v3/currencies/exchange-rates/update-visibility":{"post":{"tags":["Settings Currencies Currency"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#post-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates%2Fupdate-visibility","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates/update-visibility"},"summary":"/settings/v3/currencies/exchange-rates/update-visibility","description":"/settings/v3/currencies/exchange-rates/update-visibility","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"fromCurrencyCode":{"type":"string","description":"fromCurrencyCode"},"toCurrencyCode":{"type":"string","description":"toCurrencyCode"},"visibleInUI":{"type":"boolean","description":"visibleInUI","enum":[true,false]}}},"example":{"fromCurrencyCode":"","toCurrencyCode":"","visibleInUI":""}}}}}},"/settings/v3/currencies/exchange-rates/{exchangeRateId}":{"put":{"tags":["Settings Currencies Currency"],"parameters":[{"name":"exchangeRateId","in":"path","description":"The unique ID of the exchangerate","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#patch-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates%2F%7Bexchangerateid%7D","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates/{exchangeRateId}"},"summary":"/settings/v3/currencies/exchange-rates/{exchangeRateId}","description":"/settings/v3/currencies/exchange-rates/{exchangeRateId}","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"currencyCode":{"type":"string","description":"currencyCode"}}},"example":{"currencyCode":""}}}}},"get":{"tags":["Settings Currencies Currency"],"parameters":[{"name":"exchangeRateId","in":"path","description":"exchangeRateId","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/currencies#get-%2Fsettings%2Fv3%2Fcurrencies%2Fexchange-rates%2F%7Bexchangerateid%7D","api_endpoint":"https://api.hubapi.com/settings/v3/currencies/exchange-rates/{exchangeRateId}"},"summary":"/settings/v3/currencies/exchange-rates/{exchangeRateId}","description":"/settings/v3/currencies/exchange-rates/{exchangeRateId}","security":[{"bearerAuth":[]}]}},"/crm/v3/objects/users/batch/read":{"get":{"tags":["Settings Users User Details Batch"],"parameters":[{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-details#post-%2Fcrm%2Fv3%2Fobjects%2Fusers%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/crm/v3/objects/users/batch/read"},"summary":"Read a batch of users by internal ID, or unique property values","description":"Read a batch of users by internal ID, or unique property values","security":[{"bearerAuth":[]}]}},"/crm/v3/objects/users":{"get":{"tags":["Settings Users User Details Basic"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"number","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-details#get-%2Fcrm%2Fv3%2Fobjects%2Fusers","api_endpoint":"https://api.hubapi.com/crm/v3/objects/users"},"summary":"List","description":"List","security":[{"bearerAuth":[]}]}},"/crm/v3/objects/users/{userId}":{"get":{"tags":["Settings Users User Details Basic"],"parameters":[{"name":"userId","in":"path","description":"The unique ID of the user","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"array","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-details#get-%2Fcrm%2Fv3%2Fobjects%2Fusers%2F%7Buserid%7D","api_endpoint":"https://api.hubapi.com/crm/v3/objects/users/{userId}"},"summary":"Read","description":"Read","security":[{"bearerAuth":[]}]}},"/crm/v3/objects/users/search":{"post":{"tags":["Settings Users User Details Search"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-details#post-%2Fcrm%2Fv3%2Fobjects%2Fusers%2Fsearch","api_endpoint":"https://api.hubapi.com/crm/v3/objects/users/search"},"summary":"/crm/v3/objects/users/search","description":"/crm/v3/objects/users/search","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after":{"type":"number","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results"},"filterGroups":{"type":"array","description":"filterGroups","items":{"type":"string"}},"limit":{"type":"number","description":"The maximum number of results to display per page"},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"query":{"type":"string","description":"query"},"sorts":{"type":"array","description":"sorts","items":{"type":"string"}}}},"example":{"after":"","filterGroups":[],"limit":"","properties":[],"query":"","sorts":[]}}}}}},"/settings/v3/users/teams":{"get":{"tags":["Settings Users User Provisioning Teams"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-provisioning#get-%2Fsettings%2Fv3%2Fusers%2Fteams","api_endpoint":"https://api.hubapi.com/settings/v3/users/teams"},"summary":"See details about this account's teams","description":"See details about this account's teams","security":[{"bearerAuth":[]}]}},"/settings/v3/users/roles":{"get":{"tags":["Settings Users User Provisioning Roles"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-provisioning#get-%2Fsettings%2Fv3%2Fusers%2Froles","api_endpoint":"https://api.hubapi.com/settings/v3/users/roles"},"summary":"Retrieves the roles on an account","description":"Retrieves the roles on an account","security":[{"bearerAuth":[]}]}},"/settings/v3/users":{"get":{"tags":["Settings Users User Provisioning Users"],"parameters":[{"name":"after","in":"query","description":"Results will display maximum 100 users per page. Additional results will be on the next page.","schema":{"type":"number","example":""}},{"name":"limit","in":"query","description":"The number of users to retrieve","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-provisioning#get-%2Fsettings%2Fv3%2Fusers%2F","api_endpoint":"https://api.hubapi.com/settings/v3/users"},"summary":"Retrieves a list of users from an account","description":"Retrieves a list of users from an account","security":[{"bearerAuth":[]}]},"post":{"tags":["Settings Users User Provisioning Users"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-provisioning#post-%2Fsettings%2Fv3%2Fusers%2F","api_endpoint":"https://api.hubapi.com/settings/v3/users"},"summary":"Adds a user","description":"Adds a user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"email":{"type":"string","description":"The created user's email"},"firstName":{"type":"string","description":"firstName"},"lastName":{"type":"string","description":"TlastName"},"primaryTeamId":{"type":"number","description":"The user's primary team"},"roleId":{"type":"number","description":"roleId"},"secondaryTeamIds":{"type":"number","description":"secondaryTeamIds"},"sendWelcomeEmail":{"type":"boolean","description":"sendWelcomeEmail","enum":[true,false]}}},"example":{"email":"","firstName":"","lastName":"","primaryTeamId":"","roleId":"","secondaryTeamIds":"","sendWelcomeEmail":""}}}}}},"/settings/v3/users/{userId}":{"get":{"tags":["Settings Users User Provisioning Users"],"parameters":[{"name":"userId","in":"path","description":"Identifier of user to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"The name of a property with unique user values. Valid values are USER_ID(default) or EMAIL","schema":{"type":"enum","example":"","items":{"type":"string","enum":["USER_ID","EMAIL"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-provisioning#get-%2Fsettings%2Fv3%2Fusers%2F%7Buserid%7D","api_endpoint":"https://api.hubapi.com/settings/v3/users/{userId}"},"summary":"Retrieves a user","description":"Retrieves a user","security":[{"bearerAuth":[]}]},"put":{"tags":["Settings Users User Provisioning Users"],"parameters":[{"name":"userId","in":"path","description":"Identifier of user to retrieve","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-provisioning#put-%2Fsettings%2Fv3%2Fusers%2F%7Buserid%7D","api_endpoint":"https://api.hubapi.com/settings/v3/users/{userId}"},"summary":"Modifies a user","description":"Modifies a user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"firstName":{"type":"string","description":"firstName"},"lastName":{"type":"string","description":"TlastName"},"primaryTeamId":{"type":"number","description":"The user's primary team"},"sendWelcomeEmail":{"type":"boolean","description":"sendWelcomeEmail","enum":[true,false]}}},"example":{"firstName":"","lastName":"","primaryTeamId":"","sendWelcomeEmail":""}}}}},"delete":{"tags":["Settings Users User Provisioning Users"],"parameters":[{"name":"userId","in":"path","description":"Identifier of user to retrieve","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"he name of a property with unique user values.","schema":{"type":"enum","example":"","items":{"type":"string","enum":["USER_ID","EMAIL"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/settings/users/user-provisioning#delete-%2Fsettings%2Fv3%2Fusers%2F%7Buserid%7D","api_endpoint":"https://api.hubapi.com/settings/v3/users/{userId}"},"summary":"Removes a user","description":"Removes a user","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/files/v3/files/stat/{path}":{"get":{"tags":["Library Files Files"],"parameters":[{"name":"path","in":"path","description":"path","required":true,"schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"properties","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffiles%2Fstat%2F%7Bpath%7D","api_endpoint":"https://api.hubapi.com/files/v3/files/stat/{path}"},"summary":"/files/v3/files/stat/{path}","description":"/files/v3/files/stat/{path}","security":[{"bearerAuth":[]}]}},"/files/v3/files/import-from-url/async/tasks/{taskId}/status":{"get":{"tags":["Library Files Files"],"parameters":[{"name":"taskId","in":"path","description":"Import by URL task ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffiles%2Fimport-from-url%2Fasync%2Ftasks%2F%7Btaskid%7D%2Fstatus","api_endpoint":"https://api.hubapi.com/files/v3/files/import-from-url/async/tasks/{taskId}/status"},"summary":"Check import status","description":"Check import status","security":[{"bearerAuth":[]}]}},"/files/v3/files/{fileId}":{"get":{"tags":["Library Files Files"],"parameters":[{"name":"fileId","in":"path","description":"ID of the desired file","required":true,"schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"properties","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffiles%2F%7Bfileid%7D","api_endpoint":"https://api.hubapi.com/files/v3/files/{fileId}"},"summary":"Get file","description":"Get file","security":[{"bearerAuth":[]}]},"put":{"tags":["Library Files Files"],"parameters":[{"name":"fileId","in":"path","description":"ID of the desired file","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#put-%2Ffiles%2Fv3%2Ffiles%2F%7Bfileid%7D","api_endpoint":"https://api.hubapi.com/files/v3/files/{fileId}"},"summary":"Replace file","description":"Replace file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"charsetHunch":{"type":"string","description":"ICharacter set of given file data"},"file":{"type":"string","format":"binary","description":"File to be uploaded."},"options":{"type":"string","description":"JSON string representing FileUploadOptions"}}},"example":{"charsetHunch":"","file":"(binary)","options":""}}}}},"patch":{"tags":["Library Files Files"],"parameters":[{"name":"fileId","in":"path","description":"ID of the desired file","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#patch-%2Ffiles%2Fv3%2Ffiles%2F%7Bfileid%7D","api_endpoint":"https://api.hubapi.com/files/v3/files/{fileId}"},"summary":"Update file properties","description":"Update file properties","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"access":{"type":"enum","description":"PUBLIC_INDEXABLE: File is publicly accessible by anyone who has the URL","required":true,"enum":["PUBLIC_INDEXABLE","PUBLIC_NOT_INDEXABLE","HIDDEN_INDEXABLE","HIDDEN_NOT_INDEXABLE","HIDDEN_PRIVATE","PRIVATE"]},"name":{"type":"string","description":"New name for the file."},"parentFolderId":{"type":"number","description":"FolderId where the file should be moved to"}}},"example":{"access":"","name":"","parentFolderId":""}}}}},"delete":{"tags":["Library Files Files"],"parameters":[{"name":"fileId","in":"path","description":"FileId to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#delete-%2Ffiles%2Fv3%2Ffiles%2F%7Bfileid%7D","api_endpoint":"https://api.hubapi.com/files/v3/files/{fileId}"},"summary":"Delete file","description":"Delete file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/files/v3/files/{fileId}/signed-url":{"get":{"tags":["Library Files Files"],"parameters":[{"name":"fileId","in":"path","description":"ID of file","required":true,"schema":{"type":"string","example":""}},{"name":"expirationSeconds","in":"query","description":"How long in seconds the link will provide access to the file","schema":{"type":"number","example":""}},{"name":"size","in":"query","description":"For image files. This will resize the image to the desired size before sharing","schema":{"type":"number","example":""}},{"name":"upscale","in":"query","description":"If size is provided, this will upscale the image to fit the size dimensions","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffiles%2F%7Bfileid%7D%2Fsigned-url","api_endpoint":"https://api.hubapi.com/files/v3/files/{fileId}/signed-url"},"summary":"Get signed URL to access private file","description":"Get signed URL to access private file","security":[{"bearerAuth":[]}]}},"/files/v3/files/search":{"get":{"tags":["Library Files Files"],"parameters":[{"name":"type","in":"query","description":"Filter by provided file type","schema":{"type":"string","example":""}},{"name":"path","in":"query","description":"Search files within given folderId","schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The maximum offset of items for a given search is 10000. Narrow your search down if you are reaching this limit.","schema":{"type":"string","example":""}},{"name":"allowsAnonymousAccess","in":"query","description":"If 'true' will show private files; if 'false' will show public files","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"before","in":"query","description":"Before","schema":{"type":"string","example":""}},{"name":"createdAt","in":"query","description":"Search files by time of creation","schema":{"type":"string","example":""}},{"name":"createdAtGet","in":"query","description":"createdAtGet","schema":{"type":"string","example":""}},{"name":"createdAtLte","in":"query","description":"createdAtLte","schema":{"type":"string","example":""}},{"name":"encoding","in":"query","description":"Search files with specified encoding","schema":{"type":"strign","example":""}},{"name":"extension","in":"query","description":"Search files by given extension.","schema":{"type":"string","example":""}},{"name":"height","in":"query","description":"Search files by height of image or video","schema":{"type":"number","example":""}},{"name":"id","in":"query","description":"Search files by given ID.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Number of items to return.","schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"Search for files containing the given name","schema":{"type":"string","example":""}},{"name":"parentFolderId","in":"query","description":"Search files by path","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"Desired file properties in the return object","schema":{"type":"array","example":""}},{"name":"sUsableInContent","in":"query","description":"If true shows files that have been marked to be used in new content","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"size","in":"query","description":"Query by file size","schema":{"type":"number","example":""}},{"name":"sort","in":"query","description":"Sort files by a given field.","schema":{"type":"enum","example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAt","in":"query","description":"Search files by time of latest updated","schema":{"type":"string","example":""}},{"name":"updatedGet","in":"query","description":"updatedGet","schema":{"type":"string","example":""}},{"name":"updatedLet","in":"query","description":"updatedLet","schema":{"type":"string","example":""}},{"name":"url","in":"query","description":"Search for given URL","schema":{"type":"string","example":""}},{"name":"width","in":"query","description":"Search files by width of image or video","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffiles%2Fsearch","api_endpoint":"https://api.hubapi.com/files/v3/files/search"},"summary":"Search files","description":"Search files","security":[{"bearerAuth":[]}]}},"/files/v3/files/import-from-url/async":{"post":{"tags":["Library Files Files"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#post-%2Ffiles%2Fv3%2Ffiles%2Fimport-from-url%2Fasync","api_endpoint":"https://api.hubapi.com/files/v3/files/import-from-url/async"},"summary":"Import a file from a URL into the file manager","description":"Import a file from a URL into the file manager","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"access":{"type":"enum","description":"PUBLIC_INDEXABLE: File is publicly accessible by anyone who has the URL","required":true,"enum":["PUBLIC_INDEXABLE","PUBLIC_NOT_INDEXABLE","HIDDEN_INDEXABLE","HIDDEN_NOT_INDEXABLE","HIDDEN_PRIVATE","PRIVATE"]},"duplicateValidationScope":{"type":"enum","description":"","enum":["ENTIRE_PORTAL","EXACT_FOLDER"]},"duplicateValidationStrategy":{"type":"enum","description":"ENTIRE_PORTAL: Look for a duplicate file in the entire account.","enum":["NONE","REJECT","RETURN_EXISTING"]},"folderId":{"type":"string","description":"One of folderId or folderPath is required"},"folderPath":{"type":"string","description":"One of folderPath or folderId is required."},"name":{"type":"string","description":"Name to give the resulting file in the file manager"},"overwrite":{"type":"boolean","description":"If true, will overwrite existing file if one with the same name and extension exists in the given folder","enum":[true,false]},"ttl":{"type":"string","description":"Time to live."},"url":{"type":"string","description":"URL to download the new file from","required":true}}},"example":{"access":"","duplicateValidationScope":"","duplicateValidationStrategy":"","folderId":"","folderPath":"","name":"","overwrite":"","ttl":"","url":""}}}}}},"/files/v3/files":{"post":{"tags":["Library Files Files"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#post-%2Ffiles%2Fv3%2Ffiles","api_endpoint":"https://api.hubapi.com/files/v3/files"},"summary":"Upload file","description":"Upload file","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":false,"content":{"multipart/form-data":{"schema":{"type":"object","required":[],"properties":{"charsetHunch":{"type":"string","description":"Character set of the uploaded file"},"file":{"type":"string","format":"binary","description":"File to be uploaded."},"fileName":{"type":"string","description":"Desired name for the uploaded file."},"folderId":{"type":"string","description":"Either 'folderId' or 'folderPath' is required. folderId is the ID of the folder the file will be uploaded to."},"folderPath":{"type":"string","description":"Either 'folderPath' or 'folderId' is required. This field represents the destination folder path for the uploaded file. If a path doesn't exist, the system will try to create one."},"options":{"type":"string","description":"JSON string representing FileUploadOptions"},"overwrite":{"type":"boolean","description":"If true, will overwrite existing file if one with the same name and extension exists in the given folder","enum":[true,false]}}},"example":{"charsetHunch":"","file":"(binary)","fileName":"","folderId":"","folderPath":"","options":"","overwrite":""}}}}}},"/files/v3/files/{fileId}/gdpr-delete":{"delete":{"tags":["Library Files Files"],"parameters":[{"name":"fileId","in":"path","description":"ID of file to GDPR delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#delete-%2Ffiles%2Fv3%2Ffiles%2F%7Bfileid%7D%2Fgdpr-delete","api_endpoint":"https://api.hubapi.com/files/v3/files/{fileId}/gdpr-delete"},"summary":"GDPR delete","description":"GDPR delete","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/files/v3/folders/update/async/tasks/{taskId}/status":{"get":{"tags":["Library Files Folders"],"parameters":[{"name":"taskId","in":"path","description":"TaskId of folder update","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"","api_endpoint":"https://api.hubapi.com/files/v3/folders/update/async/tasks/{taskId}/status"},"summary":"Check folder update status","description":"Check folder update status","security":[{"bearerAuth":[]}]}},"/files/v3/folders/{folderId}":{"get":{"tags":["Library Files Folders"],"parameters":[{"name":"folderId","in":"path","description":"ID of desired folder","required":true,"schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"Properties to set on returned folder","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffolders%2F%7Bfolderid%7D","api_endpoint":"https://api.hubapi.com/files/v3/folders/{folderId}"},"summary":"Get folder","description":"Get folder","security":[{"bearerAuth":[]}]},"delete":{"tags":["Library Files Folders"],"parameters":[{"name":"folderId","in":"path","description":"ID of folder to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#delete-%2Ffiles%2Fv3%2Ffolders%2F%7Bfolderid%7D","api_endpoint":"https://api.hubapi.com/files/v3/folders/{folderId}"},"summary":"Delete folder by ID","description":"Delete folder by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/files/v3/folders/{folderPath}":{"get":{"tags":["Library Files Folders"],"parameters":[{"name":"folderPath","in":"path","description":"Path of desired folder","required":true,"schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"Properties to set on returned folder","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffolders%2F%7Bfolderpath%7D","api_endpoint":"https://api.hubapi.com/files/v3/folders/{folderPath}"},"summary":"Get folder by path","description":"Get folder by path","security":[{"bearerAuth":[]}]},"delete":{"tags":["Library Files Folders"],"parameters":[{"name":"folderPath","in":"path","description":"Path of folder to delete","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#delete-%2Ffiles%2Fv3%2Ffolders%2F%7Bfolderpath%7D","api_endpoint":"https://api.hubapi.com/files/v3/folders/{folderPath}"},"summary":"Delete folder by path","description":"Delete folder by path","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/files/v3/folders/search":{"get":{"tags":["Library Files Folders"],"parameters":[{"name":"folderPath","in":"path","description":"Path of desired folder","required":true,"schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"Properties to set on returned folder","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#get-%2Ffiles%2Fv3%2Ffolders%2Fsearch","api_endpoint":"https://api.hubapi.com/files/v3/folders/search"},"summary":"Search folders","description":"Search folders","security":[{"bearerAuth":[]}]}},"/files/v3/folders":{"post":{"tags":["Library Files Folders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#post-%2Ffiles%2Fv3%2Ffolders","api_endpoint":"https://api.hubapi.com/files/v3/folders"},"summary":"Create folder","description":"Create folder","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"name":{"type":"number","description":"Desired name for the folder","required":true},"parentFolderId":{"type":"number","description":"FolderId of the parent of the created folder."},"parentFolderPath":{"type":"string","description":"Path of the parent of the created folder"}}},"example":{"name":"","parentFolderId":"","parentFolderPath":""}}}}}},"/files/v3/folders/update/async":{"post":{"tags":["Library Files Folders"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/library/files#post-%2Ffiles%2Fv3%2Ffolders%2Fupdate%2Fasync","api_endpoint":"https://api.hubapi.com/files/v3/folders/update/async"},"summary":"Update folder properties","description":"Update folder properties","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"id":{"type":"string","description":"ID of the folder to change","required":true},"name":{"type":"number","description":"New name"},"parentFolderId":{"type":"number","description":"New parent folderId. "}}},"example":{"id":"","name":"","parentFolderId":""}}}}}},"/marketing/v3/campaigns":{"get":{"tags":["Marketing Campaigns Search"],"parameters":[{"name":"after","in":"query","description":"A cursor for pagination. If provided, the results will start after the given cursor","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"name","in":"query","description":"A filter to return campaigns whose names contain the specified substring","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma-separated list of the properties to be returned in the response.","schema":{"type":"array","example":""}},{"name":"sort","in":"query","description":"The field by which to sort the results","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#get-%2Fmarketing%2Fv3%2Fcampaigns%2F","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns"},"summary":"Campaign search","description":"Campaign search","security":[{"bearerAuth":[]}]},"post":{"tags":["Marketing Campaigns Basic"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#post-%2Fmarketing%2Fv3%2Fcampaigns%2F","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns"},"summary":"Create a campaign","description":"Create a campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"array","description":"properties","items":{"type":"string"}}}},"example":{"properties":[]}}}}}},"/marketing/v3/campaigns/{campaignGuid}":{"get":{"tags":["Marketing Campaigns Basic"],"parameters":[{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma-separated list of the properties to be returned in the response.","schema":{"type":"array","example":""}},{"name":"startDate","in":"query","description":"Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#get-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}"},"summary":"Read a campaign","description":"Read a campaign","security":[{"bearerAuth":[]}]},"put":{"tags":["Marketing Campaigns Basic"],"parameters":[{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#patch-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}"},"summary":"Update campaign","description":"Update campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"array","description":"properties","items":{"type":"string"}}}},"example":{"properties":[]}}}}},"delete":{"tags":["Marketing Campaigns Basic"],"parameters":[{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#delete-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}"},"summary":"Delete campaign","description":"Delete campaign","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/campaigns/batch/create":{"post":{"tags":["Marketing Campaigns Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#post-%2Fmarketing%2Fv3%2Fcampaigns%2Fbatch%2Fcreate","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/batch/create"},"summary":"Create a batch of campaigns","description":"Create a batch of campaigns","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/campaigns/batch/archive":{"post":{"tags":["Marketing Campaigns Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#post-%2Fmarketing%2Fv3%2Fcampaigns%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/batch/archive"},"summary":"Delete a batch of campaigns","description":"Delete a batch of campaigns","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/campaigns/batch/read":{"post":{"tags":["Marketing Campaigns Batch"],"parameters":[{"name":"endDate","in":"query","description":"End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma-separated list of the properties to be returned in the response.","schema":{"type":"array","example":""}},{"name":"startDate","in":"query","description":"Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#post-%2Fmarketing%2Fv3%2Fcampaigns%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/batch/read"},"summary":"Read a batch of campaigns","description":"Read a batch of campaigns","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/campaigns/batch/update":{"post":{"tags":["Marketing Campaigns Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#post-%2Fmarketing%2Fv3%2Fcampaigns%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/batch/update"},"summary":"Update a batch of campaigns","description":"Update a batch of campaigns","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/campaigns/{campaignGuid}/reports/contacts/{contactType}":{"get":{"tags":["Marketing Campaigns Reports"],"parameters":[{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}},{"name":"contactType","in":"path","description":"The type of metric to filter the influenced contacts. Allowed values: contactFirstTouch, contactLastTouch, influencedContacts","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor for pagination. If provided, the results will start after the given cursor","schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"startDate","in":"query","description":"Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#get-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D%2Freports%2Fcontacts%2F%7Bcontacttype%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}/reports/contacts/{contactType}"},"summary":"Fetch contact IDs","description":"Fetch contact IDs","security":[{"bearerAuth":[]}]}},"/marketing/v3/campaigns/{campaignGuid}/reports/revenue":{"get":{"tags":["Marketing Campaigns Reports"],"parameters":[{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}},{"name":"attributionModel","in":"query","description":"Allowed values: LINEAR, FIRST_INTERACTION, LAST_INTERACTION, FULL_PATH, U_SHAPED, W_SHAPED, TIME_DECAY, J_SHAPED, INVERSE_J_SHAPED","schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#get-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D%2Freports%2Frevenue","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}/reports/revenue"},"summary":"Fetch revenue","description":"Fetch revenue","security":[{"bearerAuth":[]}]}},"/marketing/v3/campaigns/{campaignGuid}/reports/metrics":{"get":{"tags":["Marketing Campaigns Reports"],"parameters":[{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}},{"name":"startDate","in":"query","description":"Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#get-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D%2Freports%2Fmetrics","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}/reports/metrics"},"summary":"Get Campaign Metrics","description":"Get Campaign Metrics","security":[{"bearerAuth":[]}]}},"/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}":{"get":{"tags":["Marketing Campaigns Asset"],"parameters":[{"name":"assetType","in":"path","description":"The type of asset to fetch.","required":true,"schema":{"type":"string","example":""}},{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"A cursor for pagination. If provided, the results will start after the given cursor","schema":{"type":"string","example":""}},{"name":"endDate","in":"query","description":"End date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}},{"name":"startDate","in":"query","description":"Start date to fetch asset metrics, formatted as YYYY-MM-DD. This date is used to fetch the metrics associated with the assets for a specified period.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#get-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D%2Fassets%2F%7Bassettype%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}"},"summary":"List assets","description":"List assets","security":[{"bearerAuth":[]}]}},"/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}":{"put":{"tags":["Marketing Campaigns Asset"],"parameters":[{"name":"assetId","in":"path","description":"Id of the asset","required":true,"schema":{"type":"string","example":""}},{"name":"assetType","in":"path","description":"The type of asset to fetch.","required":true,"schema":{"type":"string","example":""}},{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#put-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D%2Fassets%2F%7Bassettype%7D%2F%7Bassetid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}"},"summary":"Add asset association","description":"Add asset association","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Marketing Campaigns Asset"],"parameters":[{"name":"assetId","in":"path","description":"Id of the asset","required":true,"schema":{"type":"string","example":""}},{"name":"assetType","in":"path","description":"The type of asset to fetch.","required":true,"schema":{"type":"string","example":""}},{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#delete-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D%2Fassets%2F%7Bassettype%7D%2F%7Bassetid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}"},"summary":"Remove asset association","description":"Remove asset association","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/campaigns/{campaignGuid}/budget/totals":{"get":{"tags":["Marketing Campaigns Budget"],"parameters":[{"name":"campaignGuid","in":"path","description":"Unique identifier for the campaign, formatted as a UUID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/campaigns#get-%2Fmarketing%2Fv3%2Fcampaigns%2F%7Bcampaignguid%7D%2Fbudget%2Ftotals","api_endpoint":"https://api.hubapi.com/marketing/v3/campaigns/{campaignGuid}/budget/totals"},"summary":"Read budget","description":"Read budget","security":[{"bearerAuth":[]}]}},"/marketing/v3/emails/statistics/histogram":{"get":{"tags":["Marketing Emails Marketing Emails Statistics"],"parameters":[{"name":"emailIds","in":"query","description":"Filter by email IDs. Only include statistics of emails with these IDs","schema":{"type":"array","example":""}},{"name":"endTimestamp","in":"query","description":"The end timestamp of the time span, in ISO8601 representation","schema":{"type":"string","example":""}},{"name":"interval","in":"query","description":"The interval to aggregate statistics for","schema":{"type":"string","example":""}},{"name":"startTimestamp","in":"query","description":"The start timestamp of the time span, in ISO8601 representation","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2Fstatistics%2Fhistogram","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/statistics/histogram"},"summary":"Get aggregated statistic intervals","description":"Get aggregated statistic intervals","security":[{"bearerAuth":[]}]}},"/marketing/v3/emails/statistics/list":{"get":{"tags":["Marketing Emails Marketing Emails Statistics"],"parameters":[{"name":"emailIds","in":"query","description":"Filter by email IDs. Only include statistics of emails with these IDs","schema":{"type":"array","example":""}},{"name":"endTimestamp","in":"query","description":"The end timestamp of the time span, in ISO8601 representation","schema":{"type":"string","example":""}},{"name":"property","in":"query","description":"Specifies which email properties should be returned","schema":{"type":"string","example":""}},{"name":"startTimestamp","in":"query","description":"The start timestamp of the time span, in ISO8601 representation","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2Fstatistics%2Flist","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/statistics/list"},"summary":"Get aggregated statistics","description":"Get aggregated statistics","security":[{"bearerAuth":[]}]}},"/marketing/v3/emails/{emailId}/revisions/{revisionId}":{"get":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The ID of a revision","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Frevisions%2F%7Brevisionid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/revisions/{revisionId}"},"summary":"Get a revision of a marketing email","description":"Get a revision of a marketing email","security":[{"bearerAuth":[]}]}},"/marketing/v3/emails":{"get":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"type","in":"query","description":"email types to be filtered by. Multiple types can be included. All emails will be returned if not present","schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Specifies whether to return archived emails","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"createdAfter","in":"query","description":"Only return emails last created after the specified time","schema":{"type":"string","example":""}},{"name":"createdAt","in":"query","description":"Only return emails last created at exactly the specified time","schema":{"type":"string","example":""}},{"name":"createdBefore","in":"query","description":"Only return emails last created before the specified time","schema":{"type":"string","example":""}},{"name":"includeStats","in":"query","description":"Include statistics with emails","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"includedProperties","in":"query","description":"workflowNames","schema":{"type":"array","example":""}},{"name":"isPublished","in":"query","description":"Filter by published/draft emails. All emails will be returned if not present","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"limit","in":"query","description":"Number of items to return.","schema":{"type":"number","example":""}},{"name":"marketingCampaignNames","in":"query","description":"marketingCampaignNames","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"sort","in":"query","description":"Sort emails by a given field.","schema":{"type":"enum","example":"","items":{"type":"string","enum":["name","createdAt","updatedAt","createdBy","updatedBy"]}}},{"name":"updatedAfter","in":"query","description":"Only return emails last updated after the specified time","schema":{"type":"string","example":""}},{"name":"updatedAt","in":"query","description":"Only return emails last updated at exactly the specified time","schema":{"type":"string","example":""}},{"name":"updatedBefore","in":"query","description":"Only return emails last updated before the specified time","schema":{"type":"string","example":""}},{"name":"workflowNames","in":"query","description":"workflowNames","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F","api_endpoint":"https://api.hubapi.com/marketing/v3/emails"},"summary":"Get all marketing emails for a HubSpot account","description":"Get all marketing emails for a HubSpot account","security":[{"bearerAuth":[]}]},"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2F","api_endpoint":"https://api.hubapi.com/marketing/v3/emails"},"summary":"Create a new marketing email","description":"Create a new marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cloneName":{"type":"string","description":"Name of the cloned email"},"id":{"type":"string","description":"ID of the email to be cloned"}}},"example":{"cloneName":"","id":""}}}}}},"/marketing/v3/emails/{emailId}/draft":{"get":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/draft"},"summary":"Get draft version of a marketing email","description":"Get draft version of a marketing email","security":[{"bearerAuth":[]}]},"patch":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#patch-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Fdraft","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/draft"},"summary":"Create or update draft version","description":"Create or update draft version","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"activeDomain":{"type":"string","description":"The active domain of the email"},"archived":{"type":"boolean","description":"Determines if the email is archived or not.","enum":[true,false]},"businessUnitId":{"type":"number","description":"businessUnitId"},"campaign":{"type":"string","description":"The ID of the campaign this email is associated to"},"content":{"type":"object","description":"Data structure representing the content of the email","properties":{}},"from":{"type":"object","description":"Data structure representing the from fields on the email","properties":{}},"jitterSendTime":{"type":"boolean","description":"jitterSendTime","enum":[true,false]},"language":{"type":"string","description":"language"},"name":{"type":"string","description":"The name of the email, as displayed on the email dashboard","required":true},"publishDate":{"type":"string","description":"The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails"},"rssData":{"type":"object","description":"RSS related data if it is a blog or rss email","properties":{}},"sendOnPublish":{"type":"boolean","description":"Determines whether the email will be sent immediately on publish.","enum":[true,false]},"state":{"type":"string","description":"The email state"},"subcategory":{"type":"string","description":"The email subcategory"},"subject":{"type":"string","description":"The subject of the email"},"subscriptionDetails":{"type":"object","description":"Data structure representing the subscription fields of the email","properties":{}},"testing":{"type":"object","description":"AB testing related data. This property is only returned for AB type emails","properties":{}},"to":{"type":"object","description":"Data structure representing the to fields of the email.","properties":{}},"webversion":{"type":"object","description":"webversion","properties":{}}}},"example":{"activeDomain":"","archived":"","businessUnitId":"","campaign":"","content":{},"from":{},"jitterSendTime":"","language":"","name":"","publishDate":"","rssData":{},"sendOnPublish":"","state":"","subcategory":"","subject":"","subscriptionDetails":{},"testing":{},"to":{},"webversion":{}}}}}}},"/marketing/v3/emails/{emailId}/revisions":{"get":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"after","in":"query","description":"The cursor token value to get the next set of results","schema":{"type":"string","example":""}},{"name":"before","in":"query","description":"The cursor token value to get the previous set of results","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to return","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Frevisions","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/revisions"},"summary":"Get revisions of a marketing email","description":"Get revisions of a marketing email","security":[{"bearerAuth":[]}]}},"/marketing/v3/emails/{emailId}":{"get":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"includeStats","in":"query","description":"Include statistics with emails","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"includedProperties","in":"query","description":"includedProperties","schema":{"type":"array","example":""}},{"name":"marketingCampaignNames","in":"query","description":"marketingCampaignNames","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"workflowNames","in":"query","description":"workflowNames","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}"},"summary":"Get the details of a specified marketing email","description":"Get the details of a specified marketing email","security":[{"bearerAuth":[]}]},"patch":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#patch-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}"},"summary":"Update a marketing email","description":"Update a marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"activeDomain":{"type":"string","description":"The active domain of the email"},"archived":{"type":"boolean","description":"Determines if the email is archived or not.","enum":[true,false]},"businessUnitId":{"type":"number","description":"businessUnitId"},"campaign":{"type":"string","description":"The ID of the campaign this email is associated to"},"content":{"type":"object","description":"Data structure representing the content of the email","properties":{}},"from":{"type":"object","description":"Data structure representing the from fields on the email","properties":{}},"jitterSendTime":{"type":"boolean","description":"jitterSendTime","enum":[true,false]},"language":{"type":"string","description":"language"},"name":{"type":"string","description":"The name of the email, as displayed on the email dashboard","required":true},"publishDate":{"type":"string","description":"The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails"},"rssData":{"type":"object","description":"RSS related data if it is a blog or rss email","properties":{}},"sendOnPublish":{"type":"boolean","description":"Determines whether the email will be sent immediately on publish.","enum":[true,false]},"state":{"type":"string","description":"The email state"},"subcategory":{"type":"string","description":"The email subcategory"},"subject":{"type":"string","description":"The subject of the email"},"subscriptionDetails":{"type":"object","description":"Data structure representing the subscription fields of the email","properties":{}},"testing":{"type":"object","description":"AB testing related data. This property is only returned for AB type emails","properties":{}},"to":{"type":"object","description":"Data structure representing the to fields of the email.","properties":{}},"webversion":{"type":"object","description":"webversion","properties":{}}}},"example":{"activeDomain":"","archived":"","businessUnitId":"","campaign":"","content":{},"from":{},"jitterSendTime":"","language":"","name":"","publishDate":"","rssData":{},"sendOnPublish":"","state":"","subcategory":"","subject":"","subscriptionDetails":{},"testing":{},"to":{},"webversion":{}}}}}},"delete":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#delete-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}"},"summary":"Delete a marketing email","description":"Delete a marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/emails/{emailId}/ab-test/get-variation":{"get":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#get-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Fab-test%2Fget-variation","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/ab-test/get-variation"},"summary":"Get the variation of a an A/B marketing email","description":"Get the variation of a an A/B marketing email","security":[{"bearerAuth":[]}]}},"/marketing/v3/emails/clone":{"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2Fclone","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/clone"},"summary":"Clone a marketing email","description":"Clone a marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"cloneName":{"type":"string","description":"Name of the cloned email"},"id":{"type":"string","description":"ID of the email to be cloned"}}},"example":{"cloneName":"","id":""}}}}}},"/marketing/v3/emails/ab-test/create-variation":{"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2Fab-test%2Fcreate-variation","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/ab-test/create-variation"},"summary":"Create an A/B test variation of a marketing email","description":"Create an A/B test variation of a marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contentId":{"type":"string","description":"ID of the object to test"},"variationName":{"type":"string","description":"variationName"}}},"example":{"contentId":"","variationName":""}}}}}},"/marketing/v3/emails/{emailId}/publish":{"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Fpublish","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/publish"},"summary":"Publish or send a marketing email","description":"Publish or send a marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/emails/{emailId}/draft/reset":{"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Fdraft%2Freset","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/draft/reset"},"summary":"Reset Draft","description":"Reset Draft","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/emails/{emailId}/revisions/{revisionId}/restore":{"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The ID of a revision","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/revisions/{revisionId}/restore"},"summary":"Restore a revision of a marketing email","description":"Restore a revision of a marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft":{"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}},{"name":"revisionId","in":"path","description":"The ID of a revision","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Frevisions%2F%7Brevisionid%7D%2Frestore-to-draft","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/revisions/{revisionId}/restore-to-draft"},"summary":"Restore a revision of a marketing email to DRAFT state","description":"Restore a revision of a marketing email to DRAFT state","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/emails/{emailId}/unpublish":{"post":{"tags":["Marketing Emails Marketing Emails Marketing Emails"],"parameters":[{"name":"emailId","in":"path","description":"The marketing email ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/marketing-emails#post-%2Fmarketing%2Fv3%2Femails%2F%7Bemailid%7D%2Funpublish","api_endpoint":"https://api.hubapi.com/marketing/v3/emails/{emailId}/unpublish"},"summary":"Unpublish or cancel a marketing email","description":"Unpublish or cancel a marketing email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v4/email/single-send":{"post":{"tags":["Marketing Emails Single Send API Single_Send"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/single-send-api#post-%2Fmarketing%2Fv4%2Femail%2Fsingle-send","api_endpoint":"https://api.hubapi.com/marketing/v4/email/single-send"},"summary":"/marketing/v4/email/single-send","description":"/marketing/v4/email/single-send","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contactProperties":{"type":"object","description":"The contactProperties field is a map of contact property values","properties":{}},"customProperties":{"type":"object","description":"The customProperties field is a map of property values.","properties":{}},"emailId":{"type":"number","description":"The content ID for the email, which can be found in email tool UI","required":true},"message":{"type":"object","description":"A JSON object containing anything you want to override","properties":{}}}},"example":{"contactProperties":{},"customProperties":{},"emailId":"","message":{}}}}}}},"/marketing/v3/transactional/single-email/send":{"post":{"tags":["Marketing Emails Transactional Emails Single Send"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/transactional-emails#post-%2Fmarketing%2Fv3%2Ftransactional%2Fsingle-email%2Fsend","api_endpoint":"https://api.hubapi.com/marketing/v3/transactional/single-email/send"},"summary":"Send a single transactional email asynchronously","description":"Send a single transactional email asynchronously","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"contactProperties":{"type":"object","description":"The contactProperties field is a map of contact property values","properties":{}},"emailId":{"type":"number","description":"The content ID for the email, which can be found in email tool UI","required":true},"message":{"type":"object","description":"A JSON object containing anything you want to override","properties":{}}}},"example":{"contactProperties":{},"emailId":"","message":{}}}}}}},"/marketing/v3/transactional/smtp-tokens/{tokenId}":{"get":{"tags":["Marketing Emails Transactional Emails Public SMTP Tokens"],"parameters":[{"name":"tokenId","in":"path","description":"Identifier generated when a token is created","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/transactional-emails#get-%2Fmarketing%2Fv3%2Ftransactional%2Fsmtp-tokens%2F%7Btokenid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/transactional/smtp-tokens/{tokenId}"},"summary":"Query a single token by ID","description":"Query a single token by ID","security":[{"bearerAuth":[]}]},"delete":{"tags":["Marketing Emails Transactional Emails Public SMTP Tokens"],"parameters":[{"name":"tokenId","in":"path","description":"Identifier generated when a token is created","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/transactional-emails#delete-%2Fmarketing%2Fv3%2Ftransactional%2Fsmtp-tokens%2F%7Btokenid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/transactional/smtp-tokens/{tokenId}"},"summary":"Delete a single token by ID","description":"Delete a single token by ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/transactional/smtp-tokens":{"get":{"tags":["Marketing Emails Transactional Emails Public SMTP Tokens"],"parameters":[{"name":"after","in":"query","description":"Starting point to get the next set of results.","schema":{"type":"string","example":""}},{"name":"campaignName","in":"query","description":"A name for the campaign tied to the SMTP API token","schema":{"type":"string","example":""}},{"name":"emailCampaignId","in":"query","description":"Identifier assigned to the campaign provided during the token creation","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of tokens to return","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/transactional-emails#get-%2Fmarketing%2Fv3%2Ftransactional%2Fsmtp-tokens","api_endpoint":"https://api.hubapi.com/marketing/v3/transactional/smtp-tokens"},"summary":"Query SMTP API tokens by campaign name or an emailCampaignId","description":"Query SMTP API tokens by campaign name or an emailCampaignId","security":[{"bearerAuth":[]}]},"post":{"tags":["Marketing Emails Transactional Emails Public SMTP Tokens"],"parameters":[{"name":"after","in":"query","description":"Starting point to get the next set of results.","schema":{"type":"string","example":""}},{"name":"campaignName","in":"query","description":"A name for the campaign tied to the SMTP API token","schema":{"type":"string","example":""}},{"name":"emailCampaignId","in":"query","description":"Identifier assigned to the campaign provided during the token creation","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of tokens to return","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/transactional-emails#post-%2Fmarketing%2Fv3%2Ftransactional%2Fsmtp-tokens","api_endpoint":"https://api.hubapi.com/marketing/v3/transactional/smtp-tokens"},"summary":"Create a SMTP API token","description":"Create a SMTP API token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"campaignName":{"type":"string","description":"A name for the campaign tied to the SMTP API token"},"createContact":{"type":"boolean","description":"Indicates whether a contact should be created for email recipients","enum":[true,false]}}},"example":{"campaignName":"","createContact":""}}}}}},"/marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset":{"post":{"tags":["Marketing Emails Transactional Emails Public SMTP Tokens"],"parameters":[{"name":"tokenId","in":"path","description":"Identifier generated when a token is created","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"Starting point to get the next set of results.","schema":{"type":"string","example":""}},{"name":"campaignName","in":"query","description":"A name for the campaign tied to the SMTP API token","schema":{"type":"string","example":""}},{"name":"emailCampaignId","in":"query","description":"Identifier assigned to the campaign provided during the token creation","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"Maximum number of tokens to return","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/emails/transactional-emails#post-%2Fmarketing%2Fv3%2Ftransactional%2Fsmtp-tokens%2F%7Btokenid%7D%2Fpassword-reset","api_endpoint":"https://api.hubapi.com/marketing/v3/transactional/smtp-tokens/{tokenId}/password-reset"},"summary":"Reset the password of an existing token","description":"Reset the password of an existing token","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/forms/{formId}":{"get":{"tags":["Marketing Forms"],"parameters":[{"name":"formId","in":"path","description":"The unique identifier of the form","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/forms#get-%2Fmarketing%2Fv3%2Fforms%2F%7Bformid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/forms/{formId}"},"summary":"Get a form definition","description":"Get a form definition","security":[{"bearerAuth":[]}]},"put":{"tags":["Marketing Forms"],"parameters":[{"name":"formId","in":"path","description":"The unique identifier of the form","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/forms#put-%2Fmarketing%2Fv3%2Fforms%2F%7Bformid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/forms/{formId}"},"summary":"Update a form definition","description":"Update a form definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archived":{"type":"boolean","description":"archived","enum":[true,false]},"archivedAt":{"type":"string","description":"archivedAt"},"configuration":{"type":"object","description":"configuration","properties":{}},"createdAt":{"type":"string","description":"createdAt"},"displayOptions":{"type":"object","description":"Options for styling the form","properties":{}},"fieldGroups":{"type":"object","description":"fieldGroups","properties":{}},"formType":{"type":"string","description":"formType"},"legalConsentOptions":{"type":"object","description":"legalConsentOptions","properties":{}},"name":{"type":"string","description":"name"},"updatedAt":{"type":"string","description":"updatedAt"}}},"example":{"archived":"","archivedAt":"","configuration":{},"createdAt":"","displayOptions":{},"fieldGroups":{},"formType":"","legalConsentOptions":{},"name":"","updatedAt":""}}}}},"patch":{"tags":["Marketing Forms"],"parameters":[{"name":"formId","in":"path","description":"The unique identifier of the form","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/forms#patch-%2Fmarketing%2Fv3%2Fforms%2F%7Bformid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/forms/{formId}"},"summary":"Partially update a form definition","description":"Partially update a form definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archived":{"type":"boolean","description":"archived","enum":[true,false]},"configuration":{"type":"object","description":"configuration","properties":{}},"displayOptions":{"type":"object","description":"Options for styling the form","properties":{}},"fieldGroups":{"type":"object","description":"fieldGroups","properties":{}},"legalConsentOptions":{"type":"object","description":"legalConsentOptions","properties":{}},"name":{"type":"string","description":"name"}}},"example":{"archived":"","configuration":{},"displayOptions":{},"fieldGroups":{},"legalConsentOptions":{},"name":""}}}}},"delete":{"tags":["Marketing Forms"],"parameters":[{"name":"formId","in":"path","description":"The ID of the form to archive","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/forms#delete-%2Fmarketing%2Fv3%2Fforms%2F%7Bformid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/forms/{formId}"},"summary":"Archive a form definition","description":"Archive a form definition","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/forms":{"get":{"tags":["Marketing Forms"],"parameters":[{"name":"after","in":"query","description":"he paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"formTypes","in":"query","description":"The form types to be included in the results","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/forms#get-%2Fmarketing%2Fv3%2Fforms%2F","api_endpoint":"https://api.hubapi.com/marketing/v3/forms"},"summary":"Get a list of forms","description":"Get a list of forms","security":[{"bearerAuth":[]}]},"post":{"tags":["Marketing Forms"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/forms#post-%2Fmarketing%2Fv3%2Fforms%2F","api_endpoint":"https://api.hubapi.com/marketing/v3/forms"},"summary":"Create a form","description":"Create a form","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"archived":{"type":"boolean","description":"archived","enum":[true,false]},"archivedAt":{"type":"string","description":"archivedAt"},"configuration":{"type":"object","description":"configuration","properties":{}},"createdAt":{"type":"string","description":"createdAt"},"displayOptions":{"type":"object","description":"Options for styling the form","properties":{}},"fieldGroups":{"type":"object","description":"fieldGroups","properties":{}},"formType":{"type":"string","description":"formType"},"legalConsentOptions":{"type":"object","description":"legalConsentOptions","properties":{}},"name":{"type":"string","description":"name"},"updatedAt":{"type":"string","description":"updatedAt"}}},"example":{"archived":"","archivedAt":"","configuration":{},"createdAt":"","displayOptions":{},"fieldGroups":{},"formType":"","legalConsentOptions":{},"name":"","updatedAt":""}}}}}},"/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create":{"post":{"tags":["Marketing Marketing Events Add Event Attendees"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"subscriberState","in":"path","description":"The new subscriber state for the HubSpot contacts and the specified marketing even","required":true,"schema":{"type":"string","example":""}},{"name":"externalAccountId","in":"query","description":"The accountId that is associated with this marketing event in the external event application","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fattendance%2F%7Bexternaleventid%7D%2F%7Bsubscriberstate%7D%2Fcreate","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/create"},"summary":"Record Participants by ContactId with Marketing Event External Ids","description":"Record Participants by ContactId with Marketing Event External Ids","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"List of HubSpot contacts to subscribe to the marketing event","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create":{"post":{"tags":["Marketing Marketing Events Add Event Attendees"],"parameters":[{"name":"objectId","in":"path","description":"The internal id of the marketing event in HubSpot","required":true,"schema":{"type":"string","example":""}},{"name":"subscriberState","in":"path","description":"The new subscriber state for the HubSpot contacts and the specified marketing even","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2F%7Bobjectid%7D%2Fattendance%2F%7Bsubscriberstate%7D%2Fcreate","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/create"},"summary":"Record Participants by ContactId with Marketing Event Object Id","description":"Record Participants by ContactId with Marketing Event Object Id","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"List of HubSpot contacts to subscribe to the marketing event","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create":{"post":{"tags":["Marketing Marketing Events Add Event Attendees"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"subscriberState","in":"path","description":"The new subscriber state for the HubSpot contacts and the specified marketing even","required":true,"schema":{"type":"string","example":""}},{"name":"externalAccountId","in":"query","description":"The accountId that is associated with this marketing event in the external event application","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fattendance%2F%7Bexternaleventid%7D%2F%7Bsubscriberstate%7D%2Femail-create","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/attendance/{externalEventId}/{subscriberState}/email-create"},"summary":"Record Participants by Email with Marketing Event External Ids","description":"Record Participants by Email with Marketing Event External Ids","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"List of HubSpot contacts to subscribe to the marketing event","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create":{"post":{"tags":["Marketing Marketing Events Add Event Attendees"],"parameters":[{"name":"objectId","in":"path","description":"The internal ID of the marketing event in HubSpot","required":true,"schema":{"type":"string","example":""}},{"name":"subscriberState","in":"path","description":"The new subscriber state for the HubSpot contacts and the specified marketing even","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2F%7Bobjectid%7D%2Fattendance%2F%7Bsubscriberstate%7D%2Femail-create","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/{objectId}/attendance/{subscriberState}/email-create"},"summary":"Record Participants by Email with Marketing Event Object Id","description":"Record Participants by Email with Marketing Event Object Id","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"List of HubSpot contacts to subscribe to the marketing event","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown":{"get":{"tags":["Marketing Marketing Events Retrieve Participant State"],"parameters":[{"name":"contactIdentifier","in":"path","description":"The identifier of the Contact. It may be email or internal id.","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The cursor indicating the position of the last retrieved item","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The limit for response size","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"The participation state value","schema":{"type":"enum","example":"","items":{"type":"string","enum":["REGISTERED","CANCELLED","ATTENDED","NO_SHOW"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fparticipations%2Fcontacts%2F%7Bcontactidentifier%7D%2Fbreakdown","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/participations/contacts/{contactIdentifier}/breakdown"},"summary":"Read participations breakdown by Contact identifier","description":"Read participations breakdown by Contact identifier","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown":{"get":{"tags":["Marketing Marketing Events Retrieve Participant State"],"parameters":[{"name":"externalAccountId","in":"path","description":"The accountId that is associated with this marketing event in the external event application.","required":true,"schema":{"type":"string","example":""}},{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"after","in":"query","description":"The cursor indicating the position of the last retrieved item","schema":{"type":"string","example":""}},{"name":"contactIdentifier","in":"query","description":"The identifier of the Contact. It may be email or internal id.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The limit for response size","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"The participation state value","schema":{"type":"enum","example":"","items":{"type":"string","enum":["REGISTERED","CANCELLED","ATTENDED","NO_SHOW"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fparticipations%2F%7Bexternalaccountid%7D%2F%7Bexternaleventid%7D%2Fbreakdown","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}/breakdown"},"summary":"Read participations breakdown by Marketing Event external identifier","description":"Read participations breakdown by Marketing Event external identifier","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/participations/{marketingEventId}/breakdown":{"get":{"tags":["Marketing Marketing Events Retrieve Participant State"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"number","example":""}},{"name":"after","in":"query","description":"The cursor indicating the position of the last retrieved item","schema":{"type":"string","example":""}},{"name":"contactIdentifier","in":"query","description":"The identifier of the Contact. It may be email or internal id.","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The limit for response size","schema":{"type":"number","example":""}},{"name":"state","in":"query","description":"The participation state value","schema":{"type":"enum","example":"","items":{"type":"string","enum":["REGISTERED","CANCELLED","ATTENDED","NO_SHOW"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fparticipations%2F%7Bmarketingeventid%7D%2Fbreakdown","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/participations/{marketingEventId}/breakdown"},"summary":"Read participations breakdown by Marketing Event internal identifier","description":"Read participations breakdown by Marketing Event internal identifier","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}":{"get":{"tags":["Marketing Marketing Events Retrieve Participant State"],"parameters":[{"name":"externalAccountId","in":"path","description":"The accountId that is associated with this marketing event in the external event application.","required":true,"schema":{"type":"string","example":""}},{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fparticipations%2F%7Bexternalaccountid%7D%2F%7Bexternaleventid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/participations/{externalAccountId}/{externalEventId}"},"summary":"Read participations counters by Marketing Event external identifier","description":"Read participations counters by Marketing Event external identifier","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/participations/{marketingEventId}":{"get":{"tags":["Marketing Marketing Events Retrieve Participant State"],"parameters":[{"name":"marketingEventId","in":"path","description":"The internal id of the marketing event in HubSpot","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fparticipations%2F%7Bmarketingeventid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/participations/{marketingEventId}"},"summary":"Read participations counters by Marketing Event internal identifier","description":"Read participations counters by Marketing Event internal identifier","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert":{"post":{"tags":["Marketing Marketing Events Subscriber State Changes"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"subscriberState","in":"path","description":"The new subscriber state for the HubSpot contacts and the specified marketing even","required":true,"schema":{"type":"string","example":""}},{"name":"externalAccountId","in":"query","description":"The accountId that is associated with this marketing event in the external event application","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D%2F%7Bsubscriberstate%7D%2Femail-upsert","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/email-upsert"},"summary":"Record a subscriber state by contact email","description":"Record a subscriber state by contact email","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"arrayt","description":"List of marketing event details to create or update"}}},"example":{"inputs":""}}}}}},"/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert":{"post":{"tags":["Marketing Marketing Events Subscriber State Changes"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"subscriberState","in":"path","description":"The new subscriber state for the HubSpot contacts and the specified marketing even","required":true,"schema":{"type":"string","example":""}},{"name":"externalAccountId","in":"query","description":"The accountId that is associated with this marketing event in the external event application","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D%2F%7Bsubscriberstate%7D%2Fupsert","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}/{subscriberState}/upsert"},"summary":"Record a subscriber state by contact ID","description":"Record a subscriber state by contact ID","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"arrayt","description":"List of marketing event details to create or update"}}},"example":{"inputs":""}}}}}},"/marketing/v3/marketing-events":{"get":{"tags":["Marketing Marketing Events Basic"],"parameters":[{"name":"after","in":"query","description":"The cursor indicating the position of the last retrieved item","schema":{"type":"string","example":""}},{"name":"limit","in":"query","description":"The limit for response size","schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2F","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events"},"summary":"Get all marketing event","description":"Get all marketing event","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/events/{externalEventId}":{"get":{"tags":["Marketing Marketing Events Basic"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"externalAccountId","in":"query","description":"The accountId that is associated with this marketing event in the external event application.","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}"},"summary":"Get Marketing Event by External IDs","description":"Get Marketing Event by External IDs","security":[{"bearerAuth":[]}]},"put":{"tags":["Marketing Marketing Events Basic"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#put-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}"},"summary":"Create or update a marketing event","description":"Create or update a marketing event","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"customProperties":{"type":"object","description":"A list of PropertyValues","properties":{}},"endDateTime":{"type":"string","description":"The end date and time of the marketing event"},"eventCancelled":{"type":"boolean","description":"Indicates if the marketing event has been cancelled","enum":[true,false]},"eventCompleted":{"type":"boolean","description":"eventCompleted","enum":[true,false]},"eventDescription":{"type":"string","description":"The description of the marketing even"},"eventName":{"type":"string","description":"The name of the marketing event","required":true},"eventOrganizer":{"type":"string","description":"The name of the organizer of the marketing event","required":true},"eventType":{"type":"string","description":"Describes what type of event this is. For example: WEBINAR, CONFERENCE, WORKSHOP"},"eventUrl":{"type":"string","description":"A URL in the external event application where the marketing event can be managed"},"externalAccountId":{"type":"string","description":"The accountId that is associated with this marketing event in the external event application","required":true},"externalEventId":{"type":"string","description":"The id of the marketing event in the external event application","required":true},"startDateTime":{"type":"string","description":"The start date and time of the marketing event"}}},"example":{"customProperties":{},"endDateTime":"","eventCancelled":"","eventCompleted":"","eventDescription":"","eventName":"","eventOrganizer":"","eventType":"","eventUrl":"","externalAccountId":"","externalEventId":"","startDateTime":""}}}}},"patch":{"tags":["Marketing Marketing Events Basic"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#patch-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}"},"summary":"Update Marketing Event by External IDs","description":"Update Marketing Event by External IDs","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"customProperties":{"type":"object","description":"A list of PropertyValues","properties":{}},"endDateTime":{"type":"string","description":"The end date and time of the marketing event"},"eventCancelled":{"type":"boolean","description":"Indicates if the marketing event has been cancelled","enum":[true,false]},"eventCompleted":{"type":"boolean","description":"eventCompleted","enum":[true,false]},"eventDescription":{"type":"string","description":"The description of the marketing even"},"eventName":{"type":"string","description":"The name of the marketing event"},"eventOrganizer":{"type":"string","description":"The name of the organizer of the marketing event"},"eventType":{"type":"string","description":"Describes what type of event this is. For example: WEBINAR, CONFERENCE, WORKSHOP"},"eventUrl":{"type":"string","description":"A URL in the external event application where the marketing event can be managed"},"startDateTime":{"type":"string","description":"The start date and time of the marketing event"}}},"example":{"customProperties":{},"endDateTime":"","eventCancelled":"","eventCompleted":"","eventDescription":"","eventName":"","eventOrganizer":"","eventType":"","eventUrl":"","startDateTime":""}}}}},"delete":{"tags":["Marketing Marketing Events Basic"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#delete-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}"},"summary":"Delete Marketing Event by External Ids","description":"Delete Marketing Event by External Ids","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/marketing-events/{objectId}":{"get":{"tags":["Marketing Marketing Events Basic"],"parameters":[{"name":"objectId","in":"path","description":"The internal ID of the marketing event in HubSpot","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/{objectId}"},"summary":"Get Marketing Event by objectId","description":"Get Marketing Event by objectId","security":[{"bearerAuth":[]}]},"delete":{"tags":["Marketing Marketing Events Basic"],"parameters":[{"name":"objectId","in":"path","description":"The internal ID of the marketing event in HubSpot","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#delete-%2Fmarketing%2Fv3%2Fmarketing-events%2F%7Bobjectid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/{objectId}"},"summary":"Delete Marketing Event by objectId","description":"Delete Marketing Event by objectId","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/marketing-events/events":{"post":{"tags":["Marketing Marketing Events Basic"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events"},"summary":"Create a marketing event","description":"Create a marketing event","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"customProperties":{"type":"object","description":"A list of PropertyValues","properties":{}},"endDateTime":{"type":"string","description":"The end date and time of the marketing event"},"eventCancelled":{"type":"boolean","description":"Indicates if the marketing event has been cancelled","enum":[true,false]},"eventCompleted":{"type":"boolean","description":"eventCompleted","enum":[true,false]},"eventDescription":{"type":"string","description":"The description of the marketing even"},"eventName":{"type":"string","description":"The name of the marketing event","required":true},"eventOrganizer":{"type":"string","description":"The name of the organizer of the marketing event","required":true},"eventType":{"type":"string","description":"Describes what type of event this is. For example: WEBINAR, CONFERENCE, WORKSHOP"},"eventUrl":{"type":"string","description":"A URL in the external event application where the marketing event can be managed"},"externalAccountId":{"type":"string","description":"The accountId that is associated with this marketing event in the external event application","required":true},"externalEventId":{"type":"string","description":"The id of the marketing event in the external event application","required":true},"startDateTime":{"type":"string","description":"The start date and time of the marketing event"}}},"example":{"customProperties":{},"endDateTime":"","eventCancelled":"","eventCompleted":"","eventDescription":"","eventName":"","eventOrganizer":"","eventType":"","eventUrl":"","externalAccountId":"","externalEventId":"","startDateTime":""}}}}}},"/marketing/v3/marketing-events/events/upsert":{"post":{"tags":["Marketing Marketing Events Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2Fupsert","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/upsert"},"summary":"Create or Update Multiple Marketing Events","description":"Create or Update Multiple Marketing Events","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endDateTime":{"type":"string","description":"The end date and time of the marketing event"},"eventCancelled":{"type":"boolean","description":"Indicates if the marketing event has been cancelled","enum":[true,false]},"eventCompleted":{"type":"boolean","description":"eventCompleted","enum":[true,false]},"eventDescription":{"type":"string","description":"The description of the marketing even"},"eventName":{"type":"string","description":"The name of the marketing event","required":true},"eventOrganizer":{"type":"string","description":"The name of the organizer of the marketing event","required":true},"eventType":{"type":"string","description":"Describes what type of event this is. For example: WEBINAR, CONFERENCE, WORKSHOP"},"eventUrl":{"type":"string","description":"A URL in the external event application where the marketing event can be managed"},"externalAccountId":{"type":"string","description":"The accountId that is associated with this marketing event in the external event application","required":true},"externalEventId":{"type":"string","description":"The id of the marketing event in the external event application","required":true},"inputs":{"type":"string","description":""}}},"example":{"endDateTime":"","eventCancelled":"","eventCompleted":"","eventDescription":"","eventName":"","eventOrganizer":"","eventType":"","eventUrl":"","externalAccountId":"","externalEventId":"","inputs":""}}}}}},"/marketing/v3/marketing-events/events/delete":{"post":{"tags":["Marketing Marketing Events Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2Fdelete","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/delete"},"summary":"Delete Multiple Marketing Events by External Ids","description":"Delete Multiple Marketing Events by External Ids","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/marketing-events/batch/archive":{"post":{"tags":["Marketing Marketing Events Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fbatch%2Farchive","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/batch/archive"},"summary":"Delete Multiple Marketing Events by ObjectId","description":"Delete Multiple Marketing Events by ObjectId","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/marketing-events/batch/update":{"post":{"tags":["Marketing Marketing Events Batch"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fbatch%2Fupdate","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/batch/update"},"summary":"Update Multiple Marketing Events by ObjectId","description":"Update Multiple Marketing Events by ObjectId","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists":{"get":{"tags":["Marketing Marketing Events List Associations"],"parameters":[{"name":"externalAccountId","in":"path","description":"The accountId that is associated with this marketing event in the external event application.","required":true,"schema":{"type":"string","example":""}},{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fassociations%2F%7Bexternalaccountid%7D%2F%7Bexternaleventid%7D%2Flists","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists"},"summary":"Get lists associated with a marketing event","description":"Get lists associated with a marketing event","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/associations/{marketingEventId}/lists":{"get":{"tags":["Marketing Marketing Events List Associations"],"parameters":[{"name":"marketingEventId","in":"path","description":"The internal id of the marketing event in HubSpot.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fassociations%2F%7Bmarketingeventid%7D%2Flists","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/associations/{marketingEventId}/lists"},"summary":"Get lists associated with a marketing event","description":"Get lists associated with a marketing event","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}":{"put":{"tags":["Marketing Marketing Events List Associations"],"parameters":[{"name":"listId","in":"path","description":"The ILS ID of the list","required":true,"schema":{"type":"string","example":""}},{"name":"marketingEventId","in":"path","description":"The internal id of the marketing event in HubSpot","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#put-%2Fmarketing%2Fv3%2Fmarketing-events%2Fassociations%2F%7Bmarketingeventid%7D%2Flists%2F%7Blistid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}"},"summary":"Associate a list with a marketing event","description":"Associate a list with a marketing event","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Marketing Marketing Events List Associations"],"parameters":[{"name":"listId","in":"path","description":"The ILS ID of the list","required":true,"schema":{"type":"string","example":""}},{"name":"marketingEventId","in":"path","description":"The internal id of the marketing event in HubSpot","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#delete-%2Fmarketing%2Fv3%2Fmarketing-events%2Fassociations%2F%7Bmarketingeventid%7D%2Flists%2F%7Blistid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/associations/{marketingEventId}/lists/{listId}"},"summary":"Disassociate a list from a marketing event","description":"Disassociate a list from a marketing event","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}":{"put":{"tags":["Marketing Marketing Events List Associations"],"parameters":[{"name":"externalAccountId","in":"path","description":"The accountId that is associated with this marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"listId","in":"path","description":"The ILS ID of the list","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#put-%2Fmarketing%2Fv3%2Fmarketing-events%2Fassociations%2F%7Bexternalaccountid%7D%2F%7Bexternaleventid%7D%2Flists%2F%7Blistid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}"},"summary":"Associate a list with a marketing event","description":"Associate a list with a marketing event","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}},"delete":{"tags":["Marketing Marketing Events List Associations"],"parameters":[{"name":"externalAccountId","in":"path","description":"The accountId that is associated with this marketing event in the external event application.","required":true,"schema":{"type":"string","example":""}},{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"listId","in":"path","description":"The ILS ID of the list","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#delete-%2Fmarketing%2Fv3%2Fmarketing-events%2Fassociations%2F%7Bexternalaccountid%7D%2F%7Bexternaleventid%7D%2Flists%2F%7Blistid%7D","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/associations/{externalAccountId}/{externalEventId}/lists/{listId}"},"summary":"Disassociate a list from a marketing event","description":"Disassociate a list from a marketing event","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/marketing-events/events/search":{"get":{"tags":["Marketing Marketing Events Identifiers"],"parameters":[{"name":"externalAccountId","in":"path","description":"The accountId that is associated with this marketing event in the external event application.","required":true,"schema":{"type":"string","example":""}},{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"listId","in":"path","description":"The ILS ID of the list","required":true,"schema":{"type":"string","example":""}},{"name":"q","in":"query","description":"The id of the marketing event in the external event application (externalEventId)","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2Fsearch","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/search"},"summary":"Find App-Specific Marketing Events by External Event Id","description":"Find App-Specific Marketing Events by External Event Id","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/{externalEventId}/identifiers":{"get":{"tags":["Marketing Marketing Events Identifiers"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2F%7Bexternaleventid%7D%2Fidentifiers","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/{externalEventId}/identifiers"},"summary":"Find Marketing Events by External Event Id","description":"Find Marketing Events by External Event Id","security":[{"bearerAuth":[]}]}},"/marketing/v3/marketing-events/events/{externalEventId}/cancel":{"post":{"tags":["Marketing Marketing Events Change Property"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"externalAccountId","in":"query","description":"The accountId that is associated with this marketing event in the external event application.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D%2Fcancel","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}/cancel"},"summary":"Mark a marketing event as cancelled","description":"Mark a marketing event as cancelled","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/marketing/v3/marketing-events/events/{externalEventId}/complete":{"post":{"tags":["Marketing Marketing Events Change Property"],"parameters":[{"name":"externalEventId","in":"path","description":"The id of the marketing event in the external event application","required":true,"schema":{"type":"string","example":""}},{"name":"externalAccountId","in":"query","description":"The accountId that is associated with this marketing event in the external event application.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2Fevents%2F%7Bexternaleventid%7D%2Fcomplete","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/events/{externalEventId}/complete"},"summary":"Mark a marketing event as completed","description":"Mark a marketing event as completed","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"endDateTime":{"type":"string","description":"endDateTime","required":true},"startDateTime":{"type":"string","description":"startDateTime","required":true}}},"example":{"endDateTime":"","startDateTime":""}}}}}},"/marketing/v3/marketing-events/{appId}/settings":{"get":{"tags":["Marketing Marketing Events Settings"],"parameters":[{"name":"appId","in":"path","description":"The id of the application to retrieve the settings for","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#get-%2Fmarketing%2Fv3%2Fmarketing-events%2F%7Bappid%7D%2Fsettings","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/{appId}/settings"},"summary":"Retrieve the application settings","description":"Retrieve the application settings","security":[{"bearerAuth":[]}]},"post":{"tags":["Marketing Marketing Events Settings"],"parameters":[{"name":"appId","in":"path","description":"The id of the application to retrieve the settings for","required":true,"schema":{"type":"number","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/marketing-events#post-%2Fmarketing%2Fv3%2Fmarketing-events%2F%7Bappid%7D%2Fsettings","api_endpoint":"https://api.hubapi.com/marketing/v3/marketing-events/{appId}/settings"},"summary":"Update the application settings","description":"Update the application settings","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"eventDetailsUrl":{"type":"string","description":"The url that will be used to fetch marketing event details by id","required":true}}},"example":{"eventDetailsUrl":""}}}}}},"/communication-preferences/v4/statuses/{subscriberIdString}":{"get":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[{"name":"externalAccountId","in":"path","description":"he contact's email address.","required":true,"schema":{"type":"string","example":""}},{"name":"businessUnitId","in":"query","description":"If you have the business unit add-on, include this parameter to filter results by business unit ID","required":false,"schema":{"type":"string","example":""}},{"name":"channel","in":"query","description":"The channel type for the subscription type. Currently, the only supported channel type is EMAIL","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["WHATSAPP","SMS","EMAIL"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#get-%2Fcommunication-preferences%2Fv4%2Fstatuses%2F%7Bsubscriberidstring%7D","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}"},"summary":"Get subscription preferences for a specific contact","description":"Get subscription preferences for a specific contact","security":[{"bearerAuth":[]}]},"post":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[{"name":"subscriberIdString","in":"path","description":"The identifier of the Contact. It may be email or internal id.","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#post-%2Fcommunication-preferences%2Fv4%2Fstatuses%2F%7Bsubscriberidstring%7D","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}"},"summary":"Update a contact's subscription status","description":"Update a contact's subscription status","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"channel":{"type":"enum","description":"The channel type for the subscription type. Currently, the only supported channel type is EMAIL","required":true,"enum":["WHATSAPP","SMS","EMAIL"]},"legalBasis":{"type":"enum","description":"legalBasis","enum":["LEGITIMATE_INTEREST_PQL","LEGITIMATE_INTEREST_CLIENT","PERFORMANCE_OF_CONTRACT","CONSENT_WITH_NOTICE","NON_GDPR","PROCESS_AND_STORE","LEGITIMATE_INTEREST_OTHER"]},"legalBasisExplanation":{"type":"string","description":"","required":true},"statusState":{"type":"enum","description":"statusState","required":true,"enum":["SUBSCRIBED","UNSUBSCRIBED","NOT_SPECIFIED"]},"subscriptionId":{"type":"number","description":"","required":true}}},"example":{"channel":"","legalBasis":"","legalBasisExplanation":"","statusState":"","subscriptionId":""}}}}}},"/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all":{"get":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[{"name":"subscriberIdString","in":"path","description":"The identifier of the Contact. It may be email or internal id.","required":true,"schema":{"type":"string","example":""}},{"name":"businessUnitId","in":"query","description":"If you have the business unit add-on, include this parameter to filter results by business unit ID","required":false,"schema":{"type":"string","example":""}},{"name":"channel","in":"query","description":"The channel type for the subscription type. Currently, the only supported channel type is EMAIL","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["WHATSAPP","SMS","EMAIL"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#get-%2Fcommunication-preferences%2Fv4%2Fstatuses%2F%7Bsubscriberidstring%7D%2Funsubscribe-all","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all"},"summary":"Retrieve a contact's unsubscribed status","description":"Retrieve a contact's unsubscribed status","security":[{"bearerAuth":[]}]},"post":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[{"name":"subscriberIdString","in":"path","description":"The identifier of the Contact. It may be email or internal id.","required":true,"schema":{"type":"string","example":""}},{"name":"businessUnitId","in":"query","description":"If you have the business unit add-on, include this parameter to filter results by business unit ID","required":false,"schema":{"type":"string","example":""}},{"name":"channel","in":"query","description":"The channel type for the subscription type. Currently, the only supported channel type is EMAIL","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["WHATSAPP","SMS","EMAIL"]}}},{"name":"verbose","in":"query","description":"Set to true to include the details of the updated subscription statuses in the response","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#post-%2Fcommunication-preferences%2Fv4%2Fstatuses%2F%7Bsubscriberidstring%7D%2Funsubscribe-all","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/{subscriberIdString}/unsubscribe-all"},"summary":"Unsubscribe a contact from all subscriptions","description":"Unsubscribe a contact from all subscriptions","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/communication-preferences/v4/statuses/batch/unsubscribe-all/read":{"post":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[{"name":"businessUnitId","in":"query","description":"If you have the business unit add-on, include this parameter to filter results by business unit ID","required":false,"schema":{"type":"string","example":""}},{"name":"channel","in":"query","description":"The channel type for the subscription type. Currently, the only supported channel type is EMAIL","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["WHATSAPP","SMS","EMAIL"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#post-%2Fcommunication-preferences%2Fv4%2Fstatuses%2Fbatch%2Funsubscribe-all%2Fread","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all/read"},"summary":"Batch retrieve contacts who have opted out of all communications","description":"Batch retrieve contacts who have opted out of all communications","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/communication-preferences/v4/statuses/batch/read":{"post":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[{"name":"businessUnitId","in":"query","description":"If you have the business unit add-on, include this parameter to filter results by business unit ID","required":false,"schema":{"type":"string","example":""}},{"name":"channel","in":"query","description":"The channel type for the subscription type. Currently, the only supported channel type is EMAIL","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["WHATSAPP","SMS","EMAIL"]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#post-%2Fcommunication-preferences%2Fv4%2Fstatuses%2Fbatch%2Fread","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/batch/read"},"summary":"Batch retrieve subscription statuses","description":"Batch retrieve subscription statuses","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/communication-preferences/v4/statuses/batch/unsubscribe-all":{"post":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[{"name":"businessUnitId","in":"query","description":"If you have the business unit add-on, include this parameter to filter results by business unit ID","required":false,"schema":{"type":"string","example":""}},{"name":"channel","in":"query","description":"The channel type for the subscription type. Currently, the only supported channel type is EMAIL","required":true,"schema":{"type":"enum","example":"","items":{"type":"string","enum":["WHATSAPP","SMS","EMAIL"]}}},{"name":"verbose","in":"query","description":"Set to true to include the details of the updated subscription statuses in the response","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#post-%2Fcommunication-preferences%2Fv4%2Fstatuses%2Fbatch%2Funsubscribe-all","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/batch/unsubscribe-all"},"summary":"Batch unsubscribe contacts from all subscriptions","description":"Batch unsubscribe contacts from all subscriptions","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/communication-preferences/v4/statuses/batch/write":{"post":{"tags":["Marketing Subscriptions Preferences Subscription Status"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#post-%2Fcommunication-preferences%2Fv4%2Fstatuses%2Fbatch%2Fwrite","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/statuses/batch/write"},"summary":"Batch update subscription status","description":"Batch update subscription status","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"inputs","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/communication-preferences/v4/definitions":{"get":{"tags":["Marketing Subscriptions Preferences Subscription Definitions"],"parameters":[{"name":"businessUnitId","in":"query","description":"If you have the business unit add-on, include this parameter to filter results by business unit ID","required":false,"schema":{"type":"string","example":""}},{"name":"includeTranslations","in":"query","description":"Set to true to return subscription translations associated with each definition","required":false,"schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/reference/api/marketing/subscriptions-preferences#get-%2Fcommunication-preferences%2Fv4%2Fdefinitions","api_endpoint":"https://api.hubapi.com/communication-preferences/v4/definitions"},"summary":"Retrieve all subscription status definitions","description":"Retrieve all subscription status definitions","security":[{"bearerAuth":[]}]}},"/crm/objects/2026-03/contacts":{"get":{"tags":["CRM Objects Contacts"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts"},"summary":"Read a page of contacts","description":"Read a page of contacts","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Objects Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts"},"summary":"Create a contact","description":"Create a contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"Associations between the contact and other objects","items":{"type":"string"}},"properties":{"type":"object","description":"The contact's properties","required":true,"properties":{}}}},"example":{"associations":[],"properties":{}}}}}}},"/crm/objects/2026-03/contacts/{contactId}":{"get":{"tags":["CRM Objects Contacts"],"parameters":[{"name":"contactId","in":"path","description":"The contact ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/{contactId}"},"summary":"Read a contact","description":"Read a contact","security":[{"bearerAuth":[]}]},"patch":{"tags":["CRM Objects Contacts"],"parameters":[{"name":"contactId","in":"path","description":"The contact ID","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/{contactId}"},"summary":"Update a contact","description":"Update a contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"object","description":"The contact's properties","required":true,"properties":{}}}},"example":{"properties":{}}}}}},"delete":{"tags":["CRM Objects Contacts"],"parameters":[{"name":"contactId","in":"path","description":"The contact ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/{contactId}"},"summary":"Delete a contact","description":"Delete a contact","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/objects/2026-03/contacts/batch/read":{"post":{"tags":["CRM Objects Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/batch/read"},"summary":"Read a batch of contacts","description":"Read a batch of contacts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"A comma separated list of object types to retrieve associated IDs for","items":{"type":"string"}},"idProperty":{"type":"string","description":"The name of a property whose values are unique for this object type"},"inputs":{"type":"array","description":"The contact IDs to read","required":true,"items":{"type":"string"}},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"propertiesWithHistory":{"type":"array","description":"A comma separated list of the properties to be returned along with their history of previous values","items":{"type":"string"}}}},"example":{"associations":[],"idProperty":"","inputs":[],"properties":[],"propertiesWithHistory":[]}}}}}},"/crm/objects/2026-03/contacts/batch/create":{"post":{"tags":["CRM Objects Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/batch/create"},"summary":"Create a batch of contacts","description":"Create a batch of contacts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The contacts to create","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/contacts/batch/update":{"post":{"tags":["CRM Objects Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/batch/update"},"summary":"Update a batch of contacts","description":"Update a batch of contacts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The contacts to update","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/contacts/batch/archive":{"post":{"tags":["CRM Objects Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/batch/archive"},"summary":"Archive a batch of contacts","description":"Archive a batch of contacts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The contact IDs to archive","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/contacts/search":{"post":{"tags":["CRM Objects Contacts"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/contacts","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/contacts/search"},"summary":"Search contacts","description":"Search contacts","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after":{"type":"string","description":"The paging cursor token"},"filterGroups":{"type":"array","description":"The filter groups to apply","items":{"type":"string"}},"limit":{"type":"number","description":"The maximum number of results to display per page"},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"query":{"type":"string","description":"The search query"},"sorts":{"type":"array","description":"The fields to sort by","items":{"type":"string"}}}},"example":{"after":"","filterGroups":[],"limit":"","properties":[],"query":"","sorts":[]}}}}}},"/crm/objects/2026-03/companies":{"get":{"tags":["CRM Objects Companies"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies"},"summary":"Read a page of companies","description":"Read a page of companies","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Objects Companies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies"},"summary":"Create a company","description":"Create a company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"Associations between the company and other objects","items":{"type":"string"}},"properties":{"type":"object","description":"The company's properties","required":true,"properties":{}}}},"example":{"associations":[],"properties":{}}}}}}},"/crm/objects/2026-03/companies/{companyId}":{"get":{"tags":["CRM Objects Companies"],"parameters":[{"name":"companyId","in":"path","description":"The company ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/{companyId}"},"summary":"Read a company","description":"Read a company","security":[{"bearerAuth":[]}]},"patch":{"tags":["CRM Objects Companies"],"parameters":[{"name":"companyId","in":"path","description":"The company ID","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/{companyId}"},"summary":"Update a company","description":"Update a company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"object","description":"The company's properties","required":true,"properties":{}}}},"example":{"properties":{}}}}}},"delete":{"tags":["CRM Objects Companies"],"parameters":[{"name":"companyId","in":"path","description":"The company ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/{companyId}"},"summary":"Delete a company","description":"Delete a company","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/objects/2026-03/companies/batch/read":{"post":{"tags":["CRM Objects Companies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/batch/read"},"summary":"Read a batch of companies","description":"Read a batch of companies","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"A comma separated list of object types to retrieve associated IDs for","items":{"type":"string"}},"idProperty":{"type":"string","description":"The name of a property whose values are unique for this object type"},"inputs":{"type":"array","description":"The company IDs to read","required":true,"items":{"type":"string"}},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"propertiesWithHistory":{"type":"array","description":"A comma separated list of the properties to be returned along with their history of previous values","items":{"type":"string"}}}},"example":{"associations":[],"idProperty":"","inputs":[],"properties":[],"propertiesWithHistory":[]}}}}}},"/crm/objects/2026-03/companies/batch/create":{"post":{"tags":["CRM Objects Companies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/batch/create"},"summary":"Create a batch of companies","description":"Create a batch of companies","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The companies to create","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/companies/batch/update":{"post":{"tags":["CRM Objects Companies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/batch/update"},"summary":"Update a batch of companies","description":"Update a batch of companies","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The companies to update","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/companies/batch/archive":{"post":{"tags":["CRM Objects Companies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/batch/archive"},"summary":"Archive a batch of companies","description":"Archive a batch of companies","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The company IDs to archive","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/companies/search":{"post":{"tags":["CRM Objects Companies"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/companies","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/companies/search"},"summary":"Search companies","description":"Search companies","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after":{"type":"string","description":"The paging cursor token"},"filterGroups":{"type":"array","description":"The filter groups to apply","items":{"type":"string"}},"limit":{"type":"number","description":"The maximum number of results to display per page"},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"query":{"type":"string","description":"The search query"},"sorts":{"type":"array","description":"The fields to sort by","items":{"type":"string"}}}},"example":{"after":"","filterGroups":[],"limit":"","properties":[],"query":"","sorts":[]}}}}}},"/crm/objects/2026-03/deals":{"get":{"tags":["CRM Objects Deals"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals"},"summary":"Read a page of deals","description":"Read a page of deals","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Objects Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals"},"summary":"Create a deal","description":"Create a deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"Associations between the deal and other objects","items":{"type":"string"}},"properties":{"type":"object","description":"The deal's properties","required":true,"properties":{}}}},"example":{"associations":[],"properties":{}}}}}}},"/crm/objects/2026-03/deals/{dealId}":{"get":{"tags":["CRM Objects Deals"],"parameters":[{"name":"dealId","in":"path","description":"The deal ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/{dealId}"},"summary":"Read a deal","description":"Read a deal","security":[{"bearerAuth":[]}]},"patch":{"tags":["CRM Objects Deals"],"parameters":[{"name":"dealId","in":"path","description":"The deal ID","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/{dealId}"},"summary":"Update a deal","description":"Update a deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"object","description":"The deal's properties","required":true,"properties":{}}}},"example":{"properties":{}}}}}},"delete":{"tags":["CRM Objects Deals"],"parameters":[{"name":"dealId","in":"path","description":"The deal ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/{dealId}"},"summary":"Delete a deal","description":"Delete a deal","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/objects/2026-03/deals/batch/read":{"post":{"tags":["CRM Objects Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/batch/read"},"summary":"Read a batch of deals","description":"Read a batch of deals","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"A comma separated list of object types to retrieve associated IDs for","items":{"type":"string"}},"idProperty":{"type":"string","description":"The name of a property whose values are unique for this object type"},"inputs":{"type":"array","description":"The deal IDs to read","required":true,"items":{"type":"string"}},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"propertiesWithHistory":{"type":"array","description":"A comma separated list of the properties to be returned along with their history of previous values","items":{"type":"string"}}}},"example":{"associations":[],"idProperty":"","inputs":[],"properties":[],"propertiesWithHistory":[]}}}}}},"/crm/objects/2026-03/deals/batch/create":{"post":{"tags":["CRM Objects Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/batch/create"},"summary":"Create a batch of deals","description":"Create a batch of deals","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The deals to create","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/deals/batch/update":{"post":{"tags":["CRM Objects Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/batch/update"},"summary":"Update a batch of deals","description":"Update a batch of deals","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The deals to update","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/deals/batch/archive":{"post":{"tags":["CRM Objects Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/batch/archive"},"summary":"Archive a batch of deals","description":"Archive a batch of deals","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The deal IDs to archive","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/deals/search":{"post":{"tags":["CRM Objects Deals"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/deals","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/deals/search"},"summary":"Search deals","description":"Search deals","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after":{"type":"string","description":"The paging cursor token"},"filterGroups":{"type":"array","description":"The filter groups to apply","items":{"type":"string"}},"limit":{"type":"number","description":"The maximum number of results to display per page"},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"query":{"type":"string","description":"The search query"},"sorts":{"type":"array","description":"The fields to sort by","items":{"type":"string"}}}},"example":{"after":"","filterGroups":[],"limit":"","properties":[],"query":"","sorts":[]}}}}}},"/crm/objects/2026-03/tickets":{"get":{"tags":["CRM Objects Tickets"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets"},"summary":"Read a page of tickets","description":"Read a page of tickets","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Objects Tickets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets"},"summary":"Create a ticket","description":"Create a ticket","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"Associations between the ticket and other objects","items":{"type":"string"}},"properties":{"type":"object","description":"The ticket's properties","required":true,"properties":{}}}},"example":{"associations":[],"properties":{}}}}}}},"/crm/objects/2026-03/tickets/{ticketId}":{"get":{"tags":["CRM Objects Tickets"],"parameters":[{"name":"ticketId","in":"path","description":"The ticket ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/{ticketId}"},"summary":"Read a ticket","description":"Read a ticket","security":[{"bearerAuth":[]}]},"patch":{"tags":["CRM Objects Tickets"],"parameters":[{"name":"ticketId","in":"path","description":"The ticket ID","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/{ticketId}"},"summary":"Update a ticket","description":"Update a ticket","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"object","description":"The ticket's properties","required":true,"properties":{}}}},"example":{"properties":{}}}}}},"delete":{"tags":["CRM Objects Tickets"],"parameters":[{"name":"ticketId","in":"path","description":"The ticket ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/{ticketId}"},"summary":"Delete a ticket","description":"Delete a ticket","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/objects/2026-03/tickets/batch/read":{"post":{"tags":["CRM Objects Tickets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/batch/read"},"summary":"Read a batch of tickets","description":"Read a batch of tickets","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"A comma separated list of object types to retrieve associated IDs for","items":{"type":"string"}},"idProperty":{"type":"string","description":"The name of a property whose values are unique for this object type"},"inputs":{"type":"array","description":"The ticket IDs to read","required":true,"items":{"type":"string"}},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"propertiesWithHistory":{"type":"array","description":"A comma separated list of the properties to be returned along with their history of previous values","items":{"type":"string"}}}},"example":{"associations":[],"idProperty":"","inputs":[],"properties":[],"propertiesWithHistory":[]}}}}}},"/crm/objects/2026-03/tickets/batch/create":{"post":{"tags":["CRM Objects Tickets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/batch/create"},"summary":"Create a batch of tickets","description":"Create a batch of tickets","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The tickets to create","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/tickets/batch/update":{"post":{"tags":["CRM Objects Tickets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/batch/update"},"summary":"Update a batch of tickets","description":"Update a batch of tickets","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The tickets to update","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/tickets/batch/archive":{"post":{"tags":["CRM Objects Tickets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/batch/archive"},"summary":"Archive a batch of tickets","description":"Archive a batch of tickets","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The ticket IDs to archive","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/tickets/search":{"post":{"tags":["CRM Objects Tickets"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/tickets","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/tickets/search"},"summary":"Search tickets","description":"Search tickets","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after":{"type":"string","description":"The paging cursor token"},"filterGroups":{"type":"array","description":"The filter groups to apply","items":{"type":"string"}},"limit":{"type":"number","description":"The maximum number of results to display per page"},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"query":{"type":"string","description":"The search query"},"sorts":{"type":"array","description":"The fields to sort by","items":{"type":"string"}}}},"example":{"after":"","filterGroups":[],"limit":"","properties":[],"query":"","sorts":[]}}}}}},"/crm/objects/2026-03/products":{"get":{"tags":["CRM Objects Products"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products"},"summary":"Read a page of products","description":"Read a page of products","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Objects Products"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products"},"summary":"Create a product","description":"Create a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"Associations between the product and other objects","items":{"type":"string"}},"properties":{"type":"object","description":"The product's properties","required":true,"properties":{}}}},"example":{"associations":[],"properties":{}}}}}}},"/crm/objects/2026-03/products/{productId}":{"get":{"tags":["CRM Objects Products"],"parameters":[{"name":"productId","in":"path","description":"The product ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/{productId}"},"summary":"Read a product","description":"Read a product","security":[{"bearerAuth":[]}]},"patch":{"tags":["CRM Objects Products"],"parameters":[{"name":"productId","in":"path","description":"The product ID","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/{productId}"},"summary":"Update a product","description":"Update a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"object","description":"The product's properties","required":true,"properties":{}}}},"example":{"properties":{}}}}}},"delete":{"tags":["CRM Objects Products"],"parameters":[{"name":"productId","in":"path","description":"The product ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/{productId}"},"summary":"Delete a product","description":"Delete a product","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/objects/2026-03/products/batch/read":{"post":{"tags":["CRM Objects Products"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/batch/read"},"summary":"Read a batch of products","description":"Read a batch of products","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"A comma separated list of object types to retrieve associated IDs for","items":{"type":"string"}},"idProperty":{"type":"string","description":"The name of a property whose values are unique for this object type"},"inputs":{"type":"array","description":"The product IDs to read","required":true,"items":{"type":"string"}},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"propertiesWithHistory":{"type":"array","description":"A comma separated list of the properties to be returned along with their history of previous values","items":{"type":"string"}}}},"example":{"associations":[],"idProperty":"","inputs":[],"properties":[],"propertiesWithHistory":[]}}}}}},"/crm/objects/2026-03/products/batch/create":{"post":{"tags":["CRM Objects Products"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/batch/create"},"summary":"Create a batch of products","description":"Create a batch of products","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The products to create","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/products/batch/update":{"post":{"tags":["CRM Objects Products"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/batch/update"},"summary":"Update a batch of products","description":"Update a batch of products","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The products to update","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/products/batch/archive":{"post":{"tags":["CRM Objects Products"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/batch/archive"},"summary":"Archive a batch of products","description":"Archive a batch of products","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The product IDs to archive","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/products/search":{"post":{"tags":["CRM Objects Products"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/products","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/products/search"},"summary":"Search products","description":"Search products","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after":{"type":"string","description":"The paging cursor token"},"filterGroups":{"type":"array","description":"The filter groups to apply","items":{"type":"string"}},"limit":{"type":"number","description":"The maximum number of results to display per page"},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"query":{"type":"string","description":"The search query"},"sorts":{"type":"array","description":"The fields to sort by","items":{"type":"string"}}}},"example":{"after":"","filterGroups":[],"limit":"","properties":[],"query":"","sorts":[]}}}}}},"/crm/objects/2026-03/line_items":{"get":{"tags":["CRM Objects Line Items"],"parameters":[{"name":"after","in":"query","description":"The paging cursor token of the last successfully read resource will be returned as the paging.next.after JSON property of a paged response containing more results","schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"limit","in":"query","description":"The maximum number of results to display per page","schema":{"type":"number","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items"},"summary":"Read a page of line items","description":"Read a page of line items","security":[{"bearerAuth":[]}]},"post":{"tags":["CRM Objects Line Items"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items"},"summary":"Create a line item","description":"Create a line item","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"Associations between the line item and other objects","items":{"type":"string"}},"properties":{"type":"object","description":"The line item's properties","required":true,"properties":{}}}},"example":{"associations":[],"properties":{}}}}}}},"/crm/objects/2026-03/line_items/{lineItemId}":{"get":{"tags":["CRM Objects Line Items"],"parameters":[{"name":"lineItemId","in":"path","description":"The line item ID","required":true,"schema":{"type":"string","example":""}},{"name":"archived","in":"query","description":"Whether to return only results that have been archived","schema":{"type":"boolean","example":"","items":{"type":"string","enum":[true,false]}}},{"name":"associations","in":"query","description":"A comma separated list of object types to retrieve associated IDs for","schema":{"type":"array","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}},{"name":"properties","in":"query","description":"A comma separated list of the properties to be returned in the response","schema":{"type":"array","example":""}},{"name":"propertiesWithHistory","in":"query","description":"A comma separated list of the properties to be returned along with their history of previous values","schema":{"type":"array","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/{lineItemId}"},"summary":"Read a line item","description":"Read a line item","security":[{"bearerAuth":[]}]},"patch":{"tags":["CRM Objects Line Items"],"parameters":[{"name":"lineItemId","in":"path","description":"The line item ID","required":true,"schema":{"type":"string","example":""}},{"name":"idProperty","in":"query","description":"The name of a property whose values are unique for this object type","schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/{lineItemId}"},"summary":"Update a line item","description":"Update a line item","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"properties":{"type":"object","description":"The line item's properties","required":true,"properties":{}}}},"example":{"properties":{}}}}}},"delete":{"tags":["CRM Objects Line Items"],"parameters":[{"name":"lineItemId","in":"path","description":"The line item ID","required":true,"schema":{"type":"string","example":""}}],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/{lineItemId}"},"summary":"Delete a line item","description":"Delete a line item","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{}},"example":{}}}}}},"/crm/objects/2026-03/line_items/batch/read":{"post":{"tags":["CRM Objects Line Items"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/batch/read"},"summary":"Read a batch of line items","description":"Read a batch of line items","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"associations":{"type":"array","description":"A comma separated list of object types to retrieve associated IDs for","items":{"type":"string"}},"idProperty":{"type":"string","description":"The name of a property whose values are unique for this object type"},"inputs":{"type":"array","description":"The line item IDs to read","required":true,"items":{"type":"string"}},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"propertiesWithHistory":{"type":"array","description":"A comma separated list of the properties to be returned along with their history of previous values","items":{"type":"string"}}}},"example":{"associations":[],"idProperty":"","inputs":[],"properties":[],"propertiesWithHistory":[]}}}}}},"/crm/objects/2026-03/line_items/batch/create":{"post":{"tags":["CRM Objects Line Items"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/batch/create"},"summary":"Create a batch of line items","description":"Create a batch of line items","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The line items to create","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/line_items/batch/update":{"post":{"tags":["CRM Objects Line Items"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/batch/update"},"summary":"Update a batch of line items","description":"Update a batch of line items","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The line items to update","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/line_items/batch/archive":{"post":{"tags":["CRM Objects Line Items"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/batch/archive"},"summary":"Archive a batch of line items","description":"Archive a batch of line items","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"inputs":{"type":"array","description":"The line item IDs to archive","required":true,"items":{"type":"string"}}}},"example":{"inputs":[]}}}}}},"/crm/objects/2026-03/line_items/search":{"post":{"tags":["CRM Objects Line Items"],"parameters":[],"responses":{"401":{"description":"Bearer token required (Authorization header)","content":{"application/json":{}}}},"externalDocs":{"api_ref":"https://developers.hubspot.com/docs/api/crm/line-items","api_endpoint":"https://api.hubapi.com/crm/objects/2026-03/line_items/search"},"summary":"Search line items","description":"Search line items","security":[{"bearerAuth":[]}],"requestBody":{"description":"","required":true,"content":{"application/json":{"schema":{"type":"object","required":[],"properties":{"after":{"type":"string","description":"The paging cursor token"},"filterGroups":{"type":"array","description":"The filter groups to apply","items":{"type":"string"}},"limit":{"type":"number","description":"The maximum number of results to display per page"},"properties":{"type":"array","description":"A comma separated list of the properties to be returned in the response","items":{"type":"string"}},"query":{"type":"string","description":"The search query"},"sorts":{"type":"array","description":"The fields to sort by","items":{"type":"string"}}}},"example":{"after":"","filterGroups":[],"limit":"","properties":[],"query":"","sorts":[]}}}}}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}}},"security":[{"bearerAuth":[]}]}