diff --git a/independent-publisher-connectors/HubSpot CRM/apiDefinition.swagger.json b/independent-publisher-connectors/HubSpot CRM/apiDefinition.swagger.json index be44b528bc..660466c003 100644 --- a/independent-publisher-connectors/HubSpot CRM/apiDefinition.swagger.json +++ b/independent-publisher-connectors/HubSpot CRM/apiDefinition.swagger.json @@ -21,9 +21,68 @@ "/crm/v3/objects/companies": { "get": { "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Company Record'", + "items": { + "$ref": "#/definitions/CompanyRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, "summary": "List companies", @@ -32,492 +91,89 @@ "x-ms-visibility": "important", "parameters": [ { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "x-ms-visibility": "important", - "description": "Limit", - "x-ms-summary": "limit", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/Limit" }, { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-summary": "properties", - "x-ms-url-encoding": "single", - "x-ms-visibility": "advanced" + "$ref": "#/parameters/After" }, { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-summary": "archived", - "x-ms-url-encoding": "single", - "x-ms-visibility": "advanced" + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" } ] }, "post": { "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CompanyRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid property values", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, "summary": "Create a company", - "description": "Create a company with the given properties and return a copy of the object, including the ID.", + "description": "Create a company with given properties then return a copy with the ID.", "operationId": "CompaniesCreate", "x-ms-visibility": "important", "parameters": [ { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "about_us": { - "title": "About Us", - "type": "string", - "description": "The company about us information." - }, - "address": { - "title": "Address", - "type": "string", - "description": "The first line of the street address." - }, - "address2": { - "title": "Address 2", - "type": "string", - "description": "The second line of the street address." - }, - "annualrevenue": { - "title": "Annual revenue", - "type": "string", - "description": "The company's annual revenue." - }, - "city": { - "title": "City", - "type": "string", - "description": "The address city." - }, - "closedate": { - "title": "Close date", - "type": "string", - "description": "The close date." - }, - "country": { - "title": "Country", - "type": "string", - "description": "The address country." - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "days_to_close": { - "title": "Days to close", - "type": "string", - "description": "The estimated days to close." - }, - "description": { - "title": "Description", - "type": "string", - "description": "A description of the object." - }, - "domain": { - "title": "Domain", - "type": "string", - "description": "The company's domain." - }, - "engagements_last_meeting_booked": { - "title": "Engagements last meeting booked", - "type": "string", - "description": "The engagements last meeting booked." - }, - "engagements_last_meeting_booked_campaign": { - "title": "Engagements last meeting booked campaign", - "type": "string", - "description": "The engagements last meeting booked campaign." - }, - "engagements_last_meeting_booked_medium": { - "title": "Engagements last meeting booked medium", - "type": "string", - "description": "The engagements last meeting booked medium." - }, - "engagements_last_meeting_booked_source": { - "title": "Engagements last meeting booked source", - "type": "string", - "description": "The engagements last meeting booked source." - }, - "facebook_company_page": { - "title": "Facebook company page", - "type": "string", - "description": "The company's Facebook page." - }, - "facebookfans": { - "title": "Facebook fans", - "type": "string", - "description": "Facebook fans." - }, - "first_contact_createdate": { - "title": "first contact create date", - "type": "string", - "description": "The first contact created on date." - }, - "first_conversion_date": { - "title": "First conversion date", - "type": "string", - "description": "The first conversion date." - }, - "first_conversion_event_name": { - "title": "First conversion event name", - "type": "string", - "description": "The first conversion event name." - }, - "first_deal_created_date": { - "title": "First deal created date", - "type": "string", - "description": "The first deal created date." - }, - "founded_year": { - "title": "Founded year", - "type": "string", - "description": "The company's founded year." - }, - "googleplus_page": { - "title": "GooglePlus page", - "type": "string", - "description": "The company's GooglePlus page." - }, - "hs_analytics_first_timestamp": { - "title": "HubSpot analytics first timestamp", - "type": "string", - "description": "HubSpot Analytics - first timestamp." - }, - "hs_analytics_first_touch_converting_campaign": { - "title": "HubSpot analytics first touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - first touch converting campaign." - }, - "hs_analytics_first_visit_timestamp": { - "title": "HubSpot Analytics first visit timestamp", - "type": "string", - "description": "HubSpot Analytics - first visit timestamp" - }, - "hs_analytics_last_timestamp": { - "title": "HubSpot analytics last timestamp", - "type": "string", - "description": "HubSpot Analytics - last timestamp." - }, - "hs_analytics_last_touch_converting_campaign": { - "title": "HubSpot analytics last touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - last touch converting campaign." - }, - "hs_analytics_last_visit_timestamp": { - "title": "HubSpot analytics last visit timestamp", - "type": "string", - "description": "HubSpot Analytics - last visit timestamp." - }, - "hs_analytics_num_page_views": { - "title": "HubSpot analytics number of page views", - "type": "string", - "description": "HubSpot Analytics - number of page views." - }, - "hs_analytics_num_visits": { - "title": "HubSpot analytics number of visits", - "type": "string", - "description": "HubSpot Analytics - number of visits." - }, - "hs_analytics_source": { - "title": "HubSpot analytics source", - "type": "string", - "description": "HubSpot Analytics - source." - }, - "hs_analytics_source_data_1": { - "title": "HubSpot analytics source data 1", - "type": "string", - "description": "HubSpot Analytics - source data 1." - }, - "hs_analytics_source_data_2": { - "title": "HubSpot analytics source data 2", - "type": "string", - "description": "HubSpot Analytics - source data 2." - }, - "hs_createdate": { - "title": "Create date", - "type": "string", - "description": "HubSpot - create date." - }, - "hs_ideal_customer_profile": { - "title": "HubSpot ideal customer profile", - "type": "string", - "description": "HubSpot - ideal customer profile." - }, - "hs_is_target_account": { - "title": "HubSpot is target account", - "type": "string", - "description": "HubSpot - is target account." - }, - "hs_last_booked_meeting_date": { - "title": "HubSpot last booked meeting date", - "type": "string", - "description": "HubSpot - last booked meeting date." - }, - "hs_last_logged_call_date": { - "title": "HubSpot last logged call date", - "type": "string", - "description": "HubSpot - last logged call date." - }, - "hs_last_open_task_date": { - "title": "HubSpot last open task date", - "type": "string", - "description": "HubSpot - last open task date." - }, - "hs_last_sales_activity_timestamp": { - "title": "HubSpot last sales activity timestamp", - "type": "string", - "description": "HubSpot - last sales activity timestamp." - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_lead_status": { - "title": "HubSpot lead status", - "type": "string", - "description": "HubSpot - lead status." - }, - "hs_num_blockers": { - "title": "HubSpot number of blockers", - "type": "string", - "description": "HubSpot - number of blockers." - }, - "hs_num_child_companies": { - "title": "HubSpot number of child companies", - "type": "string", - "description": "HubSpot - number of child companies." - }, - "hs_num_contacts_with_buying_roles": { - "title": "HubSpot number of contacts with buying roles", - "type": "string", - "description": "HubSpot - number of contacts with buying roles." - }, - "hs_num_decision_makers": { - "title": "HubSpot number of decision makers", - "type": "string", - "description": "HubSpot - number of decision makers." - }, - "hs_num_open_deals": { - "title": "HubSpot number of open deals", - "type": "string", - "description": "HubSpot - number of open deals." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_parent_company_id": { - "title": "HubSpot parent company ID", - "type": "string", - "description": "HubSpot - parent company ID." - }, - "hs_predictivecontactscore_v2": { - "title": "HubSpot predictive contact score v2", - "type": "string", - "description": "HubSpot - predictive contact score V2" - }, - "hs_total_deal_value": { - "title": "HubSpot total deal value", - "type": "string", - "description": "HubSpot - total deal value." - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", - "type": "string", - "description": "HubSpot - owner ID." - }, - "hubspot_team_id": { - "title": "HubSpot team ID", - "type": "string", - "description": "HubSpot - team ID." - }, - "industry": { - "title": "Industry", - "type": "string", - "description": "Industry." - }, - "is_public": { - "title": "Is public", - "type": "string", - "description": "Whether is public." - }, - "lifecyclestage": { - "title": "Lifecycle stage", - "type": "string", - "description": "The current lifecycle stage." - }, - "linkedin_company_page": { - "title": "LinkedIn company page", - "type": "string", - "description": "The company's LinkedIn page." - }, - "linkedinbio": { - "title": "LinkedIn bio", - "type": "string", - "description": "LinkedIn bio." - }, - "name": { - "title": "Name", - "type": "string", - "description": "Name." - }, - "notes_last_contacted": { - "title": "Notes last contacted", - "type": "string", - "description": "Notes - last contacted." - }, - "notes_last_updated": { - "title": "Notes last updated", - "type": "string", - "description": "Notes - last updated." - }, - "notes_next_activity_date": { - "title": "Notes next activity date", - "type": "string", - "description": "Notes - next activity date." - }, - "num_associated_contacts": { - "title": "Number of associated contacts", - "type": "string", - "description": "The number of associated contacts." - }, - "num_associated_deals": { - "title": "Number of associated deals", - "type": "string", - "description": "The number of associated deals." - }, - "num_contacted_notes": { - "title": "Number of contacted notes", - "type": "string", - "description": "The number of contacted notes" - }, - "num_conversion_events": { - "title": "Number of conversion events", - "type": "string", - "description": "The number of conversion events." - }, - "numberofemployees": { - "title": "Number of employees", - "type": "string", - "description": "The number of employees." - }, - "phone": { - "title": "Phone", - "type": "string", - "description": "Phone number." - }, - "recent_conversion_date": { - "title": "Recent conversion date", - "type": "string", - "description": "Recent conversion date." - }, - "recent_conversion_event_name": { - "title": "Recent conversion event name", - "type": "string", - "description": "Recent conversion event name." - }, - "recent_deal_amount": { - "title": "Recent deal amount", - "type": "string", - "description": "Recent deal amount." - }, - "recent_deal_close_date": { - "title": "Recent deal close date", - "type": "string", - "description": "Recent deal close date." - }, - "state": { - "title": "State", - "type": "string", - "description": "The address state." - }, - "timezone": { - "title": "Timezone", - "type": "string", - "description": "Timezone." - }, - "total_money_raised": { - "title": "Total money raised", - "type": "string", - "description": "Total money raised." - }, - "total_revenue": { - "title": "Total revenue", - "type": "string", - "description": "Total revenue" - }, - "twitterbio": { - "title": "Twitter bio", - "type": "string", - "description": "Twitter bio" - }, - "twitterfollowers": { - "title": "Twitter followers", - "type": "string", - "description": "Twitter followers" - }, - "twitterhandle": { - "title": "Twitter handle", - "type": "string", - "description": "Twitter handle" - }, - "type": { - "title": "Type", - "type": "string", - "description": "type" - }, - "web_technologies": { - "title": "Web technologies", - "type": "string", - "description": "Web technologies." - }, - "website": { - "title": "Website", - "type": "string", - "description": "Website." - }, - "zip": { - "title": "Zip code", - "type": "string", - "description": "The address zip." - } - }, - "required": [ - "name" - ] - } - } - } + "$ref": "#/parameters/CompanyEntry" } ] } @@ -525,9 +181,56 @@ "/crm/v3/objects/companies/{companyId}": { "get": { "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CompanyRecord" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, "summary": "Get a company", @@ -536,42 +239,74 @@ "x-ms-visibility": "important", "parameters": [ { - "name": "companyId", - "in": "path", - "required": true, - "type": "string", - "description": "The companyId of the company", - "x-ms-summary": "companyID", - "x-ms-url-encoding": "single", - "x-ms-visibility": "important" + "$ref": "#/parameters/CompanyID" }, { - "name": "properies", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "advanced", - "x-ms-summary": "properties", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/ReturnProperties" }, { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "description": "Whether to return only companies that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-summary": "archived", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" } ] }, "delete": { "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, "summary": "Delete a company", @@ -580,22 +315,62 @@ "x-ms-visibility": "important", "parameters": [ { - "name": "companyId", - "in": "path", - "required": true, - "type": "string", - "description": "The companyId of the company", - "x-ms-visibility": "important", - "x-ms-summary": "companyID", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/CompanyID" } ] }, "patch": { "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CompanyRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, "summary": "Update a company", @@ -603,457 +378,93 @@ "operationId": "CompaniesUpdate", "parameters": [ { - "name": "companyId", - "in": "path", - "required": true, - "type": "string", - "description": "The companyId of the company.", - "x-ms-visibility": "important", - "x-ms-summary": "companyId", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/CompanyID" + }, + { + "$ref": "#/parameters/CompanyEntry" }, { - "name": "properties", - "in": "body", - "required": true, + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/companies/search": { + "post": { + "responses": { + "200": { + "description": "OK", "schema": { "type": "object", "properties": { - "properties": { - "type": "object", - "properties": { - "about_us": { - "title": "About us", - "type": "string", - "description": "The company about us information." - }, - "address": { - "title": "Address", - "type": "string", - "description": "The first line of the street address." - }, - "address2": { - "title": "Address 2", - "type": "string", - "description": "The second line of the street address." - }, - "annualrevenue": { - "title": "Annual revenue", - "type": "string", - "description": "The company's annual revenue." - }, - "city": { - "title": "City", - "type": "string", - "description": "The address city." - }, - "closedate": { - "title": "Close date", - "type": "string", - "description": "The close date." - }, - "country": { - "title": "Country", - "type": "string", - "description": "The address country." - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "days_to_close": { - "title": "Days to close", - "type": "string", - "description": "The estimated days to close." - }, - "description": { - "title": "Description", - "type": "string", - "description": "A description of the object." - }, - "domain": { - "title": "Domain", - "type": "string", - "description": "The company's domain." - }, - "engagements_last_meeting_booked": { - "title": "Engagements last meeting booked", - "type": "string", - "description": "The engagements last meeting booked." - }, - "engagements_last_meeting_booked_campaign": { - "title": "Engagements last meeting booked campaign", - "type": "string", - "description": "The engagements last meeting booked campaign." - }, - "engagements_last_meeting_booked_medium": { - "title": "Engagements last meeting booked medium", - "type": "string", - "description": "The engagements last meeting booked medium." - }, - "engagements_last_meeting_booked_source": { - "title": "Engagements last meeting booked source", - "type": "string", - "description": "The engagements last meeting booked source." - }, - "facebook_company_page": { - "title": "Facebook company page", - "type": "string", - "description": "The company's Facebook page." - }, - "facebookfans": { - "title": "Facebook fans", - "type": "string", - "description": "Facebook fans." - }, - "first_contact_createdate": { - "title": "first contact create date", - "type": "string", - "description": "The first contact created on date." - }, - "first_conversion_date": { - "title": "First conversion date", - "type": "string", - "description": "The first conversion date." - }, - "first_conversion_event_name": { - "title": "First conversion event name", - "type": "string", - "description": "The first conversion event name." - }, - "first_deal_created_date": { - "title": "First deal created date", - "type": "string", - "description": "The first deal created date." - }, - "founded_year": { - "title": "Founded year", - "type": "string", - "description": "The company's founded year." - }, - "googleplus_page": { - "title": "GooglePlus page", - "type": "string", - "description": "The company's GooglePlus page." - }, - "hs_analytics_first_timestamp": { - "title": "HubSpot analytics first timestamp", - "type": "string", - "description": "HubSpot Analytics - first timestamp." - }, - "hs_analytics_first_touch_converting_campaign": { - "title": "HubSpot analytics first touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - first touch converting campaign." - }, - "hs_analytics_first_visit_timestamp": { - "title": "HubSpot Analytics first visit timestamp", - "type": "string", - "description": "HubSpot Analytics - first visit timestamp" - }, - "hs_analytics_last_timestamp": { - "title": "HubSpot analytics last timestamp", - "type": "string", - "description": "HubSpot Analytics - last timestamp." - }, - "hs_analytics_last_touch_converting_campaign": { - "title": "HubSpot analytics last touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - last touch converting campaign." - }, - "hs_analytics_last_visit_timestamp": { - "title": "HubSpot analytics last visit timestamp", - "type": "string", - "description": "HubSpot Analytics - last visit timestamp." - }, - "hs_analytics_num_page_views": { - "title": "HubSpot analytics number of page views", - "type": "string", - "description": "HubSpot Analytics - number of page views." - }, - "hs_analytics_num_visits": { - "title": "HubSpot analytics number of visits", - "type": "string", - "description": "HubSpot Analytics - number of visits." - }, - "hs_analytics_source": { - "title": "HubSpot analytics source", - "type": "string", - "description": "HubSpot Analytics - source." - }, - "hs_analytics_source_data_1": { - "title": "HubSpot analytics source data 1", - "type": "string", - "description": "HubSpot Analytics - source data 1." - }, - "hs_analytics_source_data_2": { - "title": "HubSpot analytics source data 2", - "type": "string", - "description": "HubSpot Analytics - source data 2." - }, - "hs_createdate": { - "title": "Create date", - "type": "string", - "description": "HubSpot - create date." - }, - "hs_ideal_customer_profile": { - "title": "HubSpot ideal customer profile", - "type": "string", - "description": "HubSpot - ideal customer profile." - }, - "hs_is_target_account": { - "title": "HubSpot is target account", - "type": "string", - "description": "HubSpot - is target account." - }, - "hs_last_booked_meeting_date": { - "title": "HubSpot last booked meeting date", - "type": "string", - "description": "HubSpot - last booked meeting date." - }, - "hs_last_logged_call_date": { - "title": "HubSpot last logged call date", - "type": "string", - "description": "HubSpot - last logged call date." - }, - "hs_last_open_task_date": { - "title": "HubSpot last open task date", - "type": "string", - "description": "HubSpot - last open task date." - }, - "hs_last_sales_activity_timestamp": { - "title": "HubSpot last sales activity timestamp", - "type": "string", - "description": "HubSpot - last sales activity timestamp." - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_lead_status": { - "title": "HubSpot lead status", - "type": "string", - "description": "HubSpot - lead status." - }, - "hs_num_blockers": { - "title": "HubSpot number of blockers", - "type": "string", - "description": "HubSpot - number of blockers." - }, - "hs_num_child_companies": { - "title": "HubSpot number of child companies", - "type": "string", - "description": "HubSpot - number of child companies." - }, - "hs_num_contacts_with_buying_roles": { - "title": "HubSpot number of contacts with buying roles", - "type": "string", - "description": "HubSpot - number of contacts with buying roles." - }, - "hs_num_decision_makers": { - "title": "HubSpot number of decision makers", - "type": "string", - "description": "HubSpot - number of decision makers." - }, - "hs_num_open_deals": { - "title": "HubSpot number of open deals", - "type": "string", - "description": "HubSpot - number of open deals." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_parent_company_id": { - "title": "HubSpot parent company ID", - "type": "string", - "description": "HubSpot - parent company ID." - }, - "hs_predictivecontactscore_v2": { - "title": "HubSpot predictive contact score v2", - "type": "string", - "description": "HubSpot - predictive contact score V2" - }, - "hs_total_deal_value": { - "title": "HubSpot total deal value", - "type": "string", - "description": "HubSpot - total deal value." - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", - "type": "string", - "description": "HubSpot - owner ID." - }, - "hubspot_team_id": { - "title": "HubSpot team ID", - "type": "string", - "description": "HubSpot - team ID." - }, - "industry": { - "title": "Industry", - "type": "string", - "description": "Industry." - }, - "is_public": { - "title": "Is public", - "type": "string", - "description": "Whether is public." - }, - "lifecyclestage": { - "title": "Lifecycle stage", - "type": "string", - "description": "The current lifecycle stage." - }, - "linkedin_company_page": { - "title": "LinkedIn company page", - "type": "string", - "description": "The company's LinkedIn page." - }, - "linkedinbio": { - "title": "LinkedIn bio", - "type": "string", - "description": "LinkedIn bio." - }, - "name": { - "title": "Name", - "type": "string", - "description": "Name." - }, - "notes_last_contacted": { - "title": "Notes last contacted", - "type": "string", - "description": "Notes - last contacted." - }, - "notes_last_updated": { - "title": "Notes last updated", - "type": "string", - "description": "Notes - last updated." - }, - "notes_next_activity_date": { - "title": "Notes next activity date", - "type": "string", - "description": "Notes - next activity date." - }, - "num_associated_contacts": { - "title": "Number of associated contacts", - "type": "string", - "description": "The number of associated contacts." - }, - "num_associated_deals": { - "title": "Number of associated deals", - "type": "string", - "description": "The number of associated deals." - }, - "num_contacted_notes": { - "title": "Number of contacted notes", - "type": "string", - "description": "The number of contacted notes" - }, - "num_conversion_events": { - "title": "Number of conversion events", - "type": "string", - "description": "The number of conversion events." - }, - "numberofemployees": { - "title": "Number of employees", - "type": "string", - "description": "The number of employees." - }, - "phone": { - "title": "Phone", - "type": "string", - "description": "Phone number." - }, - "recent_conversion_date": { - "title": "Recent conversion date", - "type": "string", - "description": "Recent conversion date." - }, - "recent_conversion_event_name": { - "title": "Recent conversion event name", - "type": "string", - "description": "Recent conversion event name." - }, - "recent_deal_amount": { - "title": "Recent deal amount", - "type": "string", - "description": "Recent deal amount." - }, - "recent_deal_close_date": { - "title": "Recent deal close date", - "type": "string", - "description": "Recent deal close date." - }, - "state": { - "title": "State", - "type": "string", - "description": "The address state." - }, - "timezone": { - "title": "Timezone", - "type": "string", - "description": "Timezone." - }, - "total_money_raised": { - "title": "Total money raised", - "type": "string", - "description": "Total money raised." - }, - "total_revenue": { - "title": "Total revenue", - "type": "string", - "description": "Total revenue" - }, - "twitterbio": { - "title": "Twitter bio", - "type": "string", - "description": "Twitter bio" - }, - "twitterfollowers": { - "title": "Twitter followers", - "type": "string", - "description": "Twitter followers" - }, - "twitterhandle": { - "title": "Twitter handle", - "type": "string", - "description": "Twitter handle" - }, - "type": { - "title": "Type", - "type": "string", - "description": "type" - }, - "web_technologies": { - "title": "Web technologies", - "type": "string", - "description": "Web technologies." - }, - "website": { - "title": "Website", - "type": "string", - "description": "Website." - }, - "zip": { - "title": "Zip code", - "type": "string", - "description": "The address zip." - } - }, - "required": [ - "name" - ] + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Company Record'", + "items": { + "$ref": "#/definitions/CompanyRecord" + } } } } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Search for companies", + "description": "Search for a company with the given filters and return a list.", + "operationId": "CompaniesSearch", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Search" } ] } @@ -1061,3485 +472,6210 @@ "/crm/v3/objects/contacts": { "get": { "responses": { - "default": { - "description": "The default response.", - "schema": {} - } - }, - "summary": "List contacts", - "description": "Read a list of contacts.", + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Contact Record'", + "items": { + "$ref": "#/definitions/ContactRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "List contacts", + "description": "Read a list of contacts.", "operationId": "ContactsList", "x-ms-visibility": "important", "parameters": [ { - "name": "limit", - "in": "query", - "required": true, - "type": "integer", - "default": 10, - "x-ms-visibility": "important", - "description": "The maximum number of results to return", - "x-ms-summary": "limit", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/Limit" }, { - "name": "properties[]", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "advanced", - "x-ms-summary": "properties", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/After" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" } ] }, "post": { "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContactRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid property values", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, "summary": "Create a contact", - "description": "Create a contact with the given properties and return a copy of the object, including the ID.", + "description": "Create a contact with the given properties and return a copy with the ID.", "operationId": "ContactsCreate", "x-ms-visibility": "important", "parameters": [ { - "name": "body", - "in": "body", - "required": true, + "$ref": "#/parameters/ContactEntry" + } + ] + } + }, + "/crm/v3/objects/contacts/{contactId}": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContactRecord" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Get a contact", + "description": "Read a contact identified by {contactId}.", + "operationId": "ContactsRead", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ContactID" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + }, + "delete": { + "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Delete a contact", + "description": "Move a contact identified by {contactId} to the recycling bin.", + "operationId": "ContactsArchive", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ContactID" + } + ] + }, + "patch": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContactRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Update a contact", + "description": "Perform a partial update of a contact identified by {contactId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "ContactsUpdate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ContactID" + }, + { + "$ref": "#/parameters/ContactEntry" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/contacts/search": { + "post": { + "responses": { + "200": { + "description": "OK", "schema": { "type": "object", "properties": { - "properties": { - "type": "object", - "properties": { - "address": { - "title": "Address", - "type": "string", - "description": "The first line of the street address." - }, - "annualrevenue": { - "title": "Annual revenue", - "type": "string", - "description": "The company's annual revenue." - }, - "city": { - "title": "City", - "type": "string", - "description": "The address city." - }, - "closedate": { - "title": "Close date", - "type": "string", - "description": "The close date." - }, - "company": { - "title": "Company", - "type": "string", - "description": "Company." - }, - "company_size": { - "title": "Company size", - "type": "string", - "description": "Company size." - }, - "country": { - "title": "Country", - "type": "string", - "description": "The address country." - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "currentlyinworkflow": { - "title": "Currenly in workflow", - "type": "string", - "description": "Currently in workflow." - }, - "date_of_birth": { - "title": "Date of birth", - "type": "string", - "description": "Date of birth." - }, - "days_to_close": { - "title": "Days to close", - "type": "string", - "description": "The estimated days to close." - }, - "degree": { - "title": "Degree", - "type": "string", - "description": "Degree held." - }, - "email": { - "title": "Email", - "type": "string", - "description": "Email." - }, - "engagements_last_meeting_booked": { - "title": "Engagements last meeting booked", - "type": "string", - "description": "The engagements last meeting booked." - }, - "engagements_last_meeting_booked_campaign": { - "title": "Engagements last meeting booked campaign", - "type": "string", - "description": "The engagements last meeting booked campaign." - }, - "engagements_last_meeting_booked_medium": { - "title": "Engagements last meeting booked medium", - "type": "string", - "description": "The engagements last meeting booked medium." - }, - "engagements_last_meeting_booked_source": { - "title": "Engagements last meeting booked source", - "type": "string", - "description": "The engagements last meeting booked source." - }, - "fax": { - "title": "Fax", - "type": "string", - "description": "Fax number." - }, - "field_of_study": { - "title": "Field of study", - "type": "string", - "description": "Field of study." - }, - "first_conversion_date": { - "title": "First conversion date", - "type": "string", - "description": "The first conversion date." - }, - "first_conversion_event_name": { - "title": "First conversion event name", - "type": "string", - "description": "The first conversion event name." - }, - "first_deal_created_date": { - "title": "First deal created date", - "type": "string", - "description": "The first deal created date." - }, - "firstname": { - "title": "First name", - "type": "string", - "description": "First name." - }, - "gender": { - "title": "Gender", - "type": "string", - "description": "Gender." - }, - "graduation_date": { - "title": "Graduation date", - "type": "string", - "description": "Graduation date." - }, - "hs_analytics_average_page_views": { - "title": "HubSpot analytics average page views", - "type": "string", - "description": "HubSpot Analytics - average page views." - }, - "hs_analytics_first_referrer": { - "title": "HubSpot analytics first referrer", - "type": "string", - "description": "HubSpot Analytics - first referrer." - }, - "hs_analytics_first_timestamp": { - "title": "HubSpot analytics first timestamp", - "type": "string", - "description": "HubSpot Analytics - first timestamp." - }, - "hs_analytics_first_touch_converting_campaign": { - "title": "HubSpot analytics first touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - first touch converting campaign." - }, - "hs_analytics_first_url": { - "title": "HubSpot analytics first URL", - "type": "string", - "description": "HubSpot Analytics - first_url" - }, - "hs_analytics_first_visit_timestamp": { - "title": "HubSpot Analytics first visit timestamp", - "type": "string", - "description": "HubSpot Analytics - first visit timestamp" - }, - "hs_analytics_last_referrer": { - "title": "HubSpot analytics last referrer", - "type": "string", - "description": "HubSpot Analytics - last referrer." - }, - "hs_analytics_last_timestamp": { - "title": "HubSpot analytics last timestamp", - "type": "string", - "description": "HubSpot Analytics - last timestamp." - }, - "hs_analytics_last_touch_converting_campaign": { - "title": "HubSpot analytics last touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - last touch converting campaign." - }, - "hs_analytics_last_url": { - "title": "HubSpot analytics last URL", - "type": "string", - "description": "HubSpot Analytics - last URL." - }, - "hs_analytics_last_visit_timestamp": { - "title": "HubSpot analytics last visit timestamp", - "type": "string", - "description": "HubSpot Analytics - last visit timestamp." - }, - "hs_analytics_num_event_completions": { - "title": "HubSpot analytics number of event completions", - "type": "string", - "description": "HubSpot Analytics - number of event completions. " - }, - "hs_analytics_num_page_views": { - "title": "HubSpot analytics number of page views", - "type": "string", - "description": "HubSpot Analytics - number of page views." - }, - "hs_analytics_num_visits": { - "title": "HubSpot analytics number of visits", - "type": "string", - "description": "HubSpot Analytics - number of visits." - }, - "hs_analytics_revenue": { - "title": "HubSpot analytics revenue", - "type": "string", - "description": "HubSpot Analytics - revenue" - }, - "hs_analytics_source": { - "title": "HubSpot analytics source", - "type": "string", - "description": "HubSpot Analytics - source." - }, - "hs_analytics_source_data_1": { - "title": "HubSpot analytics source data 1", - "type": "string", - "description": "HubSpot Analytics - source data 1." - }, - "hs_analytics_source_data_2": { - "title": "HubSpot analytics source data 2", - "type": "string", - "description": "HubSpot Analytics - source data 2." - }, - "hs_buying_role": { - "title": "HubSpot buying role", - "type": "string", - "description": "HubSpot - buying_role" - }, - "hs_content_membership_email_confirmed": { - "title": "HubSpot content membership email confirmed", - "type": "string", - "description": "HubSpot - content membership email confirmed." - }, - "hs_content_membership_notes": { - "title": "HubSpot content membership notes", - "type": "string", - "description": "HubSpot - content membership notes" - }, - "hs_content_membership_registered_at": { - "title": "HubSpot content membership registered at", - "type": "string", - "description": "HubSpot - content membership registered at." - }, - "hs_content_membership_registration_domain_sent_to": { - "title": "HubSpot content membership registration domain sent to", - "type": "string", - "description": "HubSpot - content membership registration domain sent to." - }, - "hs_content_membership_registration_email_sent_at": { - "title": "HubSpot content membership registration email sent at", - "type": "string", - "description": "HubSpot - content membership registration email sent at." - }, - "hs_content_membership_status": { - "title": "HubSpot content membership status", - "type": "string", - "description": "HubSpot - content membership status" - }, - "hs_createdate": { - "title": "Create date", - "type": "string", - "description": "HubSpot - create date." - }, - "hs_email_bad_address": { - "title": "HubSpot email bad address", - "type": "string", - "description": "HubSpot - email bad address" - }, - "hs_email_bounce": { - "title": "HubSpot email bounce", - "type": "string", - "description": "HubSpot - email bounce" - }, - "hs_email_click": { - "title": "HubSpot email click", - "type": "string", - "description": "HubSpot - email click" - }, - "hs_email_customer_quarantined_reason": { - "title": "HubSpot email customer quarnatined reason", - "type": "string", - "description": "HubSpot - email customer quarantined reason." - }, - "hs_email_delivered": { - "title": "HubSpot email delivered", - "type": "string", - "description": "HubSpot - email delivered" - }, - "hs_email_domain": { - "title": "Domain", - "type": "string", - "description": "HubSpot - email domain" - }, - "hs_email_first_click_date": { - "title": "HubSpot email first click date", - "type": "string", - "description": "HubSpot - email first click date." - }, - "hs_email_first_open_date": { - "title": "HubSpot email first open date", - "type": "string", - "description": "HubSpot - email first open date." - }, - "hs_email_first_reply_date": { - "title": "HubSpot email first reply date", - "type": "string", - "description": "HubSpot - email first reply date." - }, - "hs_email_first_send_date": { - "title": "HubSpot email first send date", - "type": "string", - "description": "HubSpot - email first send date." - }, - "hs_email_hard_bounce_reason_enum": { - "title": "HubSpot email hard bounce reason enumerated", - "type": "string", - "description": "HubSpot - email hard bounce reason enumerated." - }, - "hs_email_last_click_date": { - "title": "HubSpot email last click date", - "type": "string", - "description": "HubSpot - email last click date." - }, - "hs_email_last_email_name": { - "title": "HubSpot email last email name", - "type": "string", - "description": "HubSpot - email last email name." - }, - "hs_email_last_open_date": { - "title": "HubSpot email last open date", - "type": "string", - "description": "HubSpot - email last open date." - }, - "hs_email_last_reply_date": { - "title": "HubSpot email last reply date", - "type": "string", - "description": "HubSpot - email last reply date." - }, - "hs_email_last_send_date": { - "title": "HubSpot email last send date", - "type": "string", - "description": "HubSpot - email last send date." - }, - "hs_email_open": { - "title": "HubSpot email open", - "type": "string", - "description": "HubSpot - email open" - }, - "hs_email_optout": { - "title": "HubSpot email optout", - "type": "string", - "description": "HubSpot - email optout" - }, - "hs_email_optout_12592317": { - "title": "HubSpot email optout 12592317", - "type": "string", - "description": "HubSpot - email optout 12592317" - }, - "hs_email_quarantined": { - "title": "HubSpot email quarantied", - "type": "string", - "description": "HubSpot - email quarantined" - }, - "hs_email_quarantined_reason": { - "title": "HubSpot email quarantied reason", - "type": "string", - "description": "HubSpot - email quarantined reason." - }, - "hs_email_replied": { - "title": "HubSpot email replied", - "type": "string", - "description": "HubSpot - email replied" - }, - "hs_email_sends_since_last_engagement": { - "title": "HubSpot email sends since last engagement", - "type": "string", - "description": "HubSpot - email sends since last engagement." - }, - "hs_emailconfirmationstatus": { - "title": "HubSpot email confirmation status", - "type": "string", - "description": "HubSpot - email confirmation status." - }, - "hs_facebook_click_id": { - "title": "HubSpot Facebook click ID", - "type": "string", - "description": "HubSpot - Facebook click ID." - }, - "hs_feedback_last_nps_follow_up": { - "title": "HubSpot feecback last NPS follow up", - "type": "string", - "description": "HubSpot - feedback last NPS follow up." - }, - "hs_feedback_last_nps_rating": { - "title": "HubSpot feedback last NPS rating", - "type": "string", - "description": "HubSpot - feedback last NPS rating." - }, - "hs_feedback_last_survey_date": { - "title": "HubSpot feedback last survey date", - "type": "string", - "description": "HubSpot - feedback last survey date." - }, - "hs_google_click_id": { - "title": "HubSpot Google click ID", - "type": "string", - "description": "HubSpot - Google click ID." - }, - "hs_ip_timezone": { - "title": "HubSpot IP timezone", - "type": "string", - "description": "HubSpot - IP timezone." - }, - "hs_is_unworked": { - "title": "HubSpot is unworked", - "type": "string", - "description": "HubSpot - is unworked." - }, - "hs_language": { - "title": "HubSpot language", - "type": "string", - "description": "HubSpot - language" - }, - "hs_last_sales_activity_timestamp": { - "title": "HubSpot last sales activity timestamp", - "type": "string", - "description": "HubSpot - last sales activity timestamp." - }, - "hs_lead_status": { - "title": "HubSpot lead status", - "type": "string", - "description": "HubSpot - lead status." - }, - "hs_legal_basis": { - "title": "HubSpot legal basis", - "type": "string", - "description": "HubSpot - legal basis." - }, - "hs_lifecyclestage_customer_date": { - "title": "HubSpot lifecycle stage customer date", - "type": "string", - "description": "HubSpot - lifecycle stage customer date." - }, - "hs_lifecyclestage_evangelist_date": { - "title": "HubSpot lifecycle stage evangelist date", - "type": "string", - "description": "HubSpot - lifecycle stage evangelist date." - }, - "hs_lifecyclestage_lead_date": { - "title": "HubSpot lifecycle stage lead date", - "type": "string", - "description": "HubSpot - lifecycle stage lead date." - }, - "hs_lifecyclestage_marketingqualifiedlead_date": { - "title": "HubSpot lifecycle stage marketing qualitifed lead date", - "type": "string", - "description": "HubSpot - lifecycle stage marketing qualified lead date." - }, - "hs_lifecyclestage_opportunity_date": { - "title": "HubSpot lifecycle stage opportunity date", - "type": "string", - "description": "HubSpot - lifecycle stage opportunity date." - }, - "hs_lifecyclestage_other_date": { - "title": "HubSpot lifecycle stage other date", - "type": "string", - "description": "HubSpot - lifecycle stage other date." - }, - "hs_lifecyclestage_salesqualifiedlead_date": { - "title": "HubSpot lifecycle stage sales qualified lead date", - "type": "string", - "description": "HubSpot - lifecycle stage sales qualified lead date." - }, - "hs_lifecyclestage_subscriber_date": { - "title": "HubSpot lifecycle stage subscriber date", - "type": "string", - "description": "HubSpot - lifecycle stage subscriber date." - }, - "hs_marketable_reason_id": { - "title": "HubSpot marketable reason ID", - "type": "string", - "description": "HubSpot - marketable reason ID." - }, - "hs_marketable_reason_type": { - "title": "HubSpot marketable reason type", - "type": "string", - "description": "HubSpot - marketable reason type." - }, - "hs_marketable_status": { - "title": "HubSpot marketable status", - "type": "string", - "description": "HubSpot - marketable status" - }, - "hs_marketable_until_renewal": { - "title": "HubSpot marketable until renewal", - "type": "string", - "description": "HubSpot - marketable until renewal." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_persona": { - "title": "HubSpot persona", - "type": "string", - "description": "HubSpot - persona" - }, - "hs_predictivecontactscore": { - "title": "HubSpot predictive contact score", - "type": "string", - "description": "HubSpot - predictive contact score." - }, - "hs_predictivecontactscore_v2": { - "title": "HubSpot predictive contact score v2", - "type": "string", - "description": "HubSpot - predictive contact score V2" - }, - "hs_predictivecontactscorebucket": { - "title": "HubSpot predictive contact score bucket", - "type": "string", - "description": "HubSpot - predictive contact score bucket." - }, - "hs_predictivescoringtier": { - "title": "HubSpot predictive scoring tier", - "type": "string", - "description": "HubSpot - predictive scoring tier." - }, - "hs_sales_email_last_clicked": { - "title": "HubSpot sales email last clicked", - "type": "string", - "description": "HubSpot - sales email last clicked" - }, - "hs_sales_email_last_opened": { - "title": "HubSpot sales email last opened", - "type": "string", - "description": "HubSpot - sales email last opened" - }, - "hs_sales_email_last_replied": { - "title": "HubSpot sales email last replied", - "type": "string", - "description": "HubSpot - sales email last replied" - }, - "hs_sequences_is_enrolled": { - "title": "HubSpot sequences is enrolled", - "type": "string", - "description": "HubSpot - sequences is enrolled." - }, - "hs_time_between_contact_creation_and_deal_close": { - "title": "HubSpot time between contact creation and deal close", - "type": "string", - "description": "HubSpot - time between contact creation and deal close." - }, - "hs_time_between_contact_creation_and_deal_creation": { - "title": "HubSpot time between contact creation and deal creation", - "type": "string", - "description": "HubSpot - time between contact creation and deal creation." - }, - "hs_time_to_move_from_lead_to_customer": { - "title": "HubSpot time to move from lead to customer", - "type": "string", - "description": "HubSpot - time to move from lead to customer." - }, - "hs_time_to_move_from_marketingqualifiedlead_to_customer": { - "title": "HubSpot time to move from marketing qualitfied lead to customer", - "type": "string", - "description": "HubSpot - time to move from marketing qualified lead to customer." - }, - "hs_time_to_move_from_opportunity_to_customer": { - "title": "HubSpot time to move from opportunity to customer", - "type": "string", - "description": "HubSpot - time to move from opportunity to customer." - }, - "hs_time_to_move_from_salesqualifiedlead_to_customer": { - "title": "HubSpot time to move from sales qualified lead to customer", - "type": "string", - "description": "HubSpot - time to move from sales qualified lead to customer." - }, - "hs_time_to_move_from_subscriber_to_customer": { - "title": "HubSpot time to move from subscriber to customer", - "type": "string", - "description": "HubSpot - time to move from subscriber to customer." - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", - "type": "string", - "description": "HubSpot - owner ID." - }, - "hubspot_team_id": { - "title": "HubSpot team ID", - "type": "string", - "description": "HubSpot - team ID." - }, - "hubspotscore": { - "title": "HubSpot score", - "type": "string", - "description": "HubSpot score." - }, - "industry": { - "title": "Industry", - "type": "string", - "description": "Industry." - }, - "ip_city": { - "title": "IP city", - "type": "string", - "description": "IP city" - }, - "ip_country": { - "title": "IP country", - "type": "string", - "description": "IP country" - }, - "ip_country_code": { - "title": "IP country code", - "type": "string", - "description": "IP country code" - }, - "ip_state": { - "title": "IP state", - "type": "string", - "description": "IP state" - }, - "ip_state_code": { - "title": "IP state code", - "type": "string", - "description": "IP state code" - }, - "job_function": { - "title": "Job function", - "type": "string", - "description": "Job function." - }, - "jobtitle": { - "title": "Job title", - "type": "string", - "description": "Job title." - }, - "lastmodifieddate": { - "title": "Last modified date", - "type": "string", - "description": "Last modified date." - }, - "lastname": { - "title": "Last name", - "type": "string", - "description": "Last name." - }, - "lifecyclestage": { - "title": "Lifecycle stage", - "type": "string", - "description": "The current lifecycle stage." - }, - "marital_status": { - "title": "Marital status", - "type": "string", - "description": "Marital status." - }, - "message": { - "title": "Message", - "type": "string", - "description": "Message." - }, - "military_status": { - "title": "Military status", - "type": "string", - "description": "Military status." - }, - "mobilephone": { - "title": "Mobile phone", - "type": "string", - "description": "Mobile phone number." - }, - "notes_last_contacted": { - "title": "Notes last contacted", - "type": "string", - "description": "Notes - last contacted." - }, - "notes_last_updated": { - "title": "Notes last updated", - "type": "string", - "description": "Notes - last updated." - }, - "notes_next_activity_date": { - "title": "Notes next activity date", - "type": "string", - "description": "Notes - next activity date." - }, - "num_associated_deals": { - "title": "Number of associated deals", - "type": "string", - "description": "The number of associated deals." - }, - "num_contacted_notes": { - "title": "Number of contacted notes", - "type": "string", - "description": "The number of contacted notes" - }, - "num_conversion_events": { - "title": "Number of conversion events", - "type": "string", - "description": "The number of conversion events." - }, - "num_notes": { - "title": "Number of notes", - "type": "string", - "description": "The number of notes" - }, - "num_unique_conversion_events": { - "title": "Number of unique conversion events", - "type": "string", - "description": "The number of unique conversion events." - }, - "numemployees": { - "title": "Number of employees", - "type": "string", - "description": "Number of employees." - }, - "phone": { - "title": "Phone", - "type": "string", - "description": "Phone number." - }, - "recent_conversion_date": { - "title": "Recent conversion date", - "type": "string", - "description": "Recent conversion date." - }, - "recent_conversion_event_name": { - "title": "Recent conversion event name", - "type": "string", - "description": "Recent conversion event name." - }, - "recent_deal_amount": { - "title": "Recent deal amount", - "type": "string", - "description": "Recent deal amount." - }, - "recent_deal_close_date": { - "title": "Recent deal close date", - "type": "string", - "description": "Recent deal close date." - }, - "relationship_status": { - "title": "Relations status", - "type": "string", - "description": "Relationship status." - }, - "salutation": { - "title": "Salutation", - "type": "string", - "description": "Salutation." - }, - "school": { - "title": "School", - "type": "string", - "description": "School attended." - }, - "seniority": { - "title": "Seniority", - "type": "string", - "description": "Seniority." - }, - "start_date": { - "title": "Start date", - "type": "string", - "description": "Start date." - }, - "state": { - "title": "State", - "type": "string", - "description": "The address state." - }, - "total_revenue": { - "title": "Total revenue", - "type": "string", - "description": "Total revenue" - }, - "twitterhandle": { - "title": "Twitter handle", - "type": "string", - "description": "Twitter handle" - }, - "website": { - "title": "Website", - "type": "string", - "description": "Website." - }, - "work_email": { - "title": "Work email", - "type": "string", - "description": "Work email address." - }, - "zip": { - "title": "Zip code", - "type": "string", - "description": "The address zip." - } + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Contact Record'", + "items": { + "$ref": "#/definitions/ContactRecord" } } } } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Search for contacts", + "description": "Search for a contacts with the given filters and return a list.", + "operationId": "ContactsSearch", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Search" } ] } }, - "/crm/v3/objects/contacts/{contactId}": { + "/crm/v3/objects/deals": { "get": { "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Deal Record'", + "items": { + "$ref": "#/definitions/DealRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, - "summary": "Get a contact", - "description": "Read a contact identified by {contactId}.", - "operationId": "ContactsRead", + "summary": "List deals", + "description": "Return a list of deals", + "operationId": "DealsList", "x-ms-visibility": "important", "parameters": [ { - "name": "contactId", - "in": "path", - "required": true, - "type": "string", - "x-ms-visibility": "important", - "description": "The contactId for the contact", - "x-ms-summary": "contactId", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/Limit" + }, + { + "$ref": "#/parameters/After" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" } ] }, - "delete": { + "post": { + "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DealRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid property values", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Create a deal", + "description": "Create a deal with the given properties and return a copy of the object, including the ID.", + "operationId": "DealsCreate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/DealEntry" + } + ] + } + }, + "/crm/v3/objects/deals/{dealId}": { + "get": { "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DealRecord" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, - "summary": "Delete a contact", - "description": "Move a contact identified by {contactId} to the recycling bin.", - "operationId": "ContactsArchive", + "summary": "Get a deal", + "description": "Read a deal identified by {dealId}.", + "operationId": "DealsRead", "x-ms-visibility": "important", "parameters": [ { - "name": "contactId", - "in": "path", - "required": true, - "type": "string", - "description": "The contactId of the contact", - "x-ms-visibility": "important", - "x-ms-summary": "contactId", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/DealID" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + }, + "delete": { + "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Delete a deal", + "description": "Move a deal identified by {dealId} to the recycling bin.", + "operationId": "DealsArchive", + "x-ms-visibility": "advanced", + "parameters": [ + { + "$ref": "#/parameters/DealID" } ] }, "patch": { "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DealRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, "default": { - "description": "The default response.", - "schema": {} + "description": "Unexpected Error" } }, - "summary": "Update a contact", - "description": "Perform a partial update of a contact identified by {contactId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", - "operationId": "ContactsUpdate", - "x-ms-visibility": "important", + "summary": "Update a deal", + "description": "Perform a partial update of a deal identified by {dealId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "DealsUpdate", "parameters": [ { - "name": "contactId", - "in": "path", - "required": true, - "type": "string", - "description": "The contactId of the contact", - "x-ms-visibility": "important", - "x-ms-summary": "contactId", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/DealID" + }, + { + "$ref": "#/parameters/DealEntry" }, { - "name": "properties", - "in": "body", - "required": true, + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/deals/search": { + "post": { + "responses": { + "200": { + "description": "OK", "schema": { "type": "object", "properties": { - "properties": { - "type": "object", - "properties": { - "address": { - "title": "Address", - "type": "string", - "description": "The first line of the street address." - }, - "annualrevenue": { - "title": "Annual revenue", - "type": "string", - "description": "The company's annual revenue." - }, - "city": { - "title": "City", - "type": "string", - "description": "The address city." - }, - "closedate": { - "title": "Close date", - "type": "string", - "description": "The close date." - }, - "company": { - "title": "Company", - "type": "string", - "description": "Company." - }, - "company_size": { - "title": "Company size", - "type": "string", - "description": "Company size." - }, - "country": { - "title": "Country", - "type": "string", - "description": "The address country." - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "currentlyinworkflow": { - "title": "Currenly in workflow", - "type": "string", - "description": "Currently in workflow." - }, - "date_of_birth": { - "title": "Date of birth", - "type": "string", - "description": "Date of birth." - }, - "days_to_close": { - "title": "Days to close", - "type": "string", - "description": "The estimated days to close." - }, - "degree": { - "title": "Degree", - "type": "string", - "description": "Degree held." - }, - "email": { - "title": "Email", - "type": "string", - "description": "Email." - }, - "engagements_last_meeting_booked": { - "title": "Engagements last meeting booked", - "type": "string", - "description": "The engagements last meeting booked." - }, - "engagements_last_meeting_booked_campaign": { - "title": "Engagements last meeting booked campaign", - "type": "string", - "description": "The engagements last meeting booked campaign." - }, - "engagements_last_meeting_booked_medium": { - "title": "Engagements last meeting booked medium", - "type": "string", - "description": "The engagements last meeting booked medium." - }, - "engagements_last_meeting_booked_source": { - "title": "Engagements last meeting booked source", - "type": "string", - "description": "The engagements last meeting booked source." - }, - "fax": { - "title": "Fax", - "type": "string", - "description": "Fax number." - }, - "field_of_study": { - "title": "Field of study", - "type": "string", - "description": "Field of study." - }, - "first_conversion_date": { - "title": "First conversion date", - "type": "string", - "description": "The first conversion date." - }, - "first_conversion_event_name": { - "title": "First conversion event name", - "type": "string", - "description": "The first conversion event name." - }, - "first_deal_created_date": { - "title": "First deal created date", - "type": "string", - "description": "The first deal created date." - }, - "firstname": { - "title": "First name", - "type": "string", - "description": "First name." - }, - "gender": { - "title": "Gender", - "type": "string", - "description": "Gender." - }, - "graduation_date": { - "title": "Graduation date", - "type": "string", - "description": "Graduation date." - }, - "hs_analytics_average_page_views": { - "title": "HubSpot analytics average page views", - "type": "string", - "description": "HubSpot Analytics - average page views." - }, - "hs_analytics_first_referrer": { - "title": "HubSpot analytics first referrer", - "type": "string", - "description": "HubSpot Analytics - first referrer." - }, - "hs_analytics_first_timestamp": { - "title": "HubSpot analytics first timestamp", - "type": "string", - "description": "HubSpot Analytics - first timestamp." - }, - "hs_analytics_first_touch_converting_campaign": { - "title": "HubSpot analytics first touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - first touch converting campaign." - }, - "hs_analytics_first_url": { - "title": "HubSpot analytics first URL", - "type": "string", - "description": "HubSpot Analytics - first_url" - }, - "hs_analytics_first_visit_timestamp": { - "title": "HubSpot Analytics first visit timestamp", - "type": "string", - "description": "HubSpot Analytics - first visit timestamp" - }, - "hs_analytics_last_referrer": { - "title": "HubSpot analytics last referrer", - "type": "string", - "description": "HubSpot Analytics - last referrer." - }, - "hs_analytics_last_timestamp": { - "title": "HubSpot analytics last timestamp", - "type": "string", - "description": "HubSpot Analytics - last timestamp." - }, - "hs_analytics_last_touch_converting_campaign": { - "title": "HubSpot analytics last touch converting campaign", - "type": "string", - "description": "HubSpot Analytics - last touch converting campaign." - }, - "hs_analytics_last_url": { - "title": "HubSpot analytics last URL", - "type": "string", - "description": "HubSpot Analytics - last URL." - }, - "hs_analytics_last_visit_timestamp": { - "title": "HubSpot analytics last visit timestamp", - "type": "string", - "description": "HubSpot Analytics - last visit timestamp." - }, - "hs_analytics_num_event_completions": { - "title": "HubSpot analytics number of event completions", - "type": "string", - "description": "HubSpot Analytics - number of event completions. " - }, - "hs_analytics_num_page_views": { - "title": "HubSpot analytics number of page views", - "type": "string", - "description": "HubSpot Analytics - number of page views." - }, - "hs_analytics_num_visits": { - "title": "HubSpot analytics number of visits", - "type": "string", - "description": "HubSpot Analytics - number of visits." - }, - "hs_analytics_revenue": { - "title": "HubSpot analytics revenue", - "type": "string", - "description": "HubSpot Analytics - revenue" - }, - "hs_analytics_source": { - "title": "HubSpot analytics source", - "type": "string", - "description": "HubSpot Analytics - source." - }, - "hs_analytics_source_data_1": { - "title": "HubSpot analytics source data 1", - "type": "string", - "description": "HubSpot Analytics - source data 1." - }, - "hs_analytics_source_data_2": { - "title": "HubSpot analytics source data 2", - "type": "string", - "description": "HubSpot Analytics - source data 2." - }, - "hs_buying_role": { - "title": "HubSpot buying role", - "type": "string", - "description": "HubSpot - buying_role" - }, - "hs_content_membership_email_confirmed": { - "title": "HubSpot content membership email confirmed", - "type": "string", - "description": "HubSpot - content membership email confirmed." - }, - "hs_content_membership_notes": { - "title": "HubSpot content membership notes", - "type": "string", - "description": "HubSpot - content membership notes" - }, - "hs_content_membership_registered_at": { - "title": "HubSpot content membership registered at", - "type": "string", - "description": "HubSpot - content membership registered at." - }, - "hs_content_membership_registration_domain_sent_to": { - "title": "HubSpot content membership registration domain sent to", - "type": "string", - "description": "HubSpot - content membership registration domain sent to." - }, - "hs_content_membership_registration_email_sent_at": { - "title": "HubSpot content membership registration email sent at", - "type": "string", - "description": "HubSpot - content membership registration email sent at." - }, - "hs_content_membership_status": { - "title": "HubSpot content membership status", - "type": "string", - "description": "HubSpot - content membership status" - }, - "hs_createdate": { - "title": "Create date", - "type": "string", - "description": "HubSpot - create date." - }, - "hs_email_bad_address": { - "title": "HubSpot email bad address", - "type": "string", - "description": "HubSpot - email bad address" - }, - "hs_email_bounce": { - "title": "HubSpot email bounce", - "type": "string", - "description": "HubSpot - email bounce" - }, - "hs_email_click": { - "title": "HubSpot email click", - "type": "string", - "description": "HubSpot - email click" - }, - "hs_email_customer_quarantined_reason": { - "title": "HubSpot email customer quarnatined reason", - "type": "string", - "description": "HubSpot - email customer quarantined reason." - }, - "hs_email_delivered": { - "title": "HubSpot email delivered", - "type": "string", - "description": "HubSpot - email delivered" - }, - "hs_email_domain": { - "title": "Domain", - "type": "string", - "description": "HubSpot - email domain" - }, - "hs_email_first_click_date": { - "title": "HubSpot email first click date", - "type": "string", - "description": "HubSpot - email first click date." - }, - "hs_email_first_open_date": { - "title": "HubSpot email first open date", - "type": "string", - "description": "HubSpot - email first open date." - }, - "hs_email_first_reply_date": { - "title": "HubSpot email first reply date", - "type": "string", - "description": "HubSpot - email first reply date." - }, - "hs_email_first_send_date": { - "title": "HubSpot email first send date", - "type": "string", - "description": "HubSpot - email first send date." - }, - "hs_email_hard_bounce_reason_enum": { - "title": "HubSpot email hard bounce reason enumerated", - "type": "string", - "description": "HubSpot - email hard bounce reason enumerated." - }, - "hs_email_last_click_date": { - "title": "HubSpot email last click date", - "type": "string", - "description": "HubSpot - email last click date." - }, - "hs_email_last_email_name": { - "title": "HubSpot email last email name", - "type": "string", - "description": "HubSpot - email last email name." - }, - "hs_email_last_open_date": { - "title": "HubSpot email last open date", - "type": "string", - "description": "HubSpot - email last open date." - }, - "hs_email_last_reply_date": { - "title": "HubSpot email last reply date", - "type": "string", - "description": "HubSpot - email last reply date." - }, - "hs_email_last_send_date": { - "title": "HubSpot email last send date", - "type": "string", - "description": "HubSpot - email last send date." - }, - "hs_email_open": { - "title": "HubSpot email open", - "type": "string", - "description": "HubSpot - email open" - }, - "hs_email_optout": { - "title": "HubSpot email optout", - "type": "string", - "description": "HubSpot - email optout" - }, - "hs_email_optout_12592317": { - "title": "HubSpot email optout 12592317", - "type": "string", - "description": "HubSpot - email optout 12592317" - }, - "hs_email_quarantined": { - "title": "HubSpot email quarantied", - "type": "string", - "description": "HubSpot - email quarantined" - }, - "hs_email_quarantined_reason": { - "title": "HubSpot email quarantied reason", - "type": "string", - "description": "HubSpot - email quarantined reason." - }, - "hs_email_replied": { - "title": "HubSpot email replied", - "type": "string", - "description": "HubSpot - email replied" - }, - "hs_email_sends_since_last_engagement": { - "title": "HubSpot email sends since last engagement", - "type": "string", - "description": "HubSpot - email sends since last engagement." - }, - "hs_emailconfirmationstatus": { - "title": "HubSpot email confirmation status", - "type": "string", - "description": "HubSpot - email confirmation status." - }, - "hs_facebook_click_id": { - "title": "HubSpot Facebook click ID", - "type": "string", - "description": "HubSpot - Facebook click ID." - }, - "hs_feedback_last_nps_follow_up": { - "title": "HubSpot feecback last NPS follow up", - "type": "string", - "description": "HubSpot - feedback last NPS follow up." - }, - "hs_feedback_last_nps_rating": { - "title": "HubSpot feedback last NPS rating", - "type": "string", - "description": "HubSpot - feedback last NPS rating." - }, - "hs_feedback_last_survey_date": { - "title": "HubSpot feedback last survey date", - "type": "string", - "description": "HubSpot - feedback last survey date." - }, - "hs_google_click_id": { - "title": "HubSpot Google click ID", - "type": "string", - "description": "HubSpot - Google click ID." - }, - "hs_ip_timezone": { - "title": "HubSpot IP timezoneHubSpot IP timezone", - "type": "string", - "description": "HubSpot - IP timezone." - }, - "hs_is_unworked": { - "title": "HubSpot is unworked", - "type": "string", - "description": "HubSpot - is unworked." - }, - "hs_language": { - "title": "HubSpot language", - "type": "string", - "description": "HubSpot - language" - }, - "hs_last_sales_activity_timestamp": { - "title": "HubSpot last sales activity timestamp", - "type": "string", - "description": "HubSpot - last sales activity timestamp." - }, - "hs_lead_status": { - "title": "HubSpot lead status", - "type": "string", - "description": "HubSpot - lead status." - }, - "hs_legal_basis": { - "title": "HubSpot legal basis", - "type": "string", - "description": "HubSpot - legal basis." - }, - "hs_lifecyclestage_customer_date": { - "title": "HubSpot lifecycle stage customer date", - "type": "string", - "description": "HubSpot - lifecycle stage customer date." - }, - "hs_lifecyclestage_evangelist_date": { - "title": "HubSpot lifecycle stage evangelist date", - "type": "string", - "description": "HubSpot - lifecycle stage evangelist date." - }, - "hs_lifecyclestage_lead_date": { - "title": "HubSpot lifecycle stage lead date", - "type": "string", - "description": "HubSpot - lifecycle stage lead date." - }, - "hs_lifecyclestage_marketingqualifiedlead_date": { - "title": "HubSpot lifecycle stage marketing qualitifed lead date", - "type": "string", - "description": "HubSpot - lifecycle stage marketing qualified lead date." - }, - "hs_lifecyclestage_opportunity_date": { - "title": "HubSpot lifecycle stage opportunity date", - "type": "string", - "description": "HubSpot - lifecycle stage opportunity date." - }, - "hs_lifecyclestage_other_date": { - "title": "HubSpot lifecycle stage other date", - "type": "string", - "description": "HubSpot - lifecycle stage other date." - }, - "hs_lifecyclestage_salesqualifiedlead_date": { - "title": "HubSpot lifecycle stage sales qualified lead date", - "type": "string", - "description": "HubSpot - lifecycle stage sales qualified lead date." - }, - "hs_lifecyclestage_subscriber_date": { - "title": "HubSpot lifecycle stage subscriber date", - "type": "string", - "description": "HubSpot - lifecycle stage subscriber date." - }, - "hs_marketable_reason_id": { - "title": "HubSpot marketable reason ID", - "type": "string", - "description": "HubSpot - marketable reason ID." - }, - "hs_marketable_reason_type": { - "title": "HubSpot marketable reason type", - "type": "string", - "description": "HubSpot - marketable reason type." - }, - "hs_marketable_status": { - "title": "HubSpot marketable status", - "type": "string", - "description": "HubSpot - marketable status" - }, - "hs_marketable_until_renewal": { - "title": "HubSpot marketable until renewal", - "type": "string", - "description": "HubSpot - marketable until renewal." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_persona": { - "title": "HubSpot persona", - "type": "string", - "description": "HubSpot - persona" - }, - "hs_predictivecontactscore": { - "title": "HubSpot predictive contact score", - "type": "string", - "description": "HubSpot - predictive contact score." - }, - "hs_predictivecontactscore_v2": { - "title": "HubSpot predictive contact score v2", - "type": "string", - "description": "HubSpot - predictive contact score V2" - }, - "hs_predictivecontactscorebucket": { - "title": "HubSpot predictive contact score bucket", - "type": "string", - "description": "HubSpot - predictive contact score bucket." - }, - "hs_predictivescoringtier": { - "title": "HubSpot predictive scoring tier", - "type": "string", - "description": "HubSpot - predictive scoring tier." - }, - "hs_sales_email_last_clicked": { - "title": "HubSpot sales email last clicked", - "type": "string", - "description": "HubSpot - sales email last clicked" - }, - "hs_sales_email_last_opened": { - "title": "HubSpot sales email last opened", - "type": "string", - "description": "HubSpot - sales email last opened" - }, - "hs_sales_email_last_replied": { - "title": "HubSpot sales email last replied", - "type": "string", - "description": "HubSpot - sales email last replied" - }, - "hs_sequences_is_enrolled": { - "title": "HubSpot sequences is enrolled", - "type": "string", - "description": "HubSpot - sequences is enrolled." - }, - "hs_time_between_contact_creation_and_deal_close": { - "title": "HubSpot time between contact creation and deal close", - "type": "string", - "description": "HubSpot - time between contact creation and deal close." - }, - "hs_time_between_contact_creation_and_deal_creation": { - "title": "HubSpot time between contact creation and deal creation", - "type": "string", - "description": "HubSpot - time between contact creation and deal creation." - }, - "hs_time_to_move_from_lead_to_customer": { - "title": "HubSpot time to move from lead to customer", - "type": "string", - "description": "HubSpot - time to move from lead to customer." - }, - "hs_time_to_move_from_marketingqualifiedlead_to_customer": { - "title": "HubSpot time to move from marketing qualitfied lead to customer", - "type": "string", - "description": "HubSpot - time to move from marketing qualified lead to customer." - }, - "hs_time_to_move_from_opportunity_to_customer": { - "title": "HubSpot time to move from opportunity to customer", - "type": "string", - "description": "HubSpot - time to move from opportunity to customer." - }, - "hs_time_to_move_from_salesqualifiedlead_to_customer": { - "title": "HubSpot time to move from sales qualified lead to customer", - "type": "string", - "description": "HubSpot - time to move from sales qualified lead to customer." - }, - "hs_time_to_move_from_subscriber_to_customer": { - "title": "HubSpot time to move from subscriber to customer", - "type": "string", - "description": "HubSpot - time to move from subscriber to customer." - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", - "type": "string", - "description": "HubSpot - owner ID." - }, - "hubspot_team_id": { - "title": "HubSpot team ID", - "type": "string", - "description": "HubSpot - team ID." - }, - "hubspotscore": { - "title": "HubSpot score", - "type": "string", - "description": "HubSpot score." - }, - "industry": { - "title": "Industry", - "type": "string", - "description": "Industry." - }, - "ip_city": { - "title": "IP city", - "type": "string", - "description": "IP city" - }, - "ip_country": { - "title": "IP country", - "type": "string", - "description": "IP country" - }, - "ip_country_code": { - "title": "IP country code", - "type": "string", - "description": "IP country code" - }, - "ip_state": { - "title": "IP state", - "type": "string", - "description": "IP state" - }, - "ip_state_code": { - "title": "IP state code", - "type": "string", - "description": "IP state code" - }, - "job_function": { - "title": "Job function", - "type": "string", - "description": "Job function." - }, - "jobtitle": { - "title": "Job title", - "type": "string", - "description": "Job title." - }, - "lastmodifieddate": { - "title": "Last modified date", - "type": "string", - "description": "Last modified date." - }, - "lastname": { - "title": "Last name", - "type": "string", - "description": "Last name." - }, - "lifecyclestage": { - "title": "Lifecycle stage", - "type": "string", - "description": "The current lifecycle stage." - }, - "marital_status": { - "title": "Marital status", - "type": "string", - "description": "Marital status." - }, - "message": { - "title": "Message", - "type": "string", - "description": "Message." - }, - "military_status": { - "title": "Military status", - "type": "string", - "description": "Military status." - }, - "mobilephone": { - "title": "Mobile phone", - "type": "string", - "description": "Mobile phone number." - }, - "notes_last_contacted": { - "title": "Notes last contacted", - "type": "string", - "description": "Notes - last contacted." - }, - "notes_last_updated": { - "title": "Notes last updated", - "type": "string", - "description": "Notes - last updated." - }, - "notes_next_activity_date": { - "title": "Notes next activity date", - "type": "string", - "description": "Notes - next activity date." - }, - "num_associated_deals": { - "title": "Number of associated deals", - "type": "string", - "description": "The number of associated deals." - }, - "num_contacted_notes": { - "title": "Number of contacted notes", - "type": "string", - "description": "The number of contacted notes" - }, - "num_conversion_events": { - "title": "Number of conversion events", - "type": "string", - "description": "The number of conversion events." - }, - "num_notes": { - "title": "Number of notes", - "type": "string", - "description": "The number of notes" - }, - "num_unique_conversion_events": { - "title": "Number of unique conversion events", - "type": "string", - "description": "The number of unique conversion events." - }, - "numemployees": { - "title": "Number of employees", - "type": "string", - "description": "Number of employees." - }, - "phone": { - "title": "Phone", - "type": "string", - "description": "Phone number." - }, - "recent_conversion_date": { - "title": "Recent conversion date", - "type": "string", - "description": "Recent conversion date." - }, - "recent_conversion_event_name": { - "title": "Recent conversion event name", - "type": "string", - "description": "Recent conversion event name." - }, - "recent_deal_amount": { - "title": "Recent deal amount", - "type": "string", - "description": "Recent deal amount." - }, - "recent_deal_close_date": { - "title": "Recent deal close date", - "type": "string", - "description": "Recent deal close date." - }, - "relationship_status": { - "title": "Relations status", - "type": "string", - "description": "Relationship status." - }, - "salutation": { - "title": "Salutation", - "type": "string", - "description": "Salutation." - }, - "school": { - "title": "School", - "type": "string", - "description": "School attended." - }, - "seniority": { - "title": "Seniority", - "type": "string", - "description": "Seniority." - }, - "start_date": { - "title": "Start date", - "type": "string", - "description": "Start date." - }, - "state": { - "title": "State", - "type": "string", - "description": "The address state." - }, - "total_revenue": { - "title": "Total revenue", - "type": "string", - "description": "Total revenue" - }, - "twitterhandle": { - "title": "Twitter handle", - "type": "string", - "description": "Twitter handle" - }, - "website": { - "title": "Website", - "type": "string", - "description": "Website." - }, - "work_email": { - "title": "Work email", - "type": "string", - "description": "Work email address." - }, - "zip": { - "title": "Zip code", - "type": "string", - "description": "The address zip." - } + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Deal Record'", + "items": { + "$ref": "#/definitions/DealRecord" } } } } - } - ] - } - }, - "/crm/v3/objects/deals": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } }, - "summary": "List deals", - "description": "Return a list of deals", - "operationId": "DealsList", + "summary": "Search for deals", + "description": "Search for a deal with the given filters and return a list.", + "operationId": "DealsSearch", "x-ms-visibility": "important", "parameters": [ { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "advanced", - "x-ms-summary": "properties", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/Search" + } + ] + } + }, + "/crm/v3/objects/products": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Product Record'", + "items": { + "$ref": "#/definitions/ProductRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "List products", + "description": "Return a list of products", + "operationId": "ProductsList", + "parameters": [ { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "default": 10, - "x-ms-visibility": "advanced", - "description": "Limit", - "x-ms-summary": "limit", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/Limit" }, { - "name": "after", - "in": "query", - "required": false, - "type": "string", - "x-ms-visibility": "advanced", - "description": "After", - "x-ms-summary": "after", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/After" }, { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-summary": "archived", - "x-ms-url-encoding": "single" + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + } + ], + "x-ms-visibility": "important" + }, + "post": { + "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid property values", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Create a product", + "parameters": [ + { + "$ref": "#/parameters/ProductEntry" + } + ], + "description": "Create a product with the given properties and return a copy of the object, including the ID.", + "operationId": "ProductsCreate", + "x-ms-visibility": "important" + } + }, + "/crm/v3/objects/products/{productId}": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductRecord" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Get a product", + "description": "Read a product identified by {productId}.", + "operationId": "ProductsRead", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ProductID" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + }, + "delete": { + "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Delete a product", + "description": "Move a product identified by {productId} to the recycling bin.", + "operationId": "ProductsArchive", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ProductID" + } + ] + }, + "patch": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProductRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Update a product", + "description": "Perform a partial update of a product identified by {productId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "ProductsUpdate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ProductID" + }, + { + "$ref": "#/parameters/ProductEntry" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/products/search": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Products'", + "items": { + "$ref": "#/definitions/ProductRecord" + } + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Search for products", + "description": "Search for a product with the given filters and return a list.", + "operationId": "ProductsSearch", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Search" } ] + } + }, + "/crm/v3/objects/line_items": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Line Item Record'", + "items": { + "$ref": "#/definitions/LineItemRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "List line items", + "description": "Return a list of line items. Control what is returned via the properties query param.", + "operationId": "LineItemsList", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Limit" + }, + { + "$ref": "#/parameters/After" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + } + ] + }, + "post": { + "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LineItemRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid property values", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Create a line item", + "description": "Create a line item with the given properties and return a copy of the object, including the ID.", + "operationId": "LineItemsCreate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/LineItemEntry" + } + ] + } + }, + "/crm/v3/objects/line_items/{lineItemId}": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LineItemRecord" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Get a line item", + "description": "Read a line item identified by {lineItemId}.", + "operationId": "LineItemsRead", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/LineItemID" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + }, + "delete": { + "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Delete a line item", + "description": "Move an Object identified by {lineItemId} to the recycling bin.", + "operationId": "LineItemsArchive", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/LineItemID" + } + ] + }, + "patch": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LineItemRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Update a line item", + "description": "Perform a partial update of a line item identified by {lineItemId}. {lineItemId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "LineItemsUpdate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/LineItemID" + }, + { + "$ref": "#/parameters/LineItemEntry" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/line_items/search": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Line Item Record'", + "items": { + "$ref": "#/definitions/LineItemRecord" + } + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Search for line items", + "description": "Search for a line item with the given filters and return a list.", + "operationId": "LineItemsSearch", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Search" + } + ] + } + }, + "/crm/v3/objects/tickets": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Ticket Record'", + "items": { + "$ref": "#/definitions/TicketRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "List tickets", + "description": "Read a page of tickets. Control what is returned via the properties query param.", + "operationId": "TicketsList", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Limit" + }, + { + "$ref": "#/parameters/After" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + } + ] + }, + "post": { + "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TicketRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid property values", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Create a ticket", + "description": "Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.", + "operationId": "TicketsCreate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/TicketEntry" + } + ] + } + }, + "/crm/v3/objects/tickets/{ticketId}": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TicketRecord" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Get a ticket", + "description": "Read a ticket identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.", + "operationId": "TicketsRead", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/TicketID" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + }, + "delete": { + "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Delete a ticket", + "description": "Move a ticket identified by {ticketId} to the recycling bin.", + "operationId": "TicketsArchive", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/TicketID" + } + ] + }, + "patch": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TicketRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "operationId": "TicketsUpdate", + "summary": "Update a ticket", + "description": "Perform a partial update of a ticket identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/TicketID" + }, + { + "$ref": "#/parameters/TicketEntry" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/tickets/search": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Ticket Record'", + "items": { + "$ref": "#/definitions/TicketRecord" + } + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Search for tickets", + "description": "Search for a ticket with the given filters and return a list.", + "operationId": "TicketsSearch", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Search" + } + ] + } + }, + "/crm/v3/objects/meetings": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Meeting Record'", + "items": { + "$ref": "#/definitions/MeetingRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "List meetings", + "description": "Return a list of meetings.", + "operationId": "MeetingsList", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Limit" + }, + { + "$ref": "#/parameters/After" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + } + ] + }, + "post": { + "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeetingRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid property values", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Create a meeting", + "description": "Create a meeting with given properties then return a copy with the ID.", + "operationId": "MeetingsCreate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/MeetingEntry" + } + ] + } + }, + "/crm/v3/objects/meetings/{meetingId}": { + "delete": { + "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Delete a meeting", + "description": "Move a meeting identified by {meetingId} to the recycling bin.", + "operationId": "MeetingsArchive", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/MeetingID" + } + ] + }, + "patch": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MeetingRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Update a meeting", + "description": "Perform a partial update of a meetingidentified by {meetingId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "MeetingsUpdate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/MeetingID" + }, + { + "$ref": "#/parameters/MeetingEntry" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/meetings/search": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Meeting Record'", + "items": { + "$ref": "#/definitions/MeetingRecord" + } + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Search for meetings", + "description": "Search for a meeting with the given filters and return a list.", + "operationId": "MeetingsSearch", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/Search" + } + ] + } + }, + "/crm/v3/owners": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Owner Record'", + "items": { + "$ref": "#/definitions/OwnerRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. invalid Object Type", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "List owners", + "description": "Return a list of owners.", + "operationId": "OwnersList", + "x-ms-visibility": "important", + "parameters": [ + { + "name": "email", + "in": "query", + "type": "string", + "required": false, + "description": "Filter by email address", + "x-ms-summary": "Filter by email address", + "x-ms-url-encoding": "single", + "x-ms-visibility": "important" + }, + { + "$ref": "#/parameters/Limit" + }, + { + "$ref": "#/parameters/After" + }, + { + "$ref": "#/parameters/Archived" + } + ] + } + }, + "/crm/v3/owners/{ownerId}": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OwnerRecord" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Get an owner", + "description": "Read an owner identified by {ownerId}.", + "operationId": "OwnersRead", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/OwnerID" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/{objectType}": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "results": { + "type": "array", + "description": "array of results of type 'Object Record'", + "items": { + "$ref": "#/definitions/ObjectRecord" + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "400": { + "description": "Input error, e.g. invalid Object Type", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "List objects", + "description": "Read a page of objects. Control what is returned via the properties query param.", + "operationId": "ObjectsList", + "x-ms-visibility": "advanced", + "parameters": [ + { + "$ref": "#/parameters/ObjectType" + }, + { + "$ref": "#/parameters/Limit" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + } + ] + }, + "post": { + "responses": { + "201": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid Object Type", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "409": { + "description": "Record with unique identifier already exists" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ObjectType" + }, + { + "$ref": "#/parameters/ObjectEntry" + } + ], + "summary": "Create an object", + "description": "Create an object with the given properties and return a copy of the object, including the ID.", + "operationId": "ObjectsCreate", + "x-ms-visibility": "advanced" + } + }, + "/crm/v3/objects/{objectType}/{objectId}": { + "get": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid Object Type", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Get an object", + "description": "Read an object identified by {objectId}.", + "operationId": "ObjectsRead", + "x-ms-visibility": "advanced", + "parameters": [ + { + "$ref": "#/parameters/ObjectType" + }, + { + "$ref": "#/parameters/ObjectID" + }, + { + "$ref": "#/parameters/ReturnProperties" + }, + { + "$ref": "#/parameters/ReturnPropertiesWithHistory" + }, + { + "$ref": "#/parameters/ReturnAssociations" + }, + { + "$ref": "#/parameters/Archived" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + }, + "delete": { + "responses": { + "204": { + "description": "OK" + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Resource not found" + }, + "415": { + "description": "Invalid id" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Delete an object", + "description": "Move a object identified by {objectID} to the recycling bin.", + "operationId": "ObjectsArchive", + "x-ms-visibility": "advanced", + "parameters": [ + { + "$ref": "#/parameters/ObjectType" + }, + { + "$ref": "#/parameters/ObjectID" + } + ] + }, + "patch": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid ID", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Update an object", + "description": "Perform a partial update of an object identified by {objectId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", + "operationId": "ObjectsUpdate", + "parameters": [ + { + "$ref": "#/parameters/ObjectType" + }, + { + "$ref": "#/parameters/ObjectID" + }, + { + "$ref": "#/parameters/ObjectEntry" + }, + { + "$ref": "#/parameters/IDProperty" + } + ] + } + }, + "/crm/v3/objects/{objectType}/search": { + "post": { + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "properties": { + "total": { + "type": "integer", + "format": "int32", + "description": "total" + }, + "results": { + "type": "array", + "description": "array of results of type 'Object Record'", + "items": { + "$ref": "#/definitions/ObjectRecord" + } + } + } + } + }, + "400": { + "description": "Input error, e.g. exceeds page limit or too many characters", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Search for objects", + "description": "Search for an object with the given filters and return a list.", + "operationId": "ObjectsSearch", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ObjectType" + }, + { + "$ref": "#/parameters/Search" + } + ] + } + }, + "/crm/v3/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}/{associationType}": { + "put": { + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ObjectRecord" + } + }, + "400": { + "description": "Input error, e.g. invalid Object Type", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "401": { + "description": "Unauthorized" + }, + "403": { + "description": "Forbidden" + }, + "404": { + "description": "Not found", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "429": { + "description": "Too many requests" + }, + "502": { + "description": "Timeout" + }, + "503": { + "description": "Service temporarily unavailable" + }, + "504": { + "description": "Timeout" + }, + "521": { + "description": "Web server is down" + }, + "522": { + "description": "Connection timed out" + }, + "523": { + "description": "Origin is unreachable" + }, + "524": { + "description": "Timeout" + }, + "525": { + "description": "SSL issues" + }, + "526": { + "description": "SSL issues" + }, + "default": { + "description": "Unexpected Error" + } + }, + "summary": "Associate an object", + "description": "Associate an object with another record", + "operationId": "ObjectsAssociate", + "x-ms-visibility": "important", + "parameters": [ + { + "$ref": "#/parameters/ObjectType" + }, + { + "$ref": "#/parameters/ObjectID" + }, + { + "$ref": "#/parameters/ToObjectType" + }, + { + "$ref": "#/parameters/ToObjectID" + }, + { + "$ref": "#/parameters/AssociationType" + } + ] + } + } + }, + "definitions": { + "CompanyProperties": { + "type": "object", + "properties": { + "about_us": { + "title": "About Us", + "type": "string", + "description": "The company about us information." + }, + "address": { + "title": "Address", + "type": "string", + "description": "The first line of the street address." + }, + "address2": { + "title": "Address 2", + "type": "string", + "description": "The second line of the street address." + }, + "annualrevenue": { + "title": "Annual revenue", + "type": "string", + "description": "The company's annual revenue." + }, + "city": { + "title": "City", + "type": "string", + "description": "The address city." + }, + "closedate": { + "title": "Close date", + "type": "string", + "description": "The close date." + }, + "country": { + "title": "Country", + "type": "string", + "description": "The address country." + }, + "createdate": { + "title": "Create date", + "type": "string", + "description": "The created on date." + }, + "days_to_close": { + "title": "Days to close", + "type": "string", + "description": "The estimated days to close." + }, + "description": { + "title": "Description", + "type": "string", + "description": "A description of the object." + }, + "domain": { + "title": "Domain", + "type": "string", + "description": "The company's domain." + }, + "engagements_last_meeting_booked": { + "title": "Engagements last meeting booked", + "type": "string", + "description": "The engagements last meeting booked." + }, + "engagements_last_meeting_booked_campaign": { + "title": "Engagements last meeting booked campaign", + "type": "string", + "description": "The engagements last meeting booked campaign." + }, + "engagements_last_meeting_booked_medium": { + "title": "Engagements last meeting booked medium", + "type": "string", + "description": "The engagements last meeting booked medium." + }, + "engagements_last_meeting_booked_source": { + "title": "Engagements last meeting booked source", + "type": "string", + "description": "The engagements last meeting booked source." + }, + "facebook_company_page": { + "title": "Facebook company page", + "type": "string", + "description": "The company's Facebook page." + }, + "facebookfans": { + "title": "Facebook fans", + "type": "string", + "description": "Facebook fans." + }, + "first_contact_createdate": { + "title": "first contact create date", + "type": "string", + "description": "The first contact created on date." + }, + "first_conversion_date": { + "title": "First conversion date", + "type": "string", + "description": "The first conversion date." + }, + "first_conversion_event_name": { + "title": "First conversion event name", + "type": "string", + "description": "The first conversion event name." + }, + "first_deal_created_date": { + "title": "First deal created date", + "type": "string", + "description": "The first deal created date." + }, + "founded_year": { + "title": "Founded year", + "type": "string", + "description": "The company's founded year." + }, + "googleplus_page": { + "title": "GooglePlus page", + "type": "string", + "description": "The company's GooglePlus page." + }, + "hs_analytics_first_timestamp": { + "title": "HubSpot analytics first timestamp", + "type": "string", + "description": "HubSpot Analytics - first timestamp." + }, + "hs_analytics_first_touch_converting_campaign": { + "title": "HubSpot analytics first touch converting campaign", + "type": "string", + "description": "HubSpot Analytics - first touch converting campaign." + }, + "hs_analytics_first_visit_timestamp": { + "title": "HubSpot Analytics first visit timestamp", + "type": "string", + "description": "HubSpot Analytics - first visit timestamp" + }, + "hs_analytics_last_timestamp": { + "title": "HubSpot analytics last timestamp", + "type": "string", + "description": "HubSpot Analytics - last timestamp." + }, + "hs_analytics_last_touch_converting_campaign": { + "title": "HubSpot analytics last touch converting campaign", + "type": "string", + "description": "HubSpot Analytics - last touch converting campaign." + }, + "hs_analytics_last_visit_timestamp": { + "title": "HubSpot analytics last visit timestamp", + "type": "string", + "description": "HubSpot Analytics - last visit timestamp." + }, + "hs_analytics_num_page_views": { + "title": "HubSpot analytics number of page views", + "type": "string", + "description": "HubSpot Analytics - number of page views." + }, + "hs_analytics_num_visits": { + "title": "HubSpot analytics number of visits", + "type": "string", + "description": "HubSpot Analytics - number of visits." + }, + "hs_analytics_source": { + "title": "HubSpot analytics source", + "type": "string", + "description": "HubSpot Analytics - source." + }, + "hs_analytics_source_data_1": { + "title": "HubSpot analytics source data 1", + "type": "string", + "description": "HubSpot Analytics - source data 1." + }, + "hs_analytics_source_data_2": { + "title": "HubSpot analytics source data 2", + "type": "string", + "description": "HubSpot Analytics - source data 2." + }, + "hs_createdate": { + "title": "Create date", + "type": "string", + "description": "HubSpot - create date." + }, + "hs_ideal_customer_profile": { + "title": "HubSpot ideal customer profile", + "type": "string", + "description": "HubSpot - ideal customer profile." + }, + "hs_is_target_account": { + "title": "HubSpot is target account", + "type": "string", + "description": "HubSpot - is target account." + }, + "hs_last_booked_meeting_date": { + "title": "HubSpot last booked meeting date", + "type": "string", + "description": "HubSpot - last booked meeting date." + }, + "hs_last_logged_call_date": { + "title": "HubSpot last logged call date", + "type": "string", + "description": "HubSpot - last logged call date." + }, + "hs_last_open_task_date": { + "title": "HubSpot last open task date", + "type": "string", + "description": "HubSpot - last open task date." + }, + "hs_last_sales_activity_timestamp": { + "title": "HubSpot last sales activity timestamp", + "type": "string", + "description": "HubSpot - last sales activity timestamp." + }, + "hs_lastmodifieddate": { + "title": "HubSpot last modified date", + "type": "string", + "description": "HubSpot - last modified date." + }, + "hs_lead_status": { + "title": "HubSpot lead status", + "type": "string", + "description": "HubSpot - lead status." + }, + "hs_num_blockers": { + "title": "HubSpot number of blockers", + "type": "string", + "description": "HubSpot - number of blockers." + }, + "hs_num_child_companies": { + "title": "HubSpot number of child companies", + "type": "string", + "description": "HubSpot - number of child companies." + }, + "hs_num_contacts_with_buying_roles": { + "title": "HubSpot number of contacts with buying roles", + "type": "string", + "description": "HubSpot - number of contacts with buying roles." + }, + "hs_num_decision_makers": { + "title": "HubSpot number of decision makers", + "type": "string", + "description": "HubSpot - number of decision makers." + }, + "hs_num_open_deals": { + "title": "HubSpot number of open deals", + "type": "string", + "description": "HubSpot - number of open deals." + }, + "hs_object_id": { + "title": "HubSpot object ID", + "type": "string", + "description": "HubSpot - object ID." + }, + "hs_parent_company_id": { + "title": "HubSpot parent company ID", + "type": "string", + "description": "HubSpot - parent company ID." + }, + "hs_predictivecontactscore_v2": { + "title": "HubSpot predictive contact score v2", + "type": "string", + "description": "HubSpot - predictive contact score V2" + }, + "hs_total_deal_value": { + "title": "HubSpot total deal value", + "type": "string", + "description": "HubSpot - total deal value." + }, + "hubspot_owner_assigneddate": { + "title": "HubSpot owner assigned date", + "type": "string", + "description": "HubSpot - owner assigned date." + }, + "hubspot_owner_id": { + "title": "HubSpot owner ID", + "type": "string", + "description": "HubSpot - owner ID." + }, + "hubspot_team_id": { + "title": "HubSpot team ID", + "type": "string", + "description": "HubSpot - team ID." + }, + "industry": { + "title": "Industry", + "type": "string", + "description": "Industry." + }, + "is_public": { + "title": "Is public", + "type": "string", + "description": "Whether is public." + }, + "lifecyclestage": { + "title": "Lifecycle stage", + "type": "string", + "description": "The current lifecycle stage." + }, + "linkedin_company_page": { + "title": "LinkedIn company page", + "type": "string", + "description": "The company's LinkedIn page." + }, + "linkedinbio": { + "title": "LinkedIn bio", + "type": "string", + "description": "LinkedIn bio." + }, + "name": { + "title": "Name", + "type": "string", + "description": "Name." + }, + "notes_last_contacted": { + "title": "Notes last contacted", + "type": "string", + "description": "Notes - last contacted." + }, + "notes_last_updated": { + "title": "Notes last updated", + "type": "string", + "description": "Notes - last updated." + }, + "notes_next_activity_date": { + "title": "Notes next activity date", + "type": "string", + "description": "Notes - next activity date." + }, + "num_associated_contacts": { + "title": "Number of associated contacts", + "type": "string", + "description": "The number of associated contacts." + }, + "num_associated_deals": { + "title": "Number of associated deals", + "type": "string", + "description": "The number of associated deals." + }, + "num_contacted_notes": { + "title": "Number of contacted notes", + "type": "string", + "description": "The number of contacted notes" + }, + "num_conversion_events": { + "title": "Number of conversion events", + "type": "string", + "description": "The number of conversion events." + }, + "numberofemployees": { + "title": "Number of employees", + "type": "string", + "description": "The number of employees." + }, + "phone": { + "title": "Phone", + "type": "string", + "description": "Phone number." + }, + "recent_conversion_date": { + "title": "Recent conversion date", + "type": "string", + "description": "Recent conversion date." + }, + "recent_conversion_event_name": { + "title": "Recent conversion event name", + "type": "string", + "description": "Recent conversion event name." + }, + "recent_deal_amount": { + "title": "Recent deal amount", + "type": "string", + "description": "Recent deal amount." + }, + "recent_deal_close_date": { + "title": "Recent deal close date", + "type": "string", + "description": "Recent deal close date." + }, + "state": { + "title": "State", + "type": "string", + "description": "The address state." + }, + "timezone": { + "title": "Timezone", + "type": "string", + "description": "Timezone." + }, + "total_money_raised": { + "title": "Total money raised", + "type": "string", + "description": "Total money raised." + }, + "total_revenue": { + "title": "Total revenue", + "type": "string", + "description": "Total revenue" + }, + "twitterbio": { + "title": "Twitter bio", + "type": "string", + "description": "Twitter bio" + }, + "twitterfollowers": { + "title": "Twitter followers", + "type": "string", + "description": "Twitter followers" + }, + "twitterhandle": { + "title": "Twitter handle", + "type": "string", + "description": "Twitter handle" + }, + "type": { + "title": "Type", + "type": "string", + "description": "type" + }, + "web_technologies": { + "title": "Web technologies", + "type": "string", + "description": "Web technologies." + }, + "website": { + "title": "Website", + "type": "string", + "description": "Website." + }, + "zip": { + "title": "Zip code", + "type": "string", + "description": "The address zip." + } + }, + "additionalProperties": { + "type": "string" + } + }, + "CompanyRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the company", + "type": "string", + "x-ms-summary": "Company ID" + }, + "properties": { + "$ref": "#/definitions/CompanyProperties" + }, + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of company creation", + "type": "string", + "x-ms-summary": "Company Created Date" + }, + "updatedAt": { + "description": "Date of company last updated", + "type": "string", + "x-ms-summary": "Company Updated Date" + }, + "archived": { + "description": "Whether the company is archived", + "type": "boolean", + "x-ms-summary": "Company Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of company archived", + "type": "string", + "x-ms-summary": "Company Archived Date" + } + } + }, + "ContactProperties": { + "type": "object", + "properties": { + "address": { + "title": "Address", + "type": "string", + "description": "The first line of the street address." + }, + "annualrevenue": { + "title": "Annual revenue", + "type": "string", + "description": "The company's annual revenue." + }, + "city": { + "title": "City", + "type": "string", + "description": "The address city." + }, + "closedate": { + "title": "Close date", + "type": "string", + "description": "The close date." + }, + "company": { + "title": "Company", + "type": "string", + "description": "Company." + }, + "company_size": { + "title": "Company size", + "type": "string", + "description": "Company size." + }, + "country": { + "title": "Country", + "type": "string", + "description": "The address country." + }, + "createdate": { + "title": "Create date", + "type": "string", + "description": "The created on date." + }, + "currentlyinworkflow": { + "title": "Currenly in workflow", + "type": "string", + "description": "Currently in workflow." + }, + "date_of_birth": { + "title": "Date of birth", + "type": "string", + "description": "Date of birth." + }, + "days_to_close": { + "title": "Days to close", + "type": "string", + "description": "The estimated days to close." + }, + "degree": { + "title": "Degree", + "type": "string", + "description": "Degree held." + }, + "email": { + "title": "Email", + "type": "string", + "description": "Email." + }, + "engagements_last_meeting_booked": { + "title": "Engagements last meeting booked", + "type": "string", + "description": "The engagements last meeting booked." + }, + "engagements_last_meeting_booked_campaign": { + "title": "Engagements last meeting booked campaign", + "type": "string", + "description": "The engagements last meeting booked campaign." + }, + "engagements_last_meeting_booked_medium": { + "title": "Engagements last meeting booked medium", + "type": "string", + "description": "The engagements last meeting booked medium." + }, + "engagements_last_meeting_booked_source": { + "title": "Engagements last meeting booked source", + "type": "string", + "description": "The engagements last meeting booked source." + }, + "fax": { + "title": "Fax", + "type": "string", + "description": "Fax number." + }, + "field_of_study": { + "title": "Field of study", + "type": "string", + "description": "Field of study." + }, + "first_conversion_date": { + "title": "First conversion date", + "type": "string", + "description": "The first conversion date." + }, + "first_conversion_event_name": { + "title": "First conversion event name", + "type": "string", + "description": "The first conversion event name." + }, + "first_deal_created_date": { + "title": "First deal created date", + "type": "string", + "description": "The first deal created date." + }, + "firstname": { + "title": "First name", + "type": "string", + "description": "First name." + }, + "gender": { + "title": "Gender", + "type": "string", + "description": "Gender." + }, + "graduation_date": { + "title": "Graduation date", + "type": "string", + "description": "Graduation date." + }, + "hs_analytics_average_page_views": { + "title": "HubSpot analytics average page views", + "type": "string", + "description": "HubSpot Analytics - average page views." + }, + "hs_analytics_first_referrer": { + "title": "HubSpot analytics first referrer", + "type": "string", + "description": "HubSpot Analytics - first referrer." + }, + "hs_analytics_first_timestamp": { + "title": "HubSpot analytics first timestamp", + "type": "string", + "description": "HubSpot Analytics - first timestamp." + }, + "hs_analytics_first_touch_converting_campaign": { + "title": "HubSpot analytics first touch converting campaign", + "type": "string", + "description": "HubSpot Analytics - first touch converting campaign." + }, + "hs_analytics_first_url": { + "title": "HubSpot analytics first URL", + "type": "string", + "description": "HubSpot Analytics - first_url" + }, + "hs_analytics_first_visit_timestamp": { + "title": "HubSpot Analytics first visit timestamp", + "type": "string", + "description": "HubSpot Analytics - first visit timestamp" + }, + "hs_analytics_last_referrer": { + "title": "HubSpot analytics last referrer", + "type": "string", + "description": "HubSpot Analytics - last referrer." + }, + "hs_analytics_last_timestamp": { + "title": "HubSpot analytics last timestamp", + "type": "string", + "description": "HubSpot Analytics - last timestamp." + }, + "hs_analytics_last_touch_converting_campaign": { + "title": "HubSpot analytics last touch converting campaign", + "type": "string", + "description": "HubSpot Analytics - last touch converting campaign." + }, + "hs_analytics_last_url": { + "title": "HubSpot analytics last URL", + "type": "string", + "description": "HubSpot Analytics - last URL." + }, + "hs_analytics_last_visit_timestamp": { + "title": "HubSpot analytics last visit timestamp", + "type": "string", + "description": "HubSpot Analytics - last visit timestamp." + }, + "hs_analytics_num_event_completions": { + "title": "HubSpot analytics number of event completions", + "type": "string", + "description": "HubSpot Analytics - number of event completions." + }, + "hs_analytics_num_page_views": { + "title": "HubSpot analytics number of page views", + "type": "string", + "description": "HubSpot Analytics - number of page views." + }, + "hs_analytics_num_visits": { + "title": "HubSpot analytics number of visits", + "type": "string", + "description": "HubSpot Analytics - number of visits." + }, + "hs_analytics_revenue": { + "title": "HubSpot analytics revenue", + "type": "string", + "description": "HubSpot Analytics - revenue" + }, + "hs_analytics_source": { + "title": "HubSpot analytics source", + "type": "string", + "description": "HubSpot Analytics - source." + }, + "hs_analytics_source_data_1": { + "title": "HubSpot analytics source data 1", + "type": "string", + "description": "HubSpot Analytics - source data 1." + }, + "hs_analytics_source_data_2": { + "title": "HubSpot analytics source data 2", + "type": "string", + "description": "HubSpot Analytics - source data 2." + }, + "hs_buying_role": { + "title": "HubSpot buying role", + "type": "string", + "description": "HubSpot - buying_role" + }, + "hs_content_membership_email_confirmed": { + "title": "HubSpot content membership email confirmed", + "type": "string", + "description": "HubSpot - content membership email confirmed." + }, + "hs_content_membership_notes": { + "title": "HubSpot content membership notes", + "type": "string", + "description": "HubSpot - content membership notes" + }, + "hs_content_membership_registered_at": { + "title": "HubSpot content membership registered at", + "type": "string", + "description": "HubSpot - content membership registered at." + }, + "hs_content_membership_registration_domain_sent_to": { + "title": "HubSpot content membership registration domain sent to", + "type": "string", + "description": "HubSpot - content membership registration domain sent to." + }, + "hs_content_membership_registration_email_sent_at": { + "title": "HubSpot content membership registration email sent at", + "type": "string", + "description": "HubSpot - content membership registration email sent at." + }, + "hs_content_membership_status": { + "title": "HubSpot content membership status", + "type": "string", + "description": "HubSpot - content membership status" + }, + "hs_createdate": { + "title": "Create date", + "type": "string", + "description": "HubSpot - create date." + }, + "hs_email_bad_address": { + "title": "HubSpot email bad address", + "type": "string", + "description": "HubSpot - email bad address" + }, + "hs_email_bounce": { + "title": "HubSpot email bounce", + "type": "string", + "description": "HubSpot - email bounce" + }, + "hs_email_click": { + "title": "HubSpot email click", + "type": "string", + "description": "HubSpot - email click" + }, + "hs_email_customer_quarantined_reason": { + "title": "HubSpot email customer quarnatined reason", + "type": "string", + "description": "HubSpot - email customer quarantined reason." + }, + "hs_email_delivered": { + "title": "HubSpot email delivered", + "type": "string", + "description": "HubSpot - email delivered" + }, + "hs_email_domain": { + "title": "Domain", + "type": "string", + "description": "HubSpot - email domain" + }, + "hs_email_first_click_date": { + "title": "HubSpot email first click date", + "type": "string", + "description": "HubSpot - email first click date." + }, + "hs_email_first_open_date": { + "title": "HubSpot email first open date", + "type": "string", + "description": "HubSpot - email first open date." + }, + "hs_email_first_reply_date": { + "title": "HubSpot email first reply date", + "type": "string", + "description": "HubSpot - email first reply date." + }, + "hs_email_first_send_date": { + "title": "HubSpot email first send date", + "type": "string", + "description": "HubSpot - email first send date." + }, + "hs_email_hard_bounce_reason_enum": { + "title": "HubSpot email hard bounce reason enumerated", + "type": "string", + "description": "HubSpot - email hard bounce reason enumerated." + }, + "hs_email_last_click_date": { + "title": "HubSpot email last click date", + "type": "string", + "description": "HubSpot - email last click date." + }, + "hs_email_last_email_name": { + "title": "HubSpot email last email name", + "type": "string", + "description": "HubSpot - email last email name." + }, + "hs_email_last_open_date": { + "title": "HubSpot email last open date", + "type": "string", + "description": "HubSpot - email last open date." + }, + "hs_email_last_reply_date": { + "title": "HubSpot email last reply date", + "type": "string", + "description": "HubSpot - email last reply date." + }, + "hs_email_last_send_date": { + "title": "HubSpot email last send date", + "type": "string", + "description": "HubSpot - email last send date." + }, + "hs_email_open": { + "title": "HubSpot email open", + "type": "string", + "description": "HubSpot - email open" + }, + "hs_email_optout": { + "title": "HubSpot email optout", + "type": "string", + "description": "HubSpot - email optout" + }, + "hs_email_optout_12592317": { + "title": "HubSpot email optout 12592317", + "type": "string", + "description": "HubSpot - email optout 12592317" + }, + "hs_email_quarantined": { + "title": "HubSpot email quarantied", + "type": "string", + "description": "HubSpot - email quarantined" + }, + "hs_email_quarantined_reason": { + "title": "HubSpot email quarantied reason", + "type": "string", + "description": "HubSpot - email quarantined reason." + }, + "hs_email_replied": { + "title": "HubSpot email replied", + "type": "string", + "description": "HubSpot - email replied" + }, + "hs_email_sends_since_last_engagement": { + "title": "HubSpot email sends since last engagement", + "type": "string", + "description": "HubSpot - email sends since last engagement." + }, + "hs_emailconfirmationstatus": { + "title": "HubSpot email confirmation status", + "type": "string", + "description": "HubSpot - email confirmation status." + }, + "hs_facebook_click_id": { + "title": "HubSpot Facebook click ID", + "type": "string", + "description": "HubSpot - Facebook click ID." + }, + "hs_feedback_last_nps_follow_up": { + "title": "HubSpot feecback last NPS follow up", + "type": "string", + "description": "HubSpot - feedback last NPS follow up." + }, + "hs_feedback_last_nps_rating": { + "title": "HubSpot feedback last NPS rating", + "type": "string", + "description": "HubSpot - feedback last NPS rating." + }, + "hs_feedback_last_survey_date": { + "title": "HubSpot feedback last survey date", + "type": "string", + "description": "HubSpot - feedback last survey date." + }, + "hs_google_click_id": { + "title": "HubSpot Google click ID", + "type": "string", + "description": "HubSpot - Google click ID." + }, + "hs_ip_timezone": { + "title": "HubSpot IP timezoneHubSpot IP timezone", + "type": "string", + "description": "HubSpot - IP timezone." + }, + "hs_is_unworked": { + "title": "HubSpot is unworked", + "type": "string", + "description": "HubSpot - is unworked." + }, + "hs_language": { + "title": "HubSpot language", + "type": "string", + "description": "HubSpot - language" + }, + "hs_last_sales_activity_timestamp": { + "title": "HubSpot last sales activity timestamp", + "type": "string", + "description": "HubSpot - last sales activity timestamp." + }, + "hs_lead_status": { + "title": "HubSpot lead status", + "type": "string", + "description": "HubSpot - lead status." + }, + "hs_legal_basis": { + "title": "HubSpot legal basis", + "type": "string", + "description": "HubSpot - legal basis." + }, + "hs_lifecyclestage_customer_date": { + "title": "HubSpot lifecycle stage customer date", + "type": "string", + "description": "HubSpot - lifecycle stage customer date." + }, + "hs_lifecyclestage_evangelist_date": { + "title": "HubSpot lifecycle stage evangelist date", + "type": "string", + "description": "HubSpot - lifecycle stage evangelist date." + }, + "hs_lifecyclestage_lead_date": { + "title": "HubSpot lifecycle stage lead date", + "type": "string", + "description": "HubSpot - lifecycle stage lead date." + }, + "hs_lifecyclestage_marketingqualifiedlead_date": { + "title": "HubSpot lifecycle stage marketing qualitifed lead date", + "type": "string", + "description": "HubSpot - lifecycle stage marketing qualified lead date." + }, + "hs_lifecyclestage_opportunity_date": { + "title": "HubSpot lifecycle stage opportunity date", + "type": "string", + "description": "HubSpot - lifecycle stage opportunity date." + }, + "hs_lifecyclestage_other_date": { + "title": "HubSpot lifecycle stage other date", + "type": "string", + "description": "HubSpot - lifecycle stage other date." + }, + "hs_lifecyclestage_salesqualifiedlead_date": { + "title": "HubSpot lifecycle stage sales qualified lead date", + "type": "string", + "description": "HubSpot - lifecycle stage sales qualified lead date." + }, + "hs_lifecyclestage_subscriber_date": { + "title": "HubSpot lifecycle stage subscriber date", + "type": "string", + "description": "HubSpot - lifecycle stage subscriber date." + }, + "hs_marketable_reason_id": { + "title": "HubSpot marketable reason ID", + "type": "string", + "description": "HubSpot - marketable reason ID." + }, + "hs_marketable_reason_type": { + "title": "HubSpot marketable reason type", + "type": "string", + "description": "HubSpot - marketable reason type." + }, + "hs_marketable_status": { + "title": "HubSpot marketable status", + "type": "string", + "description": "HubSpot - marketable status" + }, + "hs_marketable_until_renewal": { + "title": "HubSpot marketable until renewal", + "type": "string", + "description": "HubSpot - marketable until renewal." + }, + "hs_object_id": { + "title": "HubSpot object ID", + "type": "string", + "description": "HubSpot - object ID." + }, + "hs_persona": { + "title": "HubSpot persona", + "type": "string", + "description": "HubSpot - persona" + }, + "hs_predictivecontactscore": { + "title": "HubSpot predictive contact score", + "type": "string", + "description": "HubSpot - predictive contact score." + }, + "hs_predictivecontactscore_v2": { + "title": "HubSpot predictive contact score v2", + "type": "string", + "description": "HubSpot - predictive contact score V2" + }, + "hs_predictivecontactscorebucket": { + "title": "HubSpot predictive contact score bucket", + "type": "string", + "description": "HubSpot - predictive contact score bucket." + }, + "hs_predictivescoringtier": { + "title": "HubSpot predictive scoring tier", + "type": "string", + "description": "HubSpot - predictive scoring tier." + }, + "hs_sales_email_last_clicked": { + "title": "HubSpot sales email last clicked", + "type": "string", + "description": "HubSpot - sales email last clicked" + }, + "hs_sales_email_last_opened": { + "title": "HubSpot sales email last opened", + "type": "string", + "description": "HubSpot - sales email last opened" + }, + "hs_sales_email_last_replied": { + "title": "HubSpot sales email last replied", + "type": "string", + "description": "HubSpot - sales email last replied" + }, + "hs_sequences_is_enrolled": { + "title": "HubSpot sequences is enrolled", + "type": "string", + "description": "HubSpot - sequences is enrolled." + }, + "hs_time_between_contact_creation_and_deal_close": { + "title": "HubSpot time between contact creation and deal close", + "type": "string", + "description": "HubSpot - time between contact creation and deal close." + }, + "hs_time_between_contact_creation_and_deal_creation": { + "title": "HubSpot time between contact creation and deal creation", + "type": "string", + "description": "HubSpot - time between contact creation and deal creation." + }, + "hs_time_to_move_from_lead_to_customer": { + "title": "HubSpot time to move from lead to customer", + "type": "string", + "description": "HubSpot - time to move from lead to customer." + }, + "hs_time_to_move_from_marketingqualifiedlead_to_customer": { + "title": "HubSpot time to move from marketing qualitfied lead to customer", + "type": "string", + "description": "HubSpot - time to move from marketing qualified lead to customer." + }, + "hs_time_to_move_from_opportunity_to_customer": { + "title": "HubSpot time to move from opportunity to customer", + "type": "string", + "description": "HubSpot - time to move from opportunity to customer." + }, + "hs_time_to_move_from_salesqualifiedlead_to_customer": { + "title": "HubSpot time to move from sales qualified lead to customer", + "type": "string", + "description": "HubSpot - time to move from sales qualified lead to customer." + }, + "hs_time_to_move_from_subscriber_to_customer": { + "title": "HubSpot time to move from subscriber to customer", + "type": "string", + "description": "HubSpot - time to move from subscriber to customer." + }, + "hubspot_owner_assigneddate": { + "title": "HubSpot owner assigned date", + "type": "string", + "description": "HubSpot - owner assigned date." + }, + "hubspot_owner_id": { + "title": "HubSpot owner ID", + "type": "string", + "description": "HubSpot - owner ID." + }, + "hubspot_team_id": { + "title": "HubSpot team ID", + "type": "string", + "description": "HubSpot - team ID." + }, + "hubspotscore": { + "title": "HubSpot score", + "type": "string", + "description": "HubSpot score." + }, + "industry": { + "title": "Industry", + "type": "string", + "description": "Industry." + }, + "ip_city": { + "title": "IP city", + "type": "string", + "description": "IP city" + }, + "ip_country": { + "title": "IP country", + "type": "string", + "description": "IP country" + }, + "ip_country_code": { + "title": "IP country code", + "type": "string", + "description": "IP country code" + }, + "ip_state": { + "title": "IP state", + "type": "string", + "description": "IP state" + }, + "ip_state_code": { + "title": "IP state code", + "type": "string", + "description": "IP state code" + }, + "job_function": { + "title": "Job function", + "type": "string", + "description": "Job function." + }, + "jobtitle": { + "title": "Job title", + "type": "string", + "description": "Job title." + }, + "lastmodifieddate": { + "title": "Last modified date", + "type": "string", + "description": "Last modified date." + }, + "lastname": { + "title": "Last name", + "type": "string", + "description": "Last name." + }, + "lifecyclestage": { + "title": "Lifecycle stage", + "type": "string", + "description": "The current lifecycle stage." + }, + "marital_status": { + "title": "Marital status", + "type": "string", + "description": "Marital status." + }, + "message": { + "title": "Message", + "type": "string", + "description": "Message." + }, + "military_status": { + "title": "Military status", + "type": "string", + "description": "Military status." + }, + "mobilephone": { + "title": "Mobile phone", + "type": "string", + "description": "Mobile phone number." + }, + "notes_last_contacted": { + "title": "Notes last contacted", + "type": "string", + "description": "Notes - last contacted." + }, + "notes_last_updated": { + "title": "Notes last updated", + "type": "string", + "description": "Notes - last updated." + }, + "notes_next_activity_date": { + "title": "Notes next activity date", + "type": "string", + "description": "Notes - next activity date." + }, + "num_associated_deals": { + "title": "Number of associated deals", + "type": "string", + "description": "The number of associated deals." + }, + "num_contacted_notes": { + "title": "Number of contacted notes", + "type": "string", + "description": "The number of contacted notes" + }, + "num_conversion_events": { + "title": "Number of conversion events", + "type": "string", + "description": "The number of conversion events." + }, + "num_notes": { + "title": "Number of notes", + "type": "string", + "description": "The number of notes" + }, + "num_unique_conversion_events": { + "title": "Number of unique conversion events", + "type": "string", + "description": "The number of unique conversion events." + }, + "numemployees": { + "title": "Number of employees", + "type": "string", + "description": "Number of employees." + }, + "phone": { + "title": "Phone", + "type": "string", + "description": "Phone number." + }, + "recent_conversion_date": { + "title": "Recent conversion date", + "type": "string", + "description": "Recent conversion date." + }, + "recent_conversion_event_name": { + "title": "Recent conversion event name", + "type": "string", + "description": "Recent conversion event name." + }, + "recent_deal_amount": { + "title": "Recent deal amount", + "type": "string", + "description": "Recent deal amount." + }, + "recent_deal_close_date": { + "title": "Recent deal close date", + "type": "string", + "description": "Recent deal close date." + }, + "relationship_status": { + "title": "Relations status", + "type": "string", + "description": "Relationship status." + }, + "salutation": { + "title": "Salutation", + "type": "string", + "description": "Salutation." + }, + "school": { + "title": "School", + "type": "string", + "description": "School attended." + }, + "seniority": { + "title": "Seniority", + "type": "string", + "description": "Seniority." + }, + "start_date": { + "title": "Start date", + "type": "string", + "description": "Start date." + }, + "state": { + "title": "State", + "type": "string", + "description": "The address state." + }, + "total_revenue": { + "title": "Total revenue", + "type": "string", + "description": "Total revenue" + }, + "twitterhandle": { + "title": "Twitter handle", + "type": "string", + "description": "Twitter handle" + }, + "website": { + "title": "Website", + "type": "string", + "description": "Website." + }, + "work_email": { + "title": "Work email", + "type": "string", + "description": "Work email address." + }, + "zip": { + "title": "Zip code", + "type": "string", + "description": "The address zip." + } + }, + "additionalProperties": { + "type": "string" + } + }, + "ContactRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the contact", + "type": "string", + "x-ms-summary": "Contact ID" + }, + "properties": { + "$ref": "#/definitions/ContactProperties" + }, + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of contact creation", + "type": "string", + "x-ms-summary": "Contact Created Date" + }, + "updatedAt": { + "description": "Date of contact last updated", + "type": "string", + "x-ms-summary": "Contact Updated Date" + }, + "archived": { + "description": "Whether the contact is archived", + "type": "boolean", + "x-ms-summary": "Contact Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of contact archived", + "type": "string", + "x-ms-summary": "Contact Archived Date" + } + } + }, + "DealProperties": { + "type": "object", + "properties": { + "amount": { + "title": "Amount", + "type": "string", + "description": "Amount." + }, + "amount_in_home_currency": { + "title": "Amount in home currency", + "type": "string", + "description": "Amount in home currency." + }, + "closed_lost_reason": { + "title": "Closed lost reason", + "type": "string", + "description": "Closed lost reason." + }, + "closed_won_reason": { + "title": "Closed won reason", + "type": "string", + "description": "Closed won reason." + }, + "closedate": { + "title": "Close date", + "type": "string", + "description": "The close date." + }, + "createdate": { + "title": "Create date", + "type": "string", + "description": "The created on date." + }, + "dealname": { + "title": "Deal name", + "type": "string", + "description": "Deal name." + }, + "dealstage": { + "title": "Deal stage", + "type": "string", + "description": "Deal stage." + }, + "dealtype": { + "title": "Deal type", + "type": "string", + "description": "Deal type." + }, + "description": { + "title": "Description", + "type": "string", + "description": "A description of the object." + }, + "engagements_last_meeting_booked": { + "title": "Engagements last meeting booked", + "type": "string", + "description": "The engagements last meeting booked." + }, + "engagements_last_meeting_booked_campaign": { + "title": "Engagements last meeting booked campaign", + "type": "string", + "description": "The engagements last meeting booked campaign." + }, + "engagements_last_meeting_booked_medium": { + "title": "Engagements last meeting booked medium", + "type": "string", + "description": "The engagements last meeting booked medium." + }, + "engagements_last_meeting_booked_source": { + "title": "Engagements last meeting booked source", + "type": "string", + "description": "The engagements last meeting booked source." + }, + "hs_acv": { + "title": "ACV", + "type": "string", + "description": "HubSpot - ACV" + }, + "hs_analytics_source": { + "title": "HubSpot analytics source", + "type": "string", + "description": "HubSpot Analytics - source." + }, + "hs_analytics_source_data_1": { + "title": "HubSpot analytics source data 1", + "type": "string", + "description": "HubSpot Analytics - source data 1." + }, + "hs_analytics_source_data_2": { + "title": "HubSpot analytics source data 2", + "type": "string", + "description": "HubSpot Analytics - source data 2." + }, + "hs_arr": { + "title": "HubSpot annual recurring revenue", + "type": "string", + "description": "HubSpot - annual recurring revenue." + }, + "hs_forecast_amount": { + "title": "HubSpot forecast amount", + "type": "string", + "description": "HubSpot - forecast amount." + }, + "hs_forecast_probability": { + "title": "HubSpot forecast probability", + "type": "string", + "description": "HubSpot - forecast probability." + }, + "hs_lastmodifieddate": { + "title": "HubSpot last modified date", + "type": "string", + "description": "HubSpot - last modified date." + }, + "hs_manual_forecast_category": { + "title": "HubSpot manual forecast category", + "type": "string", + "description": "HubSpot - manual forecast category." + }, + "hs_mrr": { + "title": "HubSpot monthly reoccuring revenue", + "type": "string", + "description": "HubSpot - monthly reoccuring revenue." + }, + "hs_next_step": { + "title": "HubSpot next step", + "type": "string", + "description": "HubSpot - next step." + }, + "hs_object_id": { + "title": "HubSpot object ID", + "type": "string", + "description": "HubSpot - object ID." + }, + "hs_priority": { + "title": "HubSpot priority", + "type": "string", + "description": "HubSpot - priority" + }, + "hs_tcv": { + "title": "HubSpot total contract value", + "type": "string", + "description": "HubSpot - tcv" + }, + "hubspot_owner_assigneddate": { + "title": "HubSpot owner assigned date", + "type": "string", + "description": "HubSpot - owner assigned date." + }, + "hubspot_owner_id": { + "title": "HubSpot owner ID", + "type": "string", + "description": "HubSpot - owner ID." + }, + "hubspot_team_id": { + "title": "HubSpot team ID", + "type": "string", + "description": "HubSpot - team ID." + }, + "notes_last_contacted": { + "title": "Notes last contacted", + "type": "string", + "description": "Notes - last contacted." + }, + "notes_last_updated": { + "title": "Notes last updated", + "type": "string", + "description": "Notes - last updated." + }, + "notes_next_activity_date": { + "title": "Notes next activity date", + "type": "string", + "description": "Notes - next activity date." + }, + "num_associated_contacts": { + "title": "Number of associated contacts", + "type": "string", + "description": "The number of associated contacts." + }, + "num_contacted_notes": { + "title": "Number of contacted notes", + "type": "string", + "description": "The number of contacted notes" + }, + "num_notes": { + "title": "Number of notes", + "type": "string", + "description": "The number of notes" + }, + "pipeline": { + "title": "Pipeline", + "type": "string", + "description": "Pipeline." + } }, - "post": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "additionalProperties": { + "type": "string" + } + }, + "DealRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the deal", + "type": "string", + "x-ms-summary": "Deal ID" }, - "summary": "Create a deal", - "description": "Create a deal with the given properties and return a copy of the object, including the ID.", - "operationId": "DealsCreate", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "amount": { - "title": "Amount", - "type": "string", - "description": "Amount." - }, - "amount_in_home_currency": { - "title": "Amount in home currency", - "type": "string", - "description": "Amount in home currency." - }, - "closed_lost_reason": { - "title": "Closed lost reason", - "type": "string", - "description": "Closed lost reason." - }, - "closed_won_reason": { - "title": "Closed won reason", - "type": "string", - "description": "Closed won reason." - }, - "closedate": { - "title": "Close date", - "type": "string", - "description": "The close date." - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "dealname": { - "title": "Deal name", - "type": "string", - "description": "Deal name." - }, - "dealstage": { - "title": "Deal stage", - "type": "string", - "description": "Deal stage." - }, - "dealtype": { - "title": "Deal type", - "type": "string", - "description": "Deal type." - }, - "description": { - "title": "Description", - "type": "string", - "description": "A description of the object." - }, - "engagements_last_meeting_booked": { - "title": "Engagements last meeting booked", - "type": "string", - "description": "The engagements last meeting booked." - }, - "engagements_last_meeting_booked_campaign": { - "title": "Engagements last meeting booked campaign", - "type": "string", - "description": "The engagements last meeting booked campaign." - }, - "engagements_last_meeting_booked_medium": { - "title": "Engagements last meeting booked medium", - "type": "string", - "description": "The engagements last meeting booked medium." - }, - "engagements_last_meeting_booked_source": { - "title": "Engagements last meeting booked source", - "type": "string", - "description": "The engagements last meeting booked source." - }, - "hs_acv": { - "title": "ACV", - "type": "string", - "description": "HubSpot - ACV" - }, - "hs_analytics_source": { - "title": "HubSpot analytics source", - "type": "string", - "description": "HubSpot Analytics - source." - }, - "hs_analytics_source_data_1": { - "title": "HubSpot analytics source data 1", - "type": "string", - "description": "HubSpot Analytics - source data 1." - }, - "hs_analytics_source_data_2": { - "title": "HubSpot analytics source data 2", - "type": "string", - "description": "HubSpot Analytics - source data 2." - }, - "hs_arr": { - "title": "HubSpot annual recurring revenue", - "type": "string", - "description": "HubSpot - annual recurring revenue." - }, - "hs_forecast_amount": { - "title": "HubSpot forecast amount", - "type": "string", - "description": "HubSpot - forecast amount." - }, - "hs_forecast_probability": { - "title": "HubSpot forecast probability", - "type": "string", - "description": "HubSpot - forecast probability." - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_manual_forecast_category": { - "title": "HubSpot manual forecast category", - "type": "string", - "description": "HubSpot - manual forecast category." - }, - "hs_mrr": { - "title": "HubSpot monthly reoccuring revenue", - "type": "string", - "description": "HubSpot - monthly reoccuring revenue." - }, - "hs_next_step": { - "title": "HubSpot next step", - "type": "string", - "description": "HubSpot - next step." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_priority": { - "title": "HubSpot priority", - "type": "string", - "description": "HubSpot - priority" - }, - "hs_tcv": { - "title": "HubSpot total contract value", - "type": "string", - "description": "HubSpot - tcv" - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", - "type": "string", - "description": "HubSpot - owner ID." - }, - "hubspot_team_id": { - "title": "HubSpot team ID", - "type": "string", - "description": "HubSpot - team ID." - }, - "notes_last_contacted": { - "title": "Notes last contacted", - "type": "string", - "description": "Notes - last contacted." - }, - "notes_last_updated": { - "title": "Notes last updated", - "type": "string", - "description": "Notes - last updated." - }, - "notes_next_activity_date": { - "title": "Notes next activity date", - "type": "string", - "description": "Notes - next activity date." - }, - "num_associated_contacts": { - "title": "Number of associated contacts", - "type": "string", - "description": "The number of associated contacts." - }, - "num_contacted_notes": { - "title": "Number of contacted notes", - "type": "string", - "description": "The number of contacted notes" - }, - "num_notes": { - "title": "Number of notes", - "type": "string", - "description": "The number of notes" - }, - "pipeline": { - "title": "Pipeline", - "type": "string", - "description": "Pipeline." - } - } - } - } - } - } - ] + "properties": { + "$ref": "#/definitions/DealProperties" + }, + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of deal creation", + "type": "string", + "x-ms-summary": "Deal Created Date" + }, + "updatedAt": { + "description": "Date of deal last updated", + "type": "string", + "x-ms-summary": "Deal Updated Date" + }, + "archived": { + "description": "Whether the deal is archived", + "type": "boolean", + "x-ms-summary": "Deal Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of deal archived", + "type": "string", + "x-ms-summary": "Deal Archived Date" + } } }, - "/crm/v3/objects/deals/{dealId}": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "ProductProperties": { + "type": "object", + "properties": { + "createdate": { + "title": "Create date", + "type": "string", + "description": "The created on date." }, - "summary": "Get a deal", - "description": "Read a deal identified by {dealId}.", - "operationId": "DealsRead", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "dealId", - "in": "path", - "required": true, - "type": "string", - "description": "The dealId of the deal", - "x-ms-visibility": "important", - "x-ms-summary": "dealId", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "advanced", - "x-ms-summary": "properties", - "x-ms-url-encoding": "single" - }, - { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-summary": "archived", - "x-ms-url-encoding": "single" - } - ] - }, - "delete": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "description": { + "title": "Description", + "type": "string", + "description": "A description of the object." }, - "summary": "Delete a deal", - "description": "Move a deal identified by {dealId} to the recycling bin.", - "operationId": "DealsArchive", - "x-ms-visibility": "advanced", - "parameters": [ - { - "name": "dealId", - "in": "path", - "required": true, - "type": "string", - "description": "The dealId of the deal", - "x-ms-visibility": "important", - "x-ms-summary": "dealId", - "x-ms-url-encoding": "single" - } - ] - }, - "patch": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "hs_cost_of_goods_sold": { + "title": "HubSpot cost of goods sold", + "type": "string", + "description": "HubSpot - cost of goods sold." }, - "summary": "Update a deal", - "description": "Perform a partial update of a deal identified by {dealId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", - "operationId": "DealsUpdate", - "parameters": [ - { - "name": "dealId", - "in": "path", - "required": true, - "type": "string", - "description": "Deal ID", - "x-ms-summary": "dealId", - "x-ms-url-encoding": "single" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "amount": { - "title": "Amount", - "type": "string", - "description": "Amount." - }, - "amount_in_home_currency": { - "title": "Amount in home currency", - "type": "string", - "description": "Amount in home currency." - }, - "closed_lost_reason": { - "title": "Closed lost reason", - "type": "string", - "description": "Closed lost reason." - }, - "closed_won_reason": { - "title": "Closed won reason", - "type": "string", - "description": "Closed won reason." - }, - "closedate": { - "title": "Close date", - "type": "string", - "description": "The close date." - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "dealname": { - "title": "Deal name", - "type": "string", - "description": "Deal name." - }, - "dealstage": { - "title": "Deal stage", - "type": "string", - "description": "Deal stage." - }, - "dealtype": { - "title": "Deal type", - "type": "string", - "description": "Deal type." - }, - "description": { - "title": "Description", - "type": "string", - "description": "A description of the object." - }, - "engagements_last_meeting_booked": { - "title": "Engagements last meeting booked", - "type": "string", - "description": "The engagements last meeting booked." - }, - "engagements_last_meeting_booked_campaign": { - "title": "Engagements last meeting booked campaign", - "type": "string", - "description": "The engagements last meeting booked campaign." - }, - "engagements_last_meeting_booked_medium": { - "title": "Engagements last meeting booked medium", - "type": "string", - "description": "The engagements last meeting booked medium." - }, - "engagements_last_meeting_booked_source": { - "title": "Engagements last meeting booked source", - "type": "string", - "description": "The engagements last meeting booked source." - }, - "hs_acv": { - "title": "ACV", - "type": "string", - "description": "HubSpot - ACV" - }, - "hs_analytics_source": { - "title": "HubSpot analytics source", - "type": "string", - "description": "HubSpot Analytics - source." - }, - "hs_analytics_source_data_1": { - "title": "HubSpot analytics source data 1", - "type": "string", - "description": "HubSpot Analytics - source data 1." - }, - "hs_analytics_source_data_2": { - "title": "HubSpot analytics source data 2", - "type": "string", - "description": "HubSpot Analytics - source data 2." - }, - "hs_arr": { - "title": "HubSpot annual recurring revenue", - "type": "string", - "description": "HubSpot - annual recurring revenue." - }, - "hs_forecast_amount": { - "title": "HubSpot forecast amount", - "type": "string", - "description": "HubSpot - forecast amount." - }, - "hs_forecast_probability": { - "title": "HubSpot forecast probability", - "type": "string", - "description": "HubSpot - forecast probability." - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_manual_forecast_category": { - "title": "HubSpot manual forecast category", - "type": "string", - "description": "HubSpot - manual forecast category." - }, - "hs_mrr": { - "title": "HubSpot monthly reoccuring revenue", - "type": "string", - "description": "HubSpot - monthly reoccuring revenue." - }, - "hs_next_step": { - "title": "HubSpot next step", - "type": "string", - "description": "HubSpot - next step." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_priority": { - "title": "HubSpot priority", - "type": "string", - "description": "HubSpot - priority" - }, - "hs_tcv": { - "title": "HubSpot total contract value", - "type": "string", - "description": "HubSpot - tcv" - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", - "type": "string", - "description": "HubSpot - owner ID." - }, - "hubspot_team_id": { - "title": "HubSpot team ID", - "type": "string", - "description": "HubSpot - team ID." - }, - "notes_last_contacted": { - "title": "Notes last contacted", - "type": "string", - "description": "Notes - last contacted." - }, - "notes_last_updated": { - "title": "Notes last updated", - "type": "string", - "description": "Notes - last updated." - }, - "notes_next_activity_date": { - "title": "Notes next activity date", - "type": "string", - "description": "Notes - next activity date." - }, - "num_associated_contacts": { - "title": "Number of associated contacts", - "type": "string", - "description": "The number of associated contacts." - }, - "num_contacted_notes": { - "title": "Number of contacted notes", - "type": "string", - "description": "The number of contacted notes" - }, - "num_notes": { - "title": "Number of notes", - "type": "string", - "description": "The number of notes" - }, - "pipeline": { - "title": "Pipeline", - "type": "string", - "description": "Pipeline." - } - } - } - } - } - } - ] + "hs_created_by_user_id": { + "title": "HubSpot created by user ID", + "type": "string", + "description": "HubSpot - created by user id." + }, + "hs_createdate": { + "title": "Create date", + "type": "string", + "description": "HubSpot - create date." + }, + "hs_images": { + "title": "HubSpot images", + "type": "string", + "description": "HubSpot - images" + }, + "hs_lastmodifieddate": { + "title": "HubSpot last modified date", + "type": "string", + "description": "HubSpot - last modified date." + }, + "hs_object_id": { + "title": "HubSpot object ID", + "type": "string", + "description": "HubSpot - object ID." + }, + "hs_recurring_billing_period": { + "title": "HubSpot recurring billing period", + "type": "string", + "description": "HubSpot - recurring billing period." + }, + "hs_sku": { + "title": "HubSpot SKU", + "type": "string", + "description": "HubSpot - SKU." + }, + "hs_updated_by_user_id": { + "title": "HubSpot updated by user ID", + "type": "string", + "description": "HubSpot - updated by user ID." + }, + "hs_url": { + "title": "HubSpot URL", + "type": "string", + "description": "HubSpot - URL." + }, + "name": { + "title": "Name", + "type": "string", + "description": "Name." + }, + "price": { + "title": "Price", + "type": "string", + "description": "Price." + }, + "recurringbillingfrequency": { + "title": "Recurring billing frequency", + "type": "string", + "description": "Recurring billing frequency." + }, + "tax": { + "title": "Tax", + "type": "string", + "description": "Tax." + } + }, + "additionalProperties": { + "type": "string" } }, - "/crm/v3/objects/products": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "ProductRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the product", + "type": "string", + "x-ms-summary": "Product ID" }, - "summary": "List products", - "description": "Return a list of products", - "operationId": "ProductsList", - "parameters": [ - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "default": 10, - "x-ms-visibility": "advanced", - "description": "Limit", - "x-ms-summary": "limit", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "advanced", - "x-ms-summary": "properties", - "x-ms-url-encoding": "single" - }, - { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-summary": "archived", - "x-ms-url-encoding": "single" - } - ], - "x-ms-visibility": "important" - }, - "post": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "properties": { + "$ref": "#/definitions/ProductProperties" }, - "summary": "Create a product", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "description": { - "title": "Description", - "type": "string", - "description": "A description of the object." - }, - "hs_cost_of_goods_sold": { - "title": "HubSpot cost of goods sold", - "type": "string", - "description": "HubSpot - cost of goods sold." - }, - "hs_created_by_user_id": { - "title": "HubSpot created by user ID", - "type": "string", - "description": "HubSpot - created by user id." - }, - "hs_createdate": { - "title": "Create date", - "type": "string", - "description": "HubSpot - create date." - }, - "hs_images": { - "title": "HubSpot images", - "type": "string", - "description": "HubSpot - images" - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_recurring_billing_period": { - "title": "HubSpot recurring billing period", - "type": "string", - "description": "HubSpot - recurring billing period." - }, - "hs_sku": { - "title": "HubSpot SKU", - "type": "string", - "description": "HubSpot - SKU." - }, - "hs_updated_by_user_id": { - "title": "HubSpot updated by user ID", - "type": "string", - "description": "HubSpot - updated by user ID." - }, - "hs_url": { - "title": "HubSpot URL", - "type": "string", - "description": "HubSpot - URL." - }, - "name": { - "title": "Name", - "type": "string", - "description": "Name." - }, - "price": { - "title": "Price", - "type": "string", - "description": "Price." - }, - "recurringbillingfrequency": { - "title": "Recurring billing frequency", - "type": "string", - "description": "Recurring billing frequency." - }, - "tax": { - "title": "Tax", - "type": "string", - "description": "Tax." - } - } - } - } - } - } - ], - "description": "Create a product with the given properties and return a copy of the object, including the ID.", - "operationId": "ProductsCreate", - "x-ms-visibility": "important" + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of product creation", + "type": "string", + "x-ms-summary": "Product Created Date" + }, + "updatedAt": { + "description": "Date of product last updated", + "type": "string", + "x-ms-summary": "Product Updated Date" + }, + "archived": { + "description": "Whether the product is archived", + "type": "boolean", + "x-ms-summary": "Product Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of product archived", + "type": "string", + "x-ms-summary": "Product Archived Date" + } } }, - "/crm/v3/objects/products/{productId}": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } - }, - "summary": "Get a product", - "description": "Read a product identified by {productId}.", - "operationId": "ProductsRead", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "productId", - "in": "path", - "required": true, - "type": "string", - "description": "The productId of the product", - "x-ms-visibility": "important", - "x-ms-summary": "productId", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "advanced", - "x-ms-summary": "properties", - "x-ms-url-encoding": "single" + "LineItemProperties": { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "name": { + "title": "Name", + "type": "string", + "description": "Name." + }, + "hs_product_id": { + "title": "HubSpot product ID", + "type": "string", + "description": "HubSpot - product ID." + }, + "hs_recurring_billing_period": { + "title": "HubSpot recurring billing period", + "type": "string", + "description": "HubSpot - recurring billing period." + }, + "recurringbillingfrequency": { + "title": "Recurring billing frequency", + "type": "string", + "description": "Recurring billing frequency." + }, + "quantity": { + "title": "Quantity", + "type": "string", + "description": "Quantity." + }, + "price": { + "title": "Price", + "type": "string", + "description": "Price." + } }, - { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-summary": "archived", - "x-ms-url-encoding": "single" - } - ] + "description": "Properties." + } }, - "delete": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "additionalProperties": { + "type": "string" + } + }, + "LineItemRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the line item", + "type": "string", + "x-ms-summary": "Line item ID" }, - "summary": "Delete a product", - "description": "Move a product identified by {productId} to the recycling bin.", - "operationId": "ProductsArchive", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "productId", - "in": "path", - "required": true, - "type": "string", - "description": "The productID of the product", - "x-ms-visibility": "important", - "x-ms-summary": "archived", - "x-ms-url-encoding": "single" - } - ] - }, - "patch": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "properties": { + "$ref": "#/definitions/LineItemProperties" }, - "summary": "Update a product", - "description": "Perform a partial update of a product identified by {productId}. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", - "operationId": "ProductsUpdate", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "productId", - "in": "path", - "required": true, - "type": "string", - "description": "The productId of the product", - "x-ms-visibility": "important", - "x-ms-summary": "productId", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "body", - "required": false, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "description": { - "title": "Description", - "type": "string", - "description": "A description of the object." - }, - "hs_cost_of_goods_sold": { - "title": "HubSpot cost of goods sold", - "type": "string", - "description": "HubSpot - cost of goods sold." - }, - "hs_created_by_user_id": { - "title": "HubSpot created by user ID", - "type": "string", - "description": "HubSpot - created by user id." - }, - "hs_createdate": { - "title": "Create date", - "type": "string", - "description": "HubSpot - create date." - }, - "hs_images": { - "title": "HubSpot images", - "type": "string", - "description": "HubSpot - images" - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_object_id": { - "title": "HubSpot object ID", - "type": "string", - "description": "HubSpot - object ID." - }, - "hs_recurring_billing_period": { - "title": "HubSpot recurring billing period", - "type": "string", - "description": "HubSpot - recurring billing period." - }, - "hs_sku": { - "title": "HubSpot SKU", - "type": "string", - "description": "HubSpot - SKU." - }, - "hs_updated_by_user_id": { - "title": "HubSpot updated by user ID", - "type": "string", - "description": "HubSpot - updated by user ID." - }, - "hs_url": { - "title": "HubSpot URL", - "type": "string", - "description": "HubSpot - URL." - }, - "name": { - "title": "Name", - "type": "string", - "description": "Name." - }, - "price": { - "title": "Price", - "type": "string", - "description": "Price." - }, - "recurringbillingfrequency": { - "title": "Recurring billing frequency", - "type": "string", - "description": "Recurring billing frequency." - }, - "tax": { - "title": "Tax", - "type": "string", - "description": "Tax." - } - } - } - } - } - } - ] + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of line item creation", + "type": "string", + "x-ms-summary": "Line item Created Date" + }, + "updatedAt": { + "description": "Date of line item last updated", + "type": "string", + "x-ms-summary": "Line item Updated Date" + }, + "archived": { + "description": "Whether the line item is archived", + "type": "boolean", + "x-ms-summary": "Line item Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of line item archived", + "type": "string", + "x-ms-summary": "Line item Archived Date" + } } }, - "/crm/v3/objects/line_items": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "TicketProperties": { + "type": "object", + "properties": { + "closed_date": { + "title": "Closed date", + "type": "string", + "description": "Closed date" }, - "summary": "List line items", - "description": "Return a list of line items. Control what is returned via the properties query param.", - "operationId": "LineItemsList", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "limit", - "in": "query", - "required": true, - "type": "integer", - "default": 10, - "description": "The maximum number of results to display per page.", - "x-ms-summary": "The maximum number of results to display per page.", - "x-ms-visibility": "advanced", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-summary": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "advanced", - "x-ms-url-encoding": "single" - }, - { - "name": "associations", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of object types to retrieve associated IDs for.", - "x-ms-summary": "A comma separated list of object types to retrieve associated IDs for.", - "x-ms-visibility": "advanced", - "x-ms-url-encoding": "single" - }, - { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-summary": "Whether to return only results that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-url-encoding": "single" - } - ] + "createdate": { + "title": "Create date", + "type": "string", + "description": "The created on date." + }, + "first_agent_reply_date": { + "title": "First agent reply date", + "type": "string", + "description": "First agent reply date." + }, + "hs_feedback_last_ces_follow_up": { + "title": "HubSpot feedback last CES follow up", + "type": "string", + "description": "HubSpot - feedback last CES follow up." + }, + "hs_feedback_last_ces_rating": { + "title": "HubSpot feedback last CES rating", + "type": "string", + "description": "HubSpot - feedback last CES rating." + }, + "hs_feedback_last_survey_date": { + "title": "HubSpot feedback last survey date", + "type": "string", + "description": "HubSpot - feedback last survey date." + }, + "hs_lastactivitydate": { + "title": "HubSpot last activity date", + "type": "string", + "description": "HubSpot - last activity date." + }, + "hs_lastcontacted": { + "title": "HubSpot last contacted", + "type": "string", + "description": "HubSpot - last contacted." + }, + "hs_lastmodifieddate": { + "title": "HubSpot last modified date", + "type": "string", + "description": "HubSpot - last modified date." + }, + "hs_nextactivitydate": { + "title": "HubSpot next activity date", + "type": "string", + "description": "HubSpot - next activity date." + }, + "hs_num_times_contacted": { + "title": "HubSpot number of times contacted", + "type": "string", + "description": "HubSpot - number of times contacted." + }, + "hubspot_owner_assigneddate": { + "title": "HubSpot owner assigned date", + "type": "string", + "description": "HubSpot - owner assigned date." + }, + "last_reply_date": { + "title": "Last reply date", + "type": "string", + "description": "Last reply date." + }, + "num_notes": { + "title": "Number of notes", + "type": "string", + "description": "The number of notes" + }, + "time_to_close": { + "title": "Time to close", + "type": "string", + "description": "Time to close." + }, + "time_to_first_agent_reply": { + "title": "Time to first agent reply", + "type": "string", + "description": "Time to first agent reply." + }, + "content": { + "title": "Content", + "type": "string", + "description": "Content." + }, + "hs_file_upload": { + "title": "HubSpot file upload", + "type": "string", + "description": "HubSpot - file upload." + }, + "hs_num_associated_companies": { + "title": "HubSpot number of associated companies", + "type": "string", + "description": "HubSpot - number of associated companies." + }, + "hs_pipeline": { + "title": "HubSpot pipeline", + "type": "string", + "description": "HubSpot - pipeline" + }, + "hs_pipeline_stage": { + "title": "HubSpot pipeline stage", + "type": "string", + "description": "HubSpot - pipeline stage." + }, + "hs_resolution": { + "title": "HubSpot resolution", + "type": "string", + "description": "HubSpot - resolution" + }, + "hs_ticket_category": { + "title": "HubSpot ticket category", + "type": "string", + "description": "HubSpot - ticket category." + }, + "hs_ticket_id": { + "title": "HubSpot ticket ID", + "type": "string", + "description": "HubSpot - ticket ID." + }, + "hs_ticket_priority": { + "title": "HubSpot ticket priority", + "type": "string", + "description": "HubSpot - ticket priority." + }, + "hubspot_owner_id": { + "title": "HubSpot owner ID", + "type": "string", + "description": "HubSpot - owner ID." + }, + "hubspot_team_id": { + "title": "HubSpot team ID", + "type": "string", + "description": "HubSpot - team ID." + }, + "source_type": { + "title": "Source type", + "type": "string", + "description": "Source type." + }, + "subject": { + "title": "Subject", + "type": "string", + "description": "Subject." + } }, - "post": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "additionalProperties": { + "type": "string" + } + }, + "TicketRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the ticket", + "type": "string", + "x-ms-summary": "Ticket ID" + }, + "properties": { + "$ref": "#/definitions/TicketProperties" }, - "summary": "Create a line item", - "description": "Create a line item with the given properties and return a copy of the object, including the ID.", - "operationId": "LineItemsCreate", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "properties", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "name": { - "title": "Name", - "type": "string", - "description": "Name." - }, - "hs_product_id": { - "title": "HubSpot product ID", - "type": "string", - "description": "HubSpot - product ID." - }, - "hs_recurring_billing_period": { - "title": "HubSpot recurring billing period", - "type": "string", - "description": "HubSpot - recurring billing period." - }, - "recurringbillingfrequency": { - "title": "Recurring billing frequency", - "type": "string", - "description": "Recurring billing frequency." - }, - "quantity": { - "title": "Quantity", - "type": "string", - "description": "Quantity." - }, - "price": { - "title": "Price", - "type": "string", - "description": "Price." - } - }, - "description": "Properties." - } - }, - "x-ms-visibility": "important" - }, - "x-ms-visibility": "important" - } - ] + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of ticket creation", + "type": "string", + "x-ms-summary": "Ticket Created Date" + }, + "updatedAt": { + "description": "Date of ticket last updated", + "type": "string", + "x-ms-summary": "Ticket Updated Date" + }, + "archived": { + "description": "Whether the ticket is archived", + "type": "boolean", + "x-ms-summary": "Ticket Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of ticket archived", + "type": "string", + "x-ms-summary": "Ticket Archived Date" + } } }, - "/crm/v3/objects/line_items/{lineItemId}": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "MeetingProperties": { + "type": "object", + "properties": { + "createdate": { + "type": "string", + "description": "create date" }, - "summary": "Get a line item", - "description": "Read a lite item identified by {lineItemId}. ", - "operationId": "LineItemsRead", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "lineItemId", - "in": "path", - "required": true, - "type": "string", - "description": "The line item ID", - "x-ms-visibility": "important", - "x-ms-summary": "lineItemId", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-summary": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "associations", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of object types to retrieve associated IDs for.", - "x-ms-summary": "A comma separated list of object types to retrieve associated IDs for.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "idProperty", - "in": "query", - "required": false, - "type": "string", - "description": "The name of a property whose values are unique for this object type", - "x-ms-summary": "The name of a property whose values are unique for this object type", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "description": "Whether to return only results that have been archived.", - "x-ms-summary": "Whether to return only results that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-url-encoding": "single" - } - ] - }, - "delete": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "hs_internal_meeting_notes": { + "type": "string", + "description": "internal meeting notes" }, - "summary": "Delete a line item", - "description": "Move an Object identified by {lineItemId} to the recycling bin.", - "operationId": "LineItemsArchive", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "lineItemId", - "in": "path", - "required": true, - "type": "string", - "x-ms-visibility": "important", - "description": "The line item ID", - "x-ms-summary": "lineItemId", - "x-ms-url-encoding": "single" - } - ] + "hs_lastmodifieddate": { + "type": "string", + "description": "last modified date" + }, + "hs_meeting_body": { + "type": "string", + "description": "meeting body" + }, + "hs_meeting_end_time": { + "type": "string", + "description": "meeting end time" + }, + "hs_meeting_external_url": { + "type": "string", + "description": "meeting external url" + }, + "hs_meeting_location": { + "type": "string", + "description": "meeting location" + }, + "hs_meeting_outcome": { + "type": "string", + "description": "meeting outcome" + }, + "hs_meeting_start_time": { + "type": "string", + "description": "meeting start time" + }, + "hs_meeting_title": { + "type": "string", + "description": "meeting title" + }, + "hs_timestamp": { + "type": "string", + "description": "meeting start time (duplicate))" + }, + "hubspot_owner_id": { + "type": "string", + "description": "meeting organizer" + } }, - "patch": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "additionalProperties": { + "type": "string" + } + }, + "MeetingRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the meeting", + "type": "string", + "x-ms-summary": "Meeting ID" }, - "summary": "Update a line item", - "description": "Perform a partial update of a line item identified by {lineItemId}. {lineItemId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", - "operationId": "LineItemsUpdate", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "lineItemId", - "in": "path", - "required": true, - "type": "string", - "x-ms-visibility": "important", - "description": "The line item ID", - "x-ms-summary": "lineItemId", - "x-ms-url-encoding": "single" - }, - { - "name": "idProperty", - "in": "query", - "required": false, - "type": "string", - "description": "The name of a property whose values are unique for this object type", - "x-ms-summary": "The name of a property whose values are unique for this object type", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "name": { - "title": "Name", - "type": "string", - "description": "Name." - }, - "hs_product_id": { - "title": "HubSpot product ID", - "type": "string", - "description": "HubSpot - product ID." - }, - "hs_recurring_billing_period": { - "title": "HubSpot recurring billing period", - "type": "string", - "description": "HubSpot - recurring billing period." - }, - "recurringbillingfrequency": { - "title": "Recurring billing frequency", - "type": "string", - "description": "Recurring billing frequency." - }, - "quantity": { - "title": "Quantity", - "type": "string", - "description": "Quantity." - }, - "price": { - "title": "Price", - "type": "string", - "description": "Price." - } - }, - "description": "Properties." - } + "properties": { + "$ref": "#/definitions/MeetingProperties" + }, + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of meeting creation", + "type": "string", + "x-ms-summary": "Meeting Created Date" + }, + "updatedAt": { + "description": "Date of meeting last updated", + "type": "string", + "x-ms-summary": "Meeting Updated Date" + }, + "archived": { + "description": "Whether the meeting is archived", + "type": "boolean", + "x-ms-summary": "Meeting Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of meeting archived", + "type": "string", + "x-ms-summary": "Meeting Archived Date" + } + } + }, + "OwnerRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the owner record", + "type": "string", + "x-ms-summary": "Owner Record ID" + }, + "email": { + "description": "Email of the owner", + "type": "string", + "x-ms-summary": "Owner Email" + }, + "firstName": { + "description": "First name of the owner", + "type": "string", + "x-ms-summary": "Owner First Name" + }, + "lastName": { + "description": "Last name of the owner", + "type": "string", + "x-ms-summary": "Owner Last Name" + }, + "userId": { + "description": "ID of the owner", + "type": "integer", + "x-ms-summary": "Owner ID" + }, + "createdAt": { + "description": "Date of owner creation", + "type": "string", + "x-ms-summary": "Owner Created Date" + }, + "updatedAt": { + "description": "Date of owner last updated", + "type": "string", + "x-ms-summary": "Owner Updated Date" + }, + "archived": { + "description": "Whether the owner is archived", + "type": "boolean", + "x-ms-summary": "Owner Archived" + }, + "teams": { + "description": "Teams the owner is a part of", + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the team", + "type": "string" + }, + "name": { + "description": "Name of the team", + "type": "string" }, - "x-ms-visibility": "important" + "primary": { + "description": "Whether this is the owner's primary team", + "type": "boolean" + } } } - ] + } } }, - "/crm/v3/objects/tickets": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "ObjectProperties": { + "type": "object", + "description": "Since these properties will vary they must be entered as a body", + "additionalProperties": { + "type": "string" + } + }, + "ObjectRecord": { + "type": "object", + "properties": { + "id": { + "description": "Unique identifier for the custom object record", + "type": "string", + "x-ms-summary": "Custom Object ID" }, - "summary": "List tickets", - "description": "Read a page of tickets. Control what is returned via the properties query param.", - "operationId": "TicketsList", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "limit", - "in": "query", - "required": false, - "type": "integer", - "default": 10, - "description": "The maximum number of results to display per page.", - "x-ms-summary": "The maximum number of results to display per page.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-summary": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "associations", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of object types to retrieve associated IDs for.", - "x-ms-summary": "A comma separated list of object types to retrieve associated IDs for.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-summary": "Whether to return only results that have been archived.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - } - ] - }, - "post": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "properties": { + "$ref": "#/definitions/ObjectProperties" }, - "summary": "Create a ticket", - "description": "Create a ticket with the given properties and return a copy of the object, including the ID. Documentation and examples for creating standard tickets is provided.", - "operationId": "TicketsCreate", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { - "properties": { - "type": "object", - "properties": { - "closed_date": { - "title": "Closed date", - "type": "string", - "description": "Closed date" - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "first_agent_reply_date": { - "title": "First agent reply date", - "type": "string", - "description": "First agent reply date." - }, - "hs_feedback_last_ces_follow_up": { - "title": "HubSpot feedback last CES follow up", - "type": "string", - "description": "HubSpot - feedback last CES follow up." - }, - "hs_feedback_last_ces_rating": { - "title": "HubSpot feedback last CES rating", - "type": "string", - "description": "HubSpot - feedback last CES rating." - }, - "hs_feedback_last_survey_date": { - "title": "HubSpot feedback last survey date", - "type": "string", - "description": "HubSpot - feedback last survey date." - }, - "hs_lastactivitydate": { - "title": "HubSpot last activity date", - "type": "string", - "description": "HubSpot - last activity date." - }, - "hs_lastcontacted": { - "title": "HubSpot last contacted", - "type": "string", - "description": "HubSpot - last contacted." - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_nextactivitydate": { - "title": "HubSpot next activity date", - "type": "string", - "description": "HubSpot - next activity date." - }, - "hs_num_times_contacted": { - "title": "HubSpot number of times contacted", - "type": "string", - "description": "HubSpot - number of times contacted." - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "last_reply_date": { - "title": "Last reply date", - "type": "string", - "description": "Last reply date." - }, - "num_notes": { - "title": "Number of notes", - "type": "string", - "description": "The number of notes" - }, - "time_to_close": { - "title": "Time to close", - "type": "string", - "description": "Time to close." - }, - "time_to_first_agent_reply": { - "title": "Time to first agent reply", - "type": "string", - "description": "Time to first agent reply." - }, - "content": { - "title": "Content", - "type": "string", - "description": "Content." - }, - "hs_file_upload": { - "title": "HubSpot file upload", - "type": "string", - "description": "HubSpot - file upload." - }, - "hs_num_associated_companies": { - "title": "HubSpot number of associated companies", - "type": "string", - "description": "HubSpot - number of associated companies." - }, - "hs_pipeline": { - "title": "HubSpot pipeline", - "type": "string", - "description": "HubSpot - pipeline" - }, - "hs_pipeline_stage": { - "title": "HubSpot pipeline stage", - "type": "string", - "description": "HubSpot - pipeline stage." - }, - "hs_resolution": { - "title": "HubSpot resolution", - "type": "string", - "description": "HubSpot - resolution" - }, - "hs_ticket_category": { - "title": "HubSpot ticket category", - "type": "string", - "description": "HubSpot - ticket category." - }, - "hs_ticket_id": { - "title": "HubSpot ticket ID", - "type": "string", - "description": "HubSpot - ticket ID." - }, - "hs_ticket_priority": { - "title": "HubSpot ticket priority", - "type": "string", - "description": "HubSpot - ticket priority." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", + "propertiesWithHistory": { + "$ref": "#/definitions/PropertiesWithHistory" + }, + "createdAt": { + "description": "Date of custom object creation", + "type": "string", + "x-ms-summary": "Custom Object Created Date" + }, + "updatedAt": { + "description": "Date of custom object last updated", + "type": "string", + "x-ms-summary": "Custom Object Updated Date" + }, + "archived": { + "description": "Whether the custom object is archived", + "type": "boolean", + "x-ms-summary": "Custom Object Archived" + }, + "associations": { + "$ref": "#/definitions/Associations" + }, + "archivedAt": { + "description": "Date of custom object archived", + "type": "string", + "x-ms-summary": "Custom Object Archived Date" + } + } + }, + "Search": { + "type": "object", + "properties": { + "query": { + "title": "Query", + "type": "string", + "description": "Searches for a string in a default text property, returns a set of contacts with this string that meet the other filters (if any)" + }, + "limit": { + "title": "Limit", + "type": "integer", + "description": "The maximum number of results to return, up to 100 (default 10)" + }, + "after": { + "title": "After", + "type": "integer", + "description": "Skips this many records before returning data, necessary for retrieving contacts beyond the first 100 (String, default \"0\")" + }, + "properties": { + "title": "Properties", + "type": "array", + "description": "An array of properties to be returned in the response.", + "items": { + "type": "string" + } + }, + "sorts": { + "title": "Sorts", + "type": "array", + "description": "An array of objects that specify what properties to sort by", + "items": { + "type": "object", + "properties": { + "propertyName": { + "title": "Property Name", + "type": "string", + "description": "Name of the property to sort by" + }, + "direction": { + "title": "Direction", + "type": "string", + "description": "Direction to sort (ASCENDING or DESCENDING)" + } + } + } + }, + "filters": { + "title": "Filters", + "type": "array", + "description": "Array of filter objects, contacts meeting all of the conditions are returned", + "items": { + "type": "object", + "properties": { + "propertyName": { + "title": "Property Name", + "type": "string", + "description": "property name" + }, + "operator": { + "title": "Operator", + "type": "string", + "description": "operator" + }, + "value": { + "title": "Value", + "type": "string", + "description": "value" + }, + "highValue": { + "title": "High Value", + "type": "string", + "description": "high value" + } + } + } + }, + "filterGroups": { + "title": "Filter groups", + "type": "array", + "description": "Group of filter arrays, contacts meeting one of the group's conditions are returned", + "items": { + "type": "object", + "properties": { + "filters": { + "title": "Filters", + "type": "array", + "description": "Filters (one of multiple sets)", + "items": { + "type": "object", + "properties": { + "propertyName": { + "title": "Property Name", "type": "string", - "description": "HubSpot - owner ID." + "description": "Name of property to check" }, - "hubspot_team_id": { - "title": "HubSpot team ID", + "operator": { + "title": "Operator", "type": "string", - "description": "HubSpot - team ID." + "description": "Operator identifier (see https://developers.hubspot.com/docs/api/crm/search)" }, - "source_type": { - "title": "Source type", + "value": { + "title": "Value", "type": "string", - "description": "Source type." + "description": "Value for operation (if necessary)" }, - "subject": { - "title": "Subject", + "highValue": { + "title": "High Value", "type": "string", - "description": "Subject." + "description": "High Value (for BETWEEN operation)" } } } } } } - ] - } + } + }, + "x-ms-visibility": "important" }, - "/crm/v3/objects/tickets/{ticketId}": { - "get": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "ErrorModel": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A human readable message describing the error along with remediation steps where appropriate." }, - "summary": "Get a ticket", - "description": "Read a ticket identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Control what is returned via the properties query param.", - "operationId": "TicketsRead", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "ticketId", - "in": "path", - "required": true, - "type": "string", - "x-ms-visibility": "important", - "description": "The ticket ID", - "x-ms-summary": "ticketID", - "x-ms-url-encoding": "single" - }, - { - "name": "properties", - "in": "query", - "required": false, - "type": "string", - "description": "A comma separated list of the properties to be returned in the response.", - "x-ms-summary": "A comma separated list of the properties to be returned in the response.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "archived", - "in": "query", - "required": false, - "type": "boolean", - "default": false, - "description": "Whether to return only results that have been archived.", - "x-ms-summary": "Whether to return only results that have been archived.", - "x-ms-visibility": "advanced", - "x-ms-url-encoding": "single" - }, - { - "name": "idProperty", - "in": "query", - "required": false, - "type": "string", - "description": "The name of a property whose values are unique for this object type.", - "x-ms-summary": "The name of a property whose values are unique for this object type.", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - } - ] - }, - "delete": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} - } + "correlationId": { + "type": "string", + "description": "A unique identifier for the request. Include this value with any error reports or support tickets." }, - "summary": "Delete a ticket", - "description": "Move a ticket identified by {ticketId} to the recycling bin.", - "operationId": "TicketsArchive", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "ticketId", - "in": "path", - "required": true, - "type": "string", - "x-ms-visibility": "important", - "description": "The ticket ID", - "x-ms-summary": "ticketID", - "x-ms-url-encoding": "single" + "category": { + "type": "string", + "description": "The error category." + }, + "subCategory": { + "type": "string", + "description": "A specific category that contains more specific detail about the error." + }, + "links": { + "type": "object", + "description": "A map of link names to associated URIs containing documentation about the error or recommended remediation steps.", + "additionalProperties": { + "type": "string" } - ] - }, - "patch": { - "responses": { - "default": { - "description": "The default response.", - "schema": {} + }, + "context": { + "type": "object", + "description": "Context about the error condition.", + "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + } + } } }, - "operationId": "TicketsUpdate", - "summary": "Update a ticket", - "description": "Perform a partial update of a ticket identified by {ticketId}. {ticketId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param. Provided property values will be overwritten. Read-only and non-existent properties will be ignored. Properties values can be cleared by passing an empty string.", - "x-ms-visibility": "important", - "parameters": [ - { - "name": "ticketId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the ticket.", - "x-ms-summary": "ticketID", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "idProperty", - "in": "query", - "required": false, - "type": "string", - "description": "The name of a property whose values are unique for this object type", - "x-ms-summary": "The name of a property whose values are unique for this object type", - "x-ms-visibility": "important", - "x-ms-url-encoding": "single" - }, - { - "name": "body", - "in": "body", - "required": true, - "schema": { - "type": "object", - "properties": { + "errors": { + "type": "array", + "items": { + "type": "object", + "properties": { + "message": { + "type": "string", + "description": "A human readable message describing the error along with remediation steps where appropriate." + }, + "in": { + "type": "string", + "description": "The name of the field or parameter in which the error was found." + }, + "code": { + "type": "string", + "description": "The status code associated with the error detail." + }, + "subCategory": { + "type": "string", + "description": "A specific category that contains more specific detail about the error." + }, + "context": { + "type": "object", + "description": "Context about the error condition.", "properties": { + "properties": { + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + } + } + } + }, + "AssociationsCreate": { + "type": "array", + "items": { + "type": "object", + "properties": { + "to": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "types": { + "type": "array", + "items": { "type": "object", "properties": { - "closed_date": { - "title": "Closed date", - "type": "string", - "description": "Closed date" - }, - "createdate": { - "title": "Create date", - "type": "string", - "description": "The created on date." - }, - "first_agent_reply_date": { - "title": "First agent reply date", - "type": "string", - "description": "First agent reply date." - }, - "hs_feedback_last_ces_follow_up": { - "title": "HubSpot feedback last CES follow up", - "type": "string", - "description": "HubSpot - feedback last CES follow up." - }, - "hs_feedback_last_ces_rating": { - "title": "HubSpot feedback last CES rating", - "type": "string", - "description": "HubSpot - feedback last CES rating." - }, - "hs_feedback_last_survey_date": { - "title": "HubSpot feedback last survey date", - "type": "string", - "description": "HubSpot - feedback last survey date." - }, - "hs_lastactivitydate": { - "title": "HubSpot last activity date", - "type": "string", - "description": "HubSpot - last activity date." - }, - "hs_lastcontacted": { - "title": "HubSpot last contacted", - "type": "string", - "description": "HubSpot - last contacted." - }, - "hs_lastmodifieddate": { - "title": "HubSpot last modified date", - "type": "string", - "description": "HubSpot - last modified date." - }, - "hs_nextactivitydate": { - "title": "HubSpot next activity date", - "type": "string", - "description": "HubSpot - next activity date." - }, - "hs_num_times_contacted": { - "title": "HubSpot number of times contacted", - "type": "string", - "description": "HubSpot - number of times contacted." - }, - "hubspot_owner_assigneddate": { - "title": "HubSpot owner assigned date", - "type": "string", - "description": "HubSpot - owner assigned date." - }, - "last_reply_date": { - "title": "Last reply date", - "type": "string", - "description": "Last reply date." - }, - "num_notes": { - "title": "Number of notes", - "type": "string", - "description": "The number of notes" - }, - "time_to_close": { - "title": "Time to close", - "type": "string", - "description": "Time to close." - }, - "time_to_first_agent_reply": { - "title": "Time to first agent reply", - "type": "string", - "description": "Time to first agent reply." - }, - "content": { - "title": "Content", - "type": "string", - "description": "Content." - }, - "hs_file_upload": { - "title": "HubSpot file upload", - "type": "string", - "description": "HubSpot - file upload." - }, - "hs_num_associated_companies": { - "title": "HubSpot number of associated companies", - "type": "string", - "description": "HubSpot - number of associated companies." - }, - "hs_pipeline": { - "title": "HubSpot pipeline", - "type": "string", - "description": "HubSpot - pipeline" - }, - "hs_pipeline_stage": { - "title": "HubSpot pipeline stage", - "type": "string", - "description": "HubSpot - pipeline stage." - }, - "hs_resolution": { - "title": "HubSpot resolution", - "type": "string", - "description": "HubSpot - resolution" - }, - "hs_ticket_category": { - "title": "HubSpot ticket category", - "type": "string", - "description": "HubSpot - ticket category." - }, - "hs_ticket_id": { - "title": "HubSpot ticket ID", - "type": "string", - "description": "HubSpot - ticket ID." - }, - "hs_ticket_priority": { - "title": "HubSpot ticket priority", - "type": "string", - "description": "HubSpot - ticket priority." - }, - "hubspot_owner_id": { - "title": "HubSpot owner ID", - "type": "string", - "description": "HubSpot - owner ID." - }, - "hubspot_team_id": { - "title": "HubSpot team ID", - "type": "string", - "description": "HubSpot - team ID." - }, - "source_type": { - "title": "Source type", - "type": "string", - "description": "Source type." + "associationCategory": { + "type": "string" }, - "subject": { - "title": "Subject", - "type": "string", - "description": "Subject." + "associationTypeId": { + "type": "string" } } } } } } - ] + } + } + }, + "Associations": { + "type": "object", + "description": "Requested associations", + "x-ms-summary": "Associations", + "additionalProperties": { + "type": "object", + "properties": { + "results": { + "type": "array", + "items": { + "type": "object", + "properties": { + "id": { + "type": "string" + }, + "type": { + "type": "string" + } + } + } + }, + "paging": { + "$ref": "#/definitions/Paging" + } + } + } + }, + "Paging": { + "type": "object", + "properties": { + "next": { + "type": "object", + "properties": { + "after": { + "type": "string" + }, + "link": { + "type": "string" + } + } + }, + "prev": { + "type": "object", + "properties": { + "after": { + "type": "string" + }, + "link": { + "type": "string" + } + } + } + } + }, + "PropertiesWithHistory": { + "type": "object", + "description": "Requested properties with history", + "x-ms-summary": "Properties with History", + "additionalProperties": { + "type": "array", + "items": { + "type": "object", + "properties": { + "value": { + "type": "string" + }, + "timestamp": { + "type": "string" + }, + "sourceType": { + "type": "string" + }, + "sourceId": { + "type": "string" + } + } + } + } + } + }, + "parameters": { + "After": { + "name": "after", + "in": "query", + "required": false, + "type": "string", + "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.", + "x-ms-summary": "Number of records fitting query to skip.", + "x-ms-url-encoding": "single", + "x-ms-visibility": "advanced" + }, + "Archived": { + "name": "archived", + "in": "query", + "required": false, + "type": "boolean", + "description": "Whether to return only results that have been archived. (false if blank)", + "x-ms-summary": "Return only results that have been archived. (false if blank)", + "x-ms-url-encoding": "single", + "x-ms-visibility": "advanced" + }, + "ReturnAssociations": { + "name": "associations", + "in": "query", + "required": false, + "type": "string", + "description": "A comma separated list of object types to retrieve associated IDs for. If any of the specified associations do not exist, they will be ignored.", + "x-ms-summary": "List of object types to retrieve associated IDs for.", + "x-ms-url-encoding": "single", + "x-ms-visibility": "advanced" + }, + "Limit": { + "name": "limit", + "in": "query", + "required": false, + "type": "integer", + "description": "The maximum number of results to display per page. (10 if blank)", + "x-ms-summary": "Results to display per page. (10 if blank)", + "x-ms-url-encoding": "single", + "x-ms-visibility": "important" + }, + "ReturnProperties": { + "name": "properties", + "in": "query", + "required": false, + "type": "string", + "description": "A comma separated list of the properties to be returned in the response. If any of the specified properties are not present on the requested object(s), they will be ignored.", + "x-ms-summary": "List of properties to be returned.", + "x-ms-url-encoding": "single", + "x-ms-visibility": "important" + }, + "ReturnPropertiesWithHistory": { + "name": "propertiesWithHistory", + "in": "query", + "required": false, + "type": "string", + "description": "A comma separated list of the properties to be returned along with their history of previous values. If any of the specified properties are not present on the requested object(s), they will be ignored. Usage of this parameter will reduce the maximum number of objects that can be read by a single request.", + "x-ms-summary": "List of properties to be returned with their value history.", + "x-ms-url-encoding": "single", + "x-ms-visibility": "important" + }, + "IDProperty": { + "name": "idProperty", + "in": "query", + "required": false, + "type": "string", + "description": "Property that will be used to uniquely identify the object", + "x-ms-summary": "Property to compare with path ID, default is the object ID", + "x-ms-url-encoding": "single", + "x-ms-visibility": "advanced" + }, + "CompanyID": { + "name": "companyId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the company record", + "x-ms-summary": "The ID of the company record", + "x-ms-url-encoding": "single", + "x-ms-visibility": "important" + }, + "ContactID": { + "name": "contactId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the contact record", + "x-ms-summary": "The ID of the contact record", + "x-ms-url-encoding": "single" + }, + "DealID": { + "name": "dealId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the deal record", + "x-ms-summary": "The ID of the deal record", + "x-ms-url-encoding": "single" + }, + "ProductID": { + "name": "productId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the product record", + "x-ms-summary": "The ID of the product record", + "x-ms-url-encoding": "single" + }, + "LineItemID": { + "name": "lineItemId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the line item record", + "x-ms-summary": "The ID of the line item record", + "x-ms-url-encoding": "single" + }, + "TicketID": { + "name": "ticketId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the ticket record", + "x-ms-summary": "The ID of the ticket record", + "x-ms-url-encoding": "single" + }, + "MeetingID": { + "name": "meetingId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the meeting record", + "x-ms-summary": "The ID of the meeting record", + "x-ms-url-encoding": "single" + }, + "OwnerID": { + "name": "ownerId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the owner record", + "x-ms-summary": "The ID of the owner record", + "x-ms-url-encoding": "single" + }, + "ObjectID": { + "name": "objectId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the object record", + "x-ms-summary": "The ID of the object record", + "x-ms-url-encoding": "single" + }, + "ToObjectID": { + "name": "toObjectId", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the targeted object record", + "x-ms-summary": "The ID of the targeted object record", + "x-ms-url-encoding": "single" + }, + "ObjectType": { + "name": "objectType", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the object type", + "x-ms-summary": "The ID of the object type", + "x-ms-url-encoding": "single" + }, + "ToObjectType": { + "name": "toObjectType", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the targeted object type", + "x-ms-summary": "The ID of the targeted object type", + "x-ms-url-encoding": "single" + }, + "AssociationType": { + "name": "associationType", + "in": "path", + "required": true, + "type": "string", + "x-ms-visibility": "important", + "description": "The ID of the association type", + "x-ms-summary": "The ID of the association type", + "x-ms-url-encoding": "single" + }, + "CompanyEntry": { + "name": "company", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CompanyProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "ContactEntry": { + "name": "contact", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ContactProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "DealEntry": { + "name": "deal", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/DealProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "ProductEntry": { + "name": "product", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ProductProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "LineItemEntry": { + "name": "line item", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/LineItemProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "TicketEntry": { + "name": "ticket", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/TicketProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "MeetingEntry": { + "name": "meeting", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/MeetingProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "ObjectEntry": { + "name": "custom object", + "in": "body", + "required": true, + "schema": { + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ObjectProperties" + }, + "associations": { + "$ref": "#/definitions/AssociationsCreate" + } + } + } + }, + "Search": { + "name": "search", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Search" + } + } + }, + "responses": { + "MigrationInProgress": { + "description": "Migration in Progress", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "ServiceTemporarilyUnavailable": { + "description": "Service temporarily unavailable", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "WebServerDown": { + "description": "Web server is down", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "ConnectionTimedOut": { + "description": "Connection timed out", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "OriginUnreachable": { + "description": "Origin is unreachable", + "schema": { + "$ref": "#/definitions/ErrorModel" + } + }, + "SSLIssues": { + "description": "SSL issues", + "schema": { + "$ref": "#/definitions/ErrorModel" } } }, - "definitions": {}, - "parameters": {}, - "responses": {}, "tags": [], "x-ms-connector-metadata": [ - { - "propertyName": "Website", - "propertyValue": "https://www.hubspot.com/" - }, - { - "propertyName": "Privacy policy", - "propertyValue": "https://legal.hubspot.com/privacy-policy" - }, - { - "propertyName": "Categories", - "propertyValue": "Marketing" - } - ] + { + "propertyName": "Website", + "propertyValue": "https://www.hubspot.com/" + }, + { + "propertyName": "Privacy policy", + "propertyValue": "https://legal.hubspot.com/privacy-policy" + }, + { + "propertyName": "Categories", + "propertyValue": "Marketing" + } + ] }