{"openapi":"3.1.0","info":{"title":"HubSpot Gym API","description":"A HubSpot-like API implementation with MCP support","version":"1.0.0"},"paths":{"/mcp":{"post":{"tags":["MCP"],"summary":"Handle Mcp","description":"Handle MCP (Model Context Protocol) protocol messages.\n\nThis endpoint accepts JSON-RPC 2.0 formatted requests and supports the following methods:\n- `initialize`: Initialize the MCP connection\n- `tools/list`: List all available tools\n- `tools/call`: Execute a specific tool\n- `resources/list`: List available resources\n- `resources/read`: Read a specific resource\n\n**Request Format:**\nThe endpoint expects a JSON body following JSON-RPC 2.0 specification:\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"method\": \"tools/call\",\n    \"params\": {\n        \"name\": \"tool_name\",\n        \"arguments\": {}\n    },\n    \"id\": 1\n}\n```\n\n**Headers:**\n- `Authorization` (optional): Bearer token for authentication. If not provided, defaults to \"Bearer auth_bypass\"\n- `x-database-id` (required in production, optional in development): Database identifier for multi-tenant support. Required in production mode. In development, defaults to \"default\" if not provided.\n- `Content-Type`: application/json\n\n**Base URL:**\nThe endpoint URL format is `{BASE_URL}/mcp` where `{BASE_URL}` depends on your deployment:\n- Local development: `http://localhost:8013`\n- Production: `http://rl-gym-mcp-dev-internal-hubspot.development.svc.cluster.local`\n\n**Example 1: Initialize MCP Connection**\n\n**Postman Setup:**\n- Method: POST\n- URL: {BASE_URL}/mcp (e.g., http://localhost:8013/mcp)\n- Headers:\n  - Content-Type: application/json\n- Body (raw JSON):\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"method\": \"initialize\",\n    \"params\": {},\n    \"id\": 1\n}\n```\n\n**Example 2: List Available Tools**\n\n**Postman Setup:**\n- Method: POST\n- URL: {BASE_URL}/mcp (e.g., http://localhost:8013/mcp)\n- Headers:\n  - Content-Type: application/json\n  - Authorization: Bearer your_token_here\n  - x-database-id: hubspot_gym_default\n- Body (raw JSON):\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"method\": \"tools/list\",\n    \"params\": {},\n    \"id\": 1\n}\n```\n\n**Example 3: Create a Contact (Tool Call with Authorization)**\n\n**Postman Setup:**\n- Method: POST\n- URL: {BASE_URL}/mcp (e.g., http://localhost:8013/mcp)\n- Headers:\n  - Content-Type: application/json\n  - Authorization: Bearer your_access_token\n  - x-database-id: hubspot_gym_default\n- Body (raw JSON):\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"method\": \"tools/call\",\n    \"params\": {\n        \"name\": \"create_contact\",\n        \"arguments\": {\n            \"properties\": {\n                \"email\": \"john.doe@example.com\",\n                \"firstname\": \"John\",\n                \"lastname\": \"Doe\",\n                \"phone\": \"+1-555-123-4567\",\n                \"lifecyclestage\": \"lead\"\n            }\n        }\n    },\n    \"id\": 1\n}\n```\n\n**Example 4: List Contacts**\n\n**Postman Setup:**\n- Method: POST\n- URL: {BASE_URL}/mcp (e.g., http://localhost:8013/mcp)\n- Headers:\n  - Content-Type: application/json\n  - Authorization: Bearer your_access_token\n  - x-database-id: hubspot_gym_default\n- Body (raw JSON):\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"method\": \"tools/call\",\n    \"params\": {\n        \"name\": \"retrieve_contacts\",\n        \"arguments\": {\n            \"limit\": 10,\n            \"properties\": [\"email\", \"firstname\", \"lastname\"]\n        }\n    },\n    \"id\": 1\n}\n```\n\n**Response Format:**\nSuccessful responses follow JSON-RPC 2.0 format:\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"id\": 1,\n    \"result\": {\n        \"success\": true,\n        \"status_code\": 200,\n        \"data\": {}\n    }\n}\n```\n\nFor HTTP 422 validation errors, `result` uses structured errors (one object per issue):\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"id\": 1,\n    \"result\": {\n        \"success\": false,\n        \"status_code\": 422,\n        \"status\": \"error\",\n        \"message\": \"One or more properties have a value that does not match the expected type.\",\n        \"category\": \"VALIDATION_ERROR\",\n        \"correlationId\": \"a43683b0-5717-4ceb-80b4-104d02915d8c\",\n        \"errors\": [\n            {\n                \"message\": \"'email' must be a string, not a number\",\n                \"code\": \"INVALID_STRING\",\n                \"context\": { \"propertyName\": [\"email\"] }\n            }\n        ]\n    }\n}\n```\nOther HTTP errors (403, 404, 409, …) still return `success`, `status_code`, and `error.detail`.\n\nJSON-RPC protocol errors:\n```json\n{\n    \"jsonrpc\": \"2.0\",\n    \"id\": 1,\n    \"error\": {\n        \"code\": -32601,\n        \"message\": \"Method not found\"\n    }\n}\n```\n\n**Note on Notifications:**\nAccording to JSON-RPC 2.0 specification, a \"notification\" is a request without an `id` field\n(meaning the client doesn't expect a response). While the code has defensive handling for this\ncase (returns HTTP 204 No Content), in practice all requests should include an `id` field to receive\na proper response. For QA testing purposes, always include an `id` in your requests.","operationId":"handle_mcp_mcp_post","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MCPRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/sample-data":{"get":{"tags":["Database"],"summary":"Get Sample Data","description":"Get comprehensive seed SQL data for download/inspection","operationId":"get_sample_data_api_sample_data_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/export-sql":{"get":{"tags":["Database"],"summary":"Export Sql","description":"Export comprehensive seed SQL file as plain text","operationId":"export_sql_api_export_sql_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/seed-database":{"post":{"tags":["Database"],"summary":"Seed Database","description":"Seed database with comprehensive_seed.sql data","operationId":"seed_database_api_seed_database_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/reset-database":{"post":{"tags":["Database"],"summary":"Reset Database","description":"Reset a database to its original seeded state.","operationId":"reset_database_api_reset_database_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/clone-database":{"post":{"tags":["Database"],"summary":"Clone Database","description":"Clone database by creating database from seed data.","operationId":"clone_database_api_clone_database_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/delete-database":{"delete":{"tags":["Database"],"summary":"Delete Database","description":"Delete a cloned database and its associated seed data.","operationId":"delete_database_api_delete_database_delete","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/database-state":{"get":{"tags":["Database"],"summary":"Get Database State","description":"Get current database state and all data for frontend tabular display","operationId":"get_database_state_api_database_state_get","parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"type":"string","default":"default","title":"X-Database-Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/schema":{"get":{"tags":["Database"],"summary":"Get Database Schema","description":"Get database schema information from SQLAlchemy models","operationId":"get_database_schema_api_schema_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/download-db-file":{"get":{"tags":["Database"],"summary":"Download Database File","description":"Download the actual SQLite database file (.db)","operationId":"download_database_file_api_download_db_file_get","parameters":[{"name":"x-database-id","in":"header","required":true,"schema":{"type":"string","description":"Database ID for multi-tenant support (required)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (required)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/sql-runner":{"post":{"tags":["Database"],"summary":"Execute Custom Query","description":"Execute a custom SQL query with limit","operationId":"execute_custom_query_api_sql_runner_post","parameters":[{"name":"x-database-id","in":"header","required":true,"schema":{"type":"string","description":"Database ID for multi-tenant support (required)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (required)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SQLQueryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Execute Custom Query Api Sql Runner Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/user-info":{"get":{"tags":["Database"],"summary":"Get User Info","description":"Get user information from the authenticated token.\n\nReturns user information based on the authentication token.\nThe token is validated and the corresponding user is retrieved from the database.\n\nReturns:\n    Dict: User information with user_id, name, and email.","operationId":"get_user_info_api_user_info_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/oauth/v1/token":{"post":{"tags":["OAuth"],"summary":"Get Access Token","description":"Get OAuth access token\n\nThis endpoint handles OAuth token requests:\n- For authorization code flow: grant_type=authorization_code\n- For token refresh: grant_type=refresh_token\n- For client credentials: grant_type=client_credentials\n\n**Request Body:**\n- grant_type: Must be \"authorization_code\", \"refresh_token\", or \"client_credentials\"\n- For authorization code: code, redirect_uri, client_id, client_secret (code_verifier, scope optional)\n- For refresh: refresh_token, client_id, client_secret (scope optional)\n- For client credentials: client_id, client_secret (scope optional)\n\n**Returns:**\n- Access token with expiration time and refresh token","operationId":"get_access_token_oauth_v1_token_post","parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/Body_get_access_token_oauth_v1_token_post"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TokenResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/oauth/v1/access-tokens/{token}":{"get":{"tags":["OAuth"],"summary":"Get Token Metadata","description":"Get OAuth access token metadata\n\n**Parameters:**\n- token: Access token to get metadata for\n\n**Returns:**\n- Token metadata including scopes, expiry, user details","operationId":"get_token_metadata_oauth_v1_access_tokens__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccessTokenMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/oauth/v1/refresh-tokens/{token}":{"get":{"tags":["OAuth"],"summary":"Get Refresh Token Metadata","description":"Retrieve refresh token metadata\n\n**Parameters:**\n- token: Refresh token to get metadata for\n\n**Returns:**\n- Refresh token metadata including scopes, hub, user details","operationId":"get_refresh_token_metadata_oauth_v1_refresh_tokens__token__get","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RefreshTokenMetadataResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["OAuth"],"summary":"Delete Refresh Token","description":"Delete (revoke) a refresh token\n\n**Parameters:**\n- token: Refresh token to revoke\n\n**Returns:**\n- Success response","operationId":"delete_refresh_token_oauth_v1_refresh_tokens__token__delete","parameters":[{"name":"token","in":"path","required":true,"schema":{"type":"string","title":"Token"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/products":{"get":{"tags":["Products"],"summary":"List Products","description":"List products with pagination support\n\nThis endpoint follows the HubSpot CRM Products v3 API specification:\n- Supports pagination with cursor-based approach (after/before)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"list_products_crm_v3_objects_products_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Products"],"summary":"Create Product","description":"Create a product with the given properties and return a copy of the object, including the ID.\n\nThis endpoint follows the HubSpot CRM Products v3 API specification:\n- Accepts properties and optional associations\n- Returns created product object directly (no wrapper)\n- Requires write scope for products","operationId":"create_product_crm_v3_objects_products_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateProductResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/products/{productId}":{"get":{"tags":["Products"],"summary":"Get Product","description":"Get a single product by ID\n\nThis endpoint follows the HubSpot CRM Products v3 API specification:\n- Supports property filtering\n- Supports custom ID property lookup via idProperty param\n- Returns single product in HubSpot format","operationId":"get_product_crm_v3_objects_products__productId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","title":"Productid"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ProductResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Products"],"summary":"Archive Product","description":"Archive a product\n\nThis endpoint follows the HubSpot CRM Products v3 API specification:\n- Returns confirmation message on success\n- Moves product to recycling bin (archived = true)\n- Only accepts productId as path parameter","operationId":"archive_product_crm_v3_objects_products__productId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","title":"Productid"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveProductResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Products"],"summary":"Update Product","description":"Update a product with partial property updates\n\nThis endpoint follows the HubSpot CRM Products v3 API specification:\n- Supports partial updates via PATCH method\n- Properties provided will be overwritten\n- Empty string values clear properties\n- Read-only properties cannot be modified\n- Supports lookup by unique property via idProperty query param","operationId":"update_product_crm_v3_objects_products__productId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"productId","in":"path","required":true,"schema":{"type":"string","title":"Productid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateProductRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/leads":{"get":{"tags":["Leads"],"summary":"List Leads","description":"Read a page of leads matching HubSpot CRM leads API contract.\n\nSupports:\n- Cursor-based pagination via `limit` and `after`\n- Filtering on archived status\n- Property and association selection mirroring HubSpot parameters","operationId":"list_leads_crm_v3_objects_leads_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Leads"],"summary":"Create Lead","description":"Create a lead with the given properties and associations.","operationId":"create_lead_crm_v3_objects_leads_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLeadRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/leads/{leadsId}":{"get":{"tags":["Leads"],"summary":"Read Lead","description":"Read a single lead matching HubSpot CRM leads API contract.","operationId":"read_lead_crm_v3_objects_leads__leadsId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"leadsId","in":"path","required":true,"schema":{"type":"string","description":"Lead ID","title":"Leadsid"},"description":"Lead ID"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Leads"],"summary":"Archive Lead","description":"Archive a lead (moves to recycling bin).","operationId":"archive_lead_crm_v3_objects_leads__leadsId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"leadsId","in":"path","required":true,"schema":{"type":"string","description":"Lead ID","title":"Leadsid"},"description":"Lead ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveLeadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Leads"],"summary":"Update Lead","description":"Update a lead with partial property updates.","operationId":"update_lead_crm_v3_objects_leads__leadsId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"leadsId","in":"path","required":true,"schema":{"type":"string","description":"Lead ID","title":"Leadsid"},"description":"Lead ID"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLeadRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LeadResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/deals":{"post":{"tags":["Deals"],"summary":"Create Deal","description":"Create a deal with the given properties and return a copy of the object, including the ID.\n\nDocumentation and examples for creating standard deals is provided.","operationId":"create_deal_crm_v3_objects_deals_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDealRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DealResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Deals"],"summary":"List Deals","description":"Retrieve all deals with pagination and filtering.\nRequires crm.objects.deals.read scope.","operationId":"list_deals_crm_v3_objects_deals_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListDealsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/deals/{dealId}":{"get":{"tags":["Deals"],"summary":"Read Deal","description":"Read an Object identified by {dealId}. {dealId} refers to the internal object ID by default,\nor optionally any unique property value as specified by the idProperty query param.\nControl what is returned via the properties query param.\nRequires crm.objects.deals.read scope.","operationId":"read_deal_crm_v3_objects_deals__dealId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"dealId","in":"path","required":true,"schema":{"type":"string","title":"Dealid"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReadDealResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Deals"],"summary":"Update Deal","description":"Perform a partial update of an Object identified by {dealId} or optionally a unique property value\nas specified by the idProperty query param. {dealId} refers to the internal object ID by default,\nand the idProperty query param refers to a property whose values are unique for the object.\nProvided property values will be overwritten. Read-only and non-existent properties will result in an error.\nProperties values can be cleared by passing an empty string.\nRequires crm.objects.deals.write scope.","operationId":"update_deal_crm_v3_objects_deals__dealId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"dealId","in":"path","required":true,"schema":{"type":"string","title":"Dealid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDealRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateDealResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Deals"],"summary":"Archive Deal","description":"Archive an Object identified by {dealId} (moves to recycling bin).\nRequires crm.objects.deals.write scope.","operationId":"archive_deal_crm_v3_objects_deals__dealId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"dealId","in":"path","required":true,"schema":{"type":"string","title":"Dealid"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/orders":{"get":{"tags":["Orders"],"summary":"List Orders","description":"Read a page of orders matching HubSpot CRM orders API contract.\n\nSupports:\n- Cursor-based pagination via `limit` and `after`\n- Filtering on archived status\n- Property and association selection mirroring HubSpot parameters","operationId":"list_orders_crm_v3_objects_orders_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Orders"],"summary":"Create Order","description":"Create an order with the given properties and associations.","operationId":"create_order_crm_v3_objects_orders_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrderRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWriteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/orders/{orderId}":{"get":{"tags":["Orders"],"summary":"Read Order","description":"Read a single order matching HubSpot CRM orders API contract.","operationId":"read_order_crm_v3_objects_orders__orderId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","description":"Order ID","title":"Orderid"},"description":"Order ID"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Orders"],"summary":"Update Order","description":"Update an order with partial property updates.","operationId":"update_order_crm_v3_objects_orders__orderId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","description":"Order ID","title":"Orderid"},"description":"Order ID"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateOrderRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/OrderWriteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Orders"],"summary":"Archive Order","description":"Archive an order (moves to recycling bin).","operationId":"archive_order_crm_v3_objects_orders__orderId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"orderId","in":"path","required":true,"schema":{"type":"string","description":"Order ID","title":"Orderid"},"description":"Order ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/goal_targets":{"get":{"tags":["Goals"],"summary":"List Goals","description":"Read a page of goal targets matching HubSpot CRM goals API contract.\n\nSupports:\n- Cursor-based pagination via `limit` and `after`\n- Filtering on archived status\n- Property and association selection mirroring HubSpot parameters","operationId":"list_goals_crm_v3_objects_goal_targets_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Goals"],"summary":"Create Goal","description":"Create a goal target with the given properties and return a copy of the object, including the ID.\n\nDocumentation and examples for creating standard goal targets is provided.","operationId":"create_goal_crm_v3_objects_goal_targets_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGoalTargetRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateGoalTargetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/goal_targets/{goalTargetId}":{"get":{"tags":["Goals"],"summary":"Read Goal","description":"Read an Object identified by {goalTargetId}.\n\n{goalTargetId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param.\nControl what is returned via the properties query param.","operationId":"read_goal_crm_v3_objects_goal_targets__goalTargetId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"goalTargetId","in":"path","required":true,"schema":{"type":"string","description":"Goal Target ID","title":"Goaltargetid"},"description":"Goal Target ID"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Goals"],"summary":"Update Goal","description":"Update a goal target with partial property updates.","operationId":"update_goal_crm_v3_objects_goal_targets__goalTargetId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"goalTargetId","in":"path","required":true,"schema":{"type":"string","description":"Goal Target ID","title":"Goaltargetid"},"description":"Goal Target ID"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateGoalRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GoalResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Goals"],"summary":"Archive Goal","description":"Archive a goal target (moves to recycling bin).","operationId":"archive_goal_crm_v3_objects_goal_targets__goalTargetId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"goalTargetId","in":"path","required":true,"schema":{"type":"string","description":"Goal Target ID","title":"Goaltargetid"},"description":"Goal Target ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/line_items":{"get":{"tags":["Line Items"],"summary":"List Line Items","description":"List line items with pagination support. Mirrors HubSpot CRM Line Items v3.","operationId":"list_line_items_crm_v3_objects_line_items_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties","title":"Properties"},"description":"Comma separated properties"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties with history","title":"Propertieswithhistory"},"description":"Comma separated properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated associations","title":"Associations"},"description":"Comma separated associations"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Line Items"],"summary":"Create Line Item","description":"Create a line item with the given properties and return the created entity.","operationId":"create_line_item_crm_v3_objects_line_items_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLineItemRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLineItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/line_items/{lineItemId}":{"delete":{"tags":["Line Items"],"summary":"Archive Line Item","description":"Archive a line item. Returns 204 No Content on success.","operationId":"archive_line_item_crm_v3_objects_line_items__lineItemId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"lineItemId","in":"path","required":true,"schema":{"type":"string","title":"Lineitemid"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Line Items"],"summary":"Get Line Item","description":"Read a line item by ID or unique property. Aligns with HubSpot spec.","operationId":"get_line_item_crm_v3_objects_line_items__lineItemId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"lineItemId","in":"path","required":true,"schema":{"type":"string","title":"Lineitemid"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties","title":"Properties"},"description":"Comma separated properties"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties with history","title":"Propertieswithhistory"},"description":"Comma separated properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated associations","title":"Associations"},"description":"Comma separated associations"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Unique property name for lookup","title":"Idproperty"},"description":"Unique property name for lookup"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LineItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Line Items"],"summary":"Update Line Item","description":"Update a line item with partial property updates.\n\n- Supports partial updates via PATCH method\n- Properties provided will be overwritten\n- Empty string values clear properties\n- Read-only properties cannot be modified\n- Supports lookup by unique property via idProperty query param","operationId":"update_line_item_crm_v3_objects_line_items__lineItemId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"lineItemId","in":"path","required":true,"schema":{"type":"string","title":"Lineitemid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/UpdateLineItemRequest"},{"type":"null"}],"title":"Payload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLineItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts":{"get":{"tags":["CMS Posts"],"summary":"Get All Blog Posts","description":"Get all CMS blog posts with pagination support\n\nThis endpoint follows the HubSpot CMS Posts v3 API specification:\n- Supports pagination with cursor-based approach (after)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"get_all_blog_posts_cms_v3_blogs_posts_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"description":"The maximum number of results to return. Default is 20.","default":20,"title":"Limit"},"description":"The maximum number of results to return. Default is 20."},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.","title":"After"},"description":"The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results."},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Specifies whether to return deleted blog posts. Defaults to false.","default":false,"title":"Archived"},"description":"Specifies whether to return deleted blog posts. Defaults to false."},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Specifies which fields to use for sorting results. Valid fields are createdAt (default), name, updatedAt, createdBy, updatedBy. Can be a single field or array of fields.","default":["createdAt"],"title":"Sort"},"description":"Specifies which fields to use for sorting results. Valid fields are createdAt (default), name, updatedAt, createdBy, updatedBy. Can be a single field or array of fields."},{"name":"createdAt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return blog posts created at exactly the specified time","title":"Createdat"},"description":"Only return blog posts created at exactly the specified time"},{"name":"createdAfter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return blog posts created after the specified time","title":"Createdafter"},"description":"Only return blog posts created after the specified time"},{"name":"createdBefore","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return blog posts created before the specified time","title":"Createdbefore"},"description":"Only return blog posts created before the specified time"},{"name":"updatedAt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return blog posts last updated at exactly the specified time","title":"Updatedat"},"description":"Only return blog posts last updated at exactly the specified time"},{"name":"updatedAfter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return blog posts last updated after the specified time","title":"Updatedafter"},"description":"Only return blog posts last updated after the specified time"},{"name":"updatedBefore","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return blog posts last updated before the specified time","title":"Updatedbefore"},"description":"Only return blog posts last updated before the specified time"},{"name":"property","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by specific property name","title":"Property"},"description":"Filter by specific property name"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmsPostListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["CMS Posts"],"summary":"Create Cms Post","description":"Create a new CMS blog post\n\nThis endpoint creates a new blog post according to HubSpot API v3 specification.\nAll fields are at the top level per the API documentation.\n\nReturns:\n    - 201 Created: Post created successfully with full post object\n    - 400 Bad Request: Invalid request data or validation errors\n    - 401 Unauthorized: Authentication failure (handled by auth middleware)\n    - 403 Forbidden: Insufficient permissions\n    - 404 Not Found: Referenced blog (contentGroupId) not found\n    - 422 Unprocessable Entity: Validation errors (Pydantic)\n    - 500 Internal Server Error: Server error","operationId":"create_cms_post_cms_v3_blogs_posts_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCmsPostRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}":{"get":{"tags":["CMS Posts"],"summary":"Get Cms Post","description":"Retrieve a blog post by the post ID\n\nThis endpoint follows the HubSpot CMS Posts v3 API specification:\n- Returns a single blog post with all its properties\n- Supports archived parameter to return deleted blog posts\n- Supports property parameter to return specific properties only\n- Requires 'content' scope","operationId":"get_cms_post_cms_v3_blogs_posts__objectId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Specifies whether to return deleted blog posts. Defaults to false.","default":false,"title":"Archived"},"description":"Specifies whether to return deleted blog posts. Defaults to false."},{"name":"property","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Specific properties to return.","title":"Property"},"description":"Specific properties to return."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CMS Posts"],"summary":"Update Blog Post","description":"Update a blog post\n\nThis endpoint partially updates an existing blog post with the provided properties.\nAll fields are at the top level per HubSpot API v3 specification.\nFastAPI/Pydantic automatically validates the request body.","operationId":"update_blog_post_cms_v3_blogs_posts__objectId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCmsPostRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["CMS Posts"],"summary":"Delete Cms Post","description":"Delete a blog post by ID.\n\nDelete a blog post by ID. This archives the post (soft delete).\nReturns 204 No Content with no response body.","operationId":"delete_cms_post_cms_v3_blogs_posts__objectId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether to return only results that have been deleted","title":"Archived"},"description":"Whether to return only results that have been deleted"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/clone":{"post":{"tags":["CMS Posts"],"summary":"Clone Cms Post","description":"Clone a CMS blog post\n\nThis endpoint creates a copy of an existing blog post with a new name.","operationId":"clone_cms_post_cms_v3_blogs_posts_clone_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CloneCmsPostRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}/draft":{"get":{"tags":["CMS Posts"],"summary":"Get Cms Post Draft","description":"Get draft version of a CMS blog post\n\nThis endpoint retrieves the draft version of a blog post.","operationId":"get_cms_post_draft_cms_v3_blogs_posts__objectId__draft_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The ID of the blog post to retrieve the draft for","title":"Objectid"},"description":"The ID of the blog post to retrieve the draft for"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CMS Posts"],"summary":"Update Cms Post Draft","description":"Update draft version of a CMS blog post\n\nThis endpoint updates the draft version of a blog post.","operationId":"update_cms_post_draft_cms_v3_blogs_posts__objectId__draft_patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The ID of the blog post to update the draft for","title":"Objectid"},"description":"The ID of the blog post to update the draft for"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCmsPostRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}/draft/push-live":{"post":{"tags":["CMS Posts"],"summary":"Push Draft Live","description":"Push draft to live (publish draft)\n\nThis endpoint publishes the draft version of a blog post.","operationId":"push_draft_live_cms_v3_blogs_posts__objectId__draft_push_live_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The ID of the blog post draft to publish","title":"Objectid"},"description":"The ID of the blog post draft to publish"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}/draft/reset":{"post":{"tags":["CMS Posts"],"summary":"Reset Draft","description":"Reset draft to match live version\n\nThis endpoint resets the draft to match the current live version.","operationId":"reset_draft_cms_v3_blogs_posts__objectId__draft_reset_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/schedule":{"post":{"tags":["CMS Posts"],"summary":"Schedule Cms Post","description":"Schedule a CMS blog post for publishing\n\nThis endpoint schedules a blog post to be published at a specific time.\nReturns 204 No Content as per HubSpot API specification.","operationId":"schedule_cms_post_cms_v3_blogs_posts_schedule_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ScheduleCmsPostRequest"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}/revisions":{"get":{"tags":["CMS Posts"],"summary":"List Cms Post Revisions","description":"List revisions for a CMS blog post\n\nThis endpoint retrieves the revision history of a blog post.","operationId":"list_cms_post_revisions_cms_v3_blogs_posts__objectId__revisions_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","maximum":100,"minimum":1},{"type":"null"}],"description":"Number of results to return","default":100,"title":"Limit"},"description":"Number of results to return"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor for next page","title":"After"},"description":"Paging cursor for next page"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor for previous page","title":"Before"},"description":"Paging cursor for previous page"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmsPostRevisionListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}":{"get":{"tags":["CMS Posts"],"summary":"Get Cms Post Revision","description":"Get a specific revision of a CMS blog post\n\nThis endpoint retrieves a specific revision from the post's history.","operationId":"get_cms_post_revision_cms_v3_blogs_posts__objectId__revisions__revisionId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"revisionId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the revision","title":"Revisionid"},"description":"The ID of the revision"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CmsPostRevisionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore":{"post":{"tags":["CMS Posts"],"summary":"Restore Revision","description":"Restore a revision to live post\n\nThis endpoint restores a specific revision to the live version of the post.","operationId":"restore_revision_cms_v3_blogs_posts__objectId__revisions__revisionId__restore_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"revisionId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the revision","title":"Revisionid"},"description":"The ID of the revision"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreRevisionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/{objectId}/revisions/{revisionId}/restore-to-draft":{"post":{"tags":["CMS Posts"],"summary":"Restore Revision To Draft","description":"Restore a revision to draft\n\nThis endpoint restores a specific revision to the draft version of the post.","operationId":"restore_revision_to_draft_cms_v3_blogs_posts__objectId__revisions__revisionId__restore_to_draft_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Objectid"},"description":"The ID of the blog post"},{"name":"revisionId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the revision","title":"Revisionid"},"description":"The ID of the revision"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RestoreRevisionRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCmsPostResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/batch/read":{"post":{"tags":["CMS Posts"],"summary":"Batch Read Cms Posts","description":"Batch read CMS posts\n\nThis endpoint reads multiple CMS posts in a single request.","operationId":"batch_read_cms_posts_cms_v3_blogs_posts_batch_read_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadCmsPostsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadCmsPostsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/batch/create":{"post":{"tags":["CMS Posts"],"summary":"Batch Create Cms Posts","description":"Batch create CMS posts\n\nThis endpoint creates multiple CMS posts in a single request.","operationId":"batch_create_cms_posts_cms_v3_blogs_posts_batch_create_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateCmsPostsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateCmsPostsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/batch/update":{"post":{"tags":["CMS Posts"],"summary":"Batch Update Cms Posts","description":"Batch update CMS posts\n\nThis endpoint updates multiple CMS posts in a single request.","operationId":"batch_update_cms_posts_cms_v3_blogs_posts_batch_update_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateCmsPostsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateCmsPostsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/batch/archive":{"post":{"tags":["CMS Posts"],"summary":"Batch Archive Cms Posts","description":"Batch archive CMS posts\n\nThis endpoint archives multiple CMS posts in a single request.","operationId":"batch_archive_cms_posts_cms_v3_blogs_posts_batch_archive_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchArchiveCmsPostsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchArchiveCmsPostsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/multi-language/create-language-variation":{"post":{"tags":["CMS Posts"],"summary":"Create Language Variation","description":"Create a language variation for a CMS post\n\nThis endpoint creates a language variation of an existing CMS post.","operationId":"create_language_variation_cms_v3_blogs_posts_multi_language_create_language_variation_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"postId","in":"query","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Postid"},"description":"The ID of the blog post"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateLanguageVariationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiLanguageOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/multi-language/attach-to-lang-group":{"post":{"tags":["CMS Posts"],"summary":"Attach To Lang Group","description":"Attach a CMS post to a language group\n\nThis endpoint attaches a CMS post to a language group.","operationId":"attach_to_lang_group_cms_v3_blogs_posts_multi_language_attach_to_lang_group_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"postId","in":"query","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Postid"},"description":"The ID of the blog post"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AttachToLangGroupRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiLanguageOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/multi-language/detach-from-lang-group":{"post":{"tags":["CMS Posts"],"summary":"Detach From Lang Group","description":"Detach a CMS post from a language group\n\nThis endpoint detaches a CMS post from a language group.","operationId":"detach_from_lang_group_cms_v3_blogs_posts_multi_language_detach_from_lang_group_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"postId","in":"query","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Postid"},"description":"The ID of the blog post"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DetachFromLangGroupRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiLanguageOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/multi-language/update-languages":{"post":{"tags":["CMS Posts"],"summary":"Update Languages","description":"Update languages for a CMS post\n\nThis endpoint updates the languages associated with a CMS post.","operationId":"update_languages_cms_v3_blogs_posts_multi_language_update_languages_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"postId","in":"query","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Postid"},"description":"The ID of the blog post"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateLanguagesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiLanguageOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/multi-language/set-new-lang-primary":{"put":{"tags":["CMS Posts"],"summary":"Set New Lang Primary","description":"Set a new primary language for a CMS post\n\nThis endpoint sets a new primary language for a CMS post.","operationId":"set_new_lang_primary_cms_v3_blogs_posts_multi_language_set_new_lang_primary_put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"postId","in":"query","required":true,"schema":{"type":"string","description":"The ID of the blog post","title":"Postid"},"description":"The ID of the blog post"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetNewLangPrimaryRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MultiLanguageOperationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/posts/multi-language/batch":{"post":{"tags":["CMS Posts"],"summary":"Batch Language Variations","description":"Batch process language variations\n\nThis endpoint processes multiple language variations in a single request.","operationId":"batch_language_variations_cms_v3_blogs_posts_multi_language_batch_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchLanguageVariationRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchLanguageVariationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/tags":{"get":{"tags":["CMS Tags"],"summary":"Get All Blog Tags","description":"Get all blog tags with pagination support\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Supports pagination with cursor-based approach (after/before)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"get_all_blog_tags_cms_v3_blogs_tags_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"The maximum number of results to return. Default is 100.","default":100,"title":"Limit"},"description":"The maximum number of results to return. Default is 100."},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"description":"The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results.","title":"After"},"description":"The cursor token value to get the next set of results. You can get this from the paging.next.after JSON property of a paged response containing more results."},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","description":"Specifies whether to return deleted Blog Tags. Defaults to false.","default":false,"title":"Archived"},"description":"Specifies whether to return deleted Blog Tags. Defaults to false."},{"name":"createdAfter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return Blog Tags created after the specified time","title":"Createdafter"},"description":"Only return Blog Tags created after the specified time"},{"name":"createdAt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return Blog Tags created at exactly the specified time","title":"Createdat"},"description":"Only return Blog Tags created at exactly the specified time"},{"name":"createdBefore","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return Blog Tags created before the specified time","title":"Createdbefore"},"description":"Only return Blog Tags created before the specified time"},{"name":"property","in":"query","required":false,"schema":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"description":"Filter by specific property name","title":"Property"},"description":"Filter by specific property name"},{"name":"sort","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"description":"Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default.","default":["createdAt"],"title":"Sort"},"description":"Specifies which fields to use for sorting results. Valid fields are name, createdAt, updatedAt, createdBy, updatedBy. createdAt will be used by default."},{"name":"updatedAfter","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return Blog Tags last updated after the specified time","title":"Updatedafter"},"description":"Only return Blog Tags last updated after the specified time"},{"name":"updatedAt","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return Blog Tags last updated at exactly the specified time","title":"Updatedat"},"description":"Only return Blog Tags last updated at exactly the specified time"},{"name":"updatedBefore","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"Only return Blog Tags last updated before the specified time","title":"Updatedbefore"},"description":"Only return Blog Tags last updated before the specified time"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogTagListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["CMS Tags"],"summary":"Create Blog Tag","description":"Create a blog tag with the given properties and return a copy of the object, including the ID.\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Accepts properties for the new tag\n- Returns the created tag\n- Requires content scope","operationId":"create_blog_tag_cms_v3_blogs_tags_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateBlogTagRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogTagResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/tags/{objectId}":{"get":{"tags":["CMS Tags"],"summary":"Retrieve Blog Tag","description":"Retrieve a Blog Tag by ID\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Supports property filtering via the `property` query parameter\n- Returns single tag in HubSpot format\n\nProperty Parameter Behavior:\nThe `property` query parameter accepts comma-separated property names (e.g., \"name,slug\").\nThe response will only include properties that match the provided names.\nIf a property name doesn't match any field in the response, it is skipped.\nExample: property=name,slug returns {\"name\":\"new tag\",\"slug\":\"new-tag\"}","operationId":"retrieve_blog_tag_cms_v3_blogs_tags__objectId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","title":"Objectid"}},{"name":"property","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property to return (query parameter)","title":"Property"},"description":"Property to return (query parameter)"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Specifies whether to return deleted Blog Tags. Defaults to false.","default":false,"title":"Archived"},"description":"Specifies whether to return deleted Blog Tags. Defaults to false."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogTagResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["CMS Tags"],"summary":"Delete Blog Tag","description":"Delete the Blog Tag object identified by the id in the path.\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Returns 204 No Content on success\n- Moves tag to recycling bin (archived = true)\n- Returns 409 if the tag has already been deleted and archived=false","operationId":"delete_blog_tag_cms_v3_blogs_tags__objectId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","title":"Objectid"}},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Whether to return only results that have been archived.","default":false,"title":"Archived"},"description":"Whether to return only results that have been archived."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CMS Tags"],"summary":"Update Blog Tag","description":"Update a blog tag with partial property updates\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Supports partial updates via PATCH method\n- Properties provided will be overwritten\n- Empty string values clear properties\n- Read-only properties cannot be modified","operationId":"update_blog_tag_cms_v3_blogs_tags__objectId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectId","in":"path","required":true,"schema":{"type":"string","title":"Objectid"}},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Specifies whether to update deleted Blog Tags. Defaults to false.","default":false,"title":"Archived"},"description":"Specifies whether to update deleted Blog Tags. Defaults to false."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateBlogTagRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BlogTagResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/tags/batch/read":{"post":{"tags":["CMS Tags"],"summary":"Batch Read Blog Tags","description":"Retrieve a batch of Blog Tags\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Reads multiple tags in a single request\n- Returns batch operation status and results\n- Supports archived parameter to include deleted tags","operationId":"batch_read_blog_tags_cms_v3_blogs_tags_batch_read_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Specifies whether to return deleted Blog Tags. Defaults to false.","default":false,"title":"Archived"},"description":"Specifies whether to return deleted Blog Tags. Defaults to false."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadBlogTagsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadBlogTagsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/tags/batch/create":{"post":{"tags":["CMS Tags"],"summary":"Batch Create Blog Tags","description":"Batch create blog tags\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Creates multiple tags in a single request\n- Returns batch operation status and created tags\n- Returns 201 if all succeed, 207 if any fail","operationId":"batch_create_blog_tags_cms_v3_blogs_tags_batch_create_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateBlogTagsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateBlogTagsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/cms/v3/blogs/tags/batch/update":{"post":{"tags":["CMS Tags"],"summary":"Batch Update Blog Tags","description":"Batch update blog tags\n\nThis endpoint follows the HubSpot CMS Tags v3 API specification:\n- Updates multiple tags in a single request\n- Returns batch operation status and updated tags\n- Supports archived parameter to update deleted tags\n- Returns 200 if all succeed, 207 if any fail","operationId":"batch_update_blog_tags_cms_v3_blogs_tags_batch_update_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Specifies whether to update deleted Blog Tags. Defaults to false.","default":false,"title":"Archived"},"description":"Specifies whether to update deleted Blog Tags. Defaults to false."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateBlogTagsRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateBlogTagsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/quotes":{"get":{"tags":["Quotes"],"summary":"List Quotes","description":"List quotes with pagination support\n\nThis endpoint follows the HubSpot CRM Quotes v3 API specification:\n- Supports forward-only pagination with cursor-based approach (after)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"list_quotes_crm_v3_objects_quotes_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Quotes"],"summary":"Create Quote","description":"Create a quote with the given properties and return a copy of the object, including the ID.\n\nThis endpoint follows the HubSpot CRM Quotes v3 API specification:\n- Accepts properties and optional associations\n- Returns created quote with location, createdResourceId, and entity\n- Requires write scope for quotes","operationId":"create_quote_crm_v3_objects_quotes_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQuoteRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateQuoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/quotes/{quoteId}":{"get":{"tags":["Quotes"],"summary":"Get Quote","description":"Get a single quote by ID\n\nThis endpoint follows the HubSpot CRM Quotes v3 API specification:\n- Supports property filtering\n- Supports custom ID property lookup via idProperty param\n- Returns single quote in HubSpot format","operationId":"get_quote_crm_v3_objects_quotes__quoteId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"quoteId","in":"path","required":true,"schema":{"type":"string","title":"Quoteid"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Quotes"],"summary":"Update Quote","description":"Update a quote with partial property updates\n\nThis endpoint follows the HubSpot CRM Quotes v3 API specification:\n- Supports partial updates via PATCH method\n- Properties provided will be overwritten\n- Empty string values clear properties\n- Read-only properties cannot be modified\n- Supports lookup by unique property via idProperty query param","operationId":"update_quote_crm_v3_objects_quotes__quoteId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"quoteId","in":"path","required":true,"schema":{"type":"string","title":"Quoteid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateQuoteRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/QuoteUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Quotes"],"summary":"Archive Quote","description":"Archive a quote\n\nThis endpoint follows the HubSpot CRM Quotes v3 API specification:\n- Returns 204 No Content on success\n- Moves quote to recycling bin (archived = true)\n- Only accepts quoteId as path parameter","operationId":"archive_quote_crm_v3_objects_quotes__quoteId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"quoteId","in":"path","required":true,"schema":{"type":"string","title":"Quoteid"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/0-162":{"get":{"tags":["Services"],"summary":"List Services","description":"List services with pagination support\n\nThis endpoint follows the HubSpot CRM Services v3 API specification:\n- Supports pagination with cursor-based approach (after/before)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"list_services_crm_v3_objects_0_162_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServiceListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/taxes":{"get":{"tags":["Taxes"],"summary":"List Taxes","description":"List taxes with pagination support\n\nThis endpoint follows the HubSpot CRM Taxes v3 API specification:\n- Supports pagination with cursor-based approach (after)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"list_taxes_crm_v3_objects_taxes_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties","title":"Properties"},"description":"Comma separated properties"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties with history","title":"Propertieswithhistory"},"description":"Comma separated properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated associations","title":"Associations"},"description":"Comma separated associations"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Taxes"],"summary":"Create Tax","description":"Create a tax with the given properties and return a copy of the object, including the ID.\n\nThis endpoint follows the HubSpot CRM Taxes v3 API specification:\n- Accepts properties and optional associations\n- Returns created tax with location, createdResourceId, and entity\n- Requires write scope for line items","operationId":"create_tax_crm_v3_objects_taxes_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaxRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxWriteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/taxes/{taxId}":{"get":{"tags":["Taxes"],"summary":"Get Tax","description":"Get a single tax by ID\n\nThis endpoint follows the HubSpot CRM Taxes v3 API specification:\n- Supports property filtering\n- Supports custom ID property lookup via idProperty param\n- Returns single tax in HubSpot format","operationId":"get_tax_crm_v3_objects_taxes__taxId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"taxId","in":"path","required":true,"schema":{"type":"string","title":"Taxid"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Taxes"],"summary":"Update Tax","description":"Update a tax with partial property updates\n\nThis endpoint follows the HubSpot CRM Taxes v3 API specification:\n- Supports partial updates via PATCH method\n- Properties provided will be overwritten\n- Empty string values clear properties\n- Read-only properties cannot be modified\n- Supports lookup by unique property via idProperty query param","operationId":"update_tax_crm_v3_objects_taxes__taxId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"taxId","in":"path","required":true,"schema":{"type":"string","title":"Taxid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaxRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaxWriteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Taxes"],"summary":"Archive Tax","description":"Archive a tax\n\nThis endpoint follows the HubSpot CRM Taxes v3 API specification:\n- Returns 204 No Content on success\n- Moves tax to recycling bin (archived = true)\n- Only accepts taxId as path parameter","operationId":"archive_tax_crm_v3_objects_taxes__taxId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"taxId","in":"path","required":true,"schema":{"type":"string","title":"Taxid"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/tickets":{"get":{"tags":["Tickets"],"summary":"List Tickets","description":"List tickets with pagination support\n\nThis endpoint follows the HubSpot CRM Tickets v3 API specification:\n- Supports pagination with cursor-based approach (after)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"list_tickets_crm_v3_objects_tickets_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer","minimum":1},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties","title":"Properties"},"description":"Comma separated properties"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated properties with history","title":"Propertieswithhistory"},"description":"Comma separated properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Comma separated associations","title":"Associations"},"description":"Comma separated associations"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Tickets"],"summary":"Create Ticket","description":"Create a ticket with the given properties and return a copy of the object, including the ID.\n\nThis endpoint follows the HubSpot CRM Tickets v3 API specification:\n- Accepts properties and required associations\n- Returns SimplePublicObject with the created ticket\n- Requires tickets scope","operationId":"create_ticket_crm_v3_objects_tickets_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTicketRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/tickets/{ticketId}":{"get":{"tags":["Tickets"],"summary":"Get Ticket","description":"Get a single ticket by ID\n\nThis endpoint follows the HubSpot CRM Tickets v3 API specification:\n- Supports property filtering\n- Supports custom ID property lookup via idProperty param\n- Returns single ticket in HubSpot format","operationId":"get_ticket_crm_v3_objects_tickets__ticketId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","description":"The unique ID of the ticket to retrieve","title":"Ticketid"},"description":"The unique ID of the ticket to retrieve"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Tickets"],"summary":"Update Ticket","description":"Update a ticket with partial property updates\n\nThis endpoint follows the HubSpot CRM Tickets v3 API specification:\n- Supports partial updates via PATCH method\n- Properties provided will be overwritten\n- Empty string values clear properties\n- Read-only properties cannot be modified\n- Supports lookup by unique property via idProperty query param","operationId":"update_ticket_crm_v3_objects_tickets__ticketId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","title":"Ticketid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTicketRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Tickets"],"summary":"Archive Ticket","description":"Archive a ticket\n\nThis endpoint follows the HubSpot CRM Tickets v3 API specification:\n- Returns 204 No Content on success\n- Returns 409 Conflict if the ticket is already archived (gym behavior)\n- Moves ticket to recycling bin (archived = true)\n- Only accepts ticketId as path parameter","operationId":"archive_ticket_crm_v3_objects_tickets__ticketId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"ticketId","in":"path","required":true,"schema":{"type":"string","title":"Ticketid"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/tickets/merge":{"post":{"tags":["Tickets"],"summary":"Merge Tickets","description":"Merge two tickets, combining them into one ticket record.\n\nThis endpoint follows the HubSpot CRM Tickets v3 API specification:\n- Creates a NEW ticket with merged properties from both tickets\n- Primary ticket's properties are prioritized\n- Associations from both tickets are transferred to the new ticket\n- Both original tickets are permanently deleted (not archived)\n- Requires tickets scope","operationId":"merge_tickets_crm_v3_objects_tickets_merge_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MergeTicketRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TicketResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/calls":{"get":{"tags":["Calls"],"summary":"List Calls","description":"Read a page of calls matching HubSpot CRM calls API contract.\n\nSupports:\n- Cursor-based pagination via `limit` and `after`\n- Filtering on archived status\n- Property and association selection mirroring HubSpot parameters","operationId":"list_calls_crm_v3_objects_calls_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Calls"],"summary":"Create Call","description":"Create a call with the given properties and return a copy of the object, including the ID.\n\nDocumentation and examples for creating standard calls is provided.","operationId":"create_call_crm_v3_objects_calls_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCallRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/calls/{callId}":{"get":{"tags":["Calls"],"summary":"Read Call","description":"Read an Object identified by {callId}.\n\n{callId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param.\nControl what is returned via the properties query param.","operationId":"read_call_crm_v3_objects_calls__callId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"callId","in":"path","required":true,"schema":{"type":"string","description":"Call ID","title":"Callid"},"description":"Call ID"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Calls"],"summary":"Update Call","description":"Update a call with partial property updates.","operationId":"update_call_crm_v3_objects_calls__callId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"callId","in":"path","required":true,"schema":{"type":"string","description":"Call ID","title":"Callid"},"description":"Call ID"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCallRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CallResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Calls"],"summary":"Archive Call","description":"Archive a call (moves to recycling bin).","operationId":"archive_call_crm_v3_objects_calls__callId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"callId","in":"path","required":true,"schema":{"type":"string","description":"Call ID","title":"Callid"},"description":"Call ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/notes":{"get":{"tags":["Notes"],"summary":"List Notes","description":"Read a page of notes matching HubSpot CRM notes API contract.\n\nSupports:\n- Cursor-based pagination via `limit` and `after`\n- Filtering on archived status\n- Property and association selection mirroring HubSpot parameters","operationId":"list_notes_crm_v3_objects_notes_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Notes"],"summary":"Create Note","description":"Create a note with the given properties and return a copy of the object, including the ID.\n\nDocumentation and examples for creating standard notes is provided.","operationId":"create_note_crm_v3_objects_notes_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateNoteRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/notes/{noteId}":{"get":{"tags":["Notes"],"summary":"Read Note","description":"Read an Object identified by {noteId}.\n\n{noteId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param.\nControl what is returned via the properties query param.","operationId":"read_note_crm_v3_objects_notes__noteId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"noteId","in":"path","required":true,"schema":{"type":"string","description":"Note ID","title":"Noteid"},"description":"Note ID"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Notes"],"summary":"Update Note","description":"Update a note with partial property updates.","operationId":"update_note_crm_v3_objects_notes__noteId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"noteId","in":"path","required":true,"schema":{"type":"string","description":"Note ID","title":"Noteid"},"description":"Note ID"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateNoteRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoteResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Notes"],"summary":"Archive Note","description":"Archive a note (moves to recycling bin).","operationId":"archive_note_crm_v3_objects_notes__noteId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"noteId","in":"path","required":true,"schema":{"type":"string","description":"Note ID","title":"Noteid"},"description":"Note ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/tasks":{"get":{"tags":["Tasks"],"summary":"List Tasks","description":"Read a page of tasks matching HubSpot CRM tasks API contract.\n\nSupports:\n- Cursor-based pagination via `limit` and `after`\n- Filtering on archived status\n- Property and association selection mirroring HubSpot parameters","operationId":"list_tasks_crm_v3_objects_tasks_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Tasks"],"summary":"Create Task","description":"Create a task with the given properties and return a copy of the object, including the ID.\n\nDocumentation and examples for creating standard tasks is provided.","operationId":"create_task_crm_v3_objects_tasks_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateTaskRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/tasks/{taskId}":{"get":{"tags":["Tasks"],"summary":"Read Task","description":"Read an Object identified by {taskId}.\n\n{taskId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param.\nControl what is returned via the properties query param.","operationId":"read_task_crm_v3_objects_tasks__taskId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string","description":"Task ID","title":"Taskid"},"description":"Task ID"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Tasks"],"summary":"Update Task","description":"Update a task with partial property updates.","operationId":"update_task_crm_v3_objects_tasks__taskId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string","description":"Task ID","title":"Taskid"},"description":"Task ID"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateTaskRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TaskResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Tasks"],"summary":"Archive Task","description":"Archive a task (moves to recycling bin).","operationId":"archive_task_crm_v3_objects_tasks__taskId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"taskId","in":"path","required":true,"schema":{"type":"string","description":"Task ID","title":"Taskid"},"description":"Task ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/carts":{"get":{"tags":["Commerce - Carts"],"summary":"List Carts","description":"Retrieve all carts with pagination and filtering.\n\nRequires crm.objects.carts.read scope.\nSupports pagination, property filtering, association retrieval, and archived status filtering.","operationId":"list_carts_crm_v3_objects_carts_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Carts retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCartsResponse"}}}},"403":{"description":"Forbidden - missing required scope"},"422":{"description":"Validation error - invalid query parameters"}}},"post":{"tags":["Commerce - Carts"],"summary":"Create Cart","description":"Create a new cart record.\n\nRequires a valid Bearer token with scope crm.objects.carts.write.\nReturns HubSpot-compliant response format with createdResourceId and entity.","operationId":"create_cart_crm_v3_objects_carts_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCartRequest"}}}},"responses":{"200":{"description":"Cart created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCartResponse"}}}},"400":{"description":"Bad request - invalid associations or malformed data"},"403":{"description":"Forbidden - missing required scope crm.objects.carts.write"},"422":{"description":"Validation error - property validation failed or invalid input"}}}},"/crm/v3/objects/carts/{cartId}":{"patch":{"tags":["Commerce - Carts"],"summary":"Update Cart","description":"Update an existing cart by ID or unique property.\n\nTo identify a cart by ID, include the ID in the request URL path.\nTo identify a cart by a unique property, include the property value in the\nrequest URL path, and add the idProperty query parameter.\n\nProperties provided will be overwritten. Properties values can be cleared by\npassing an empty string. Read-only and non-existent properties will result in an error.","operationId":"update_cart_crm_v3_objects_carts__cartId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"cartId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Cart ID or unique property value","title":"Cartid"},"description":"Cart ID or unique property value"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to identify cart by","title":"Idproperty"},"description":"Property name to identify cart by"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCartRequest"}}}},"responses":{"200":{"description":"Cart updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CartEntity"}}}},"400":{"description":"Bad request - invalid properties or read-only property modification"},"403":{"description":"Forbidden - missing required scope crm.objects.carts.write"},"404":{"description":"Not found - cart does not exist"},"422":{"description":"Validation error - property validation failed"}}},"delete":{"tags":["Commerce - Carts"],"summary":"Archive Cart","description":"Archive a cart by ID.\n\nDeleted carts can be restored within 90 days of deletion.\nThis sets the cart's archived status to True.","operationId":"archive_cart_crm_v3_objects_carts__cartId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"cartId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Cart ID to archive","title":"Cartid"},"description":"Cart ID to archive"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Cart archived successfully"},"403":{"description":"Forbidden - missing required scope crm.objects.carts.write"},"404":{"description":"Not found - cart does not exist"},"409":{"description":"Conflict - cart is already archived"},"422":{"description":"Validation error - invalid cartId"}}},"get":{"tags":["Commerce - Carts"],"summary":"Get Cart","description":"Retrieve a single cart by ID or unique property.\n\nTo identify a cart by ID, include the ID in the request URL path.\nTo identify a cart by a unique property, include the\nproperty value in the request URL path, and add the idProperty query parameter.\n\nRequires crm.objects.carts.read scope.","operationId":"get_cart_crm_v3_objects_carts__cartId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"cartId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Cart ID or unique property value","title":"Cartid"},"description":"Cart ID or unique property value"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to identify cart by","title":"Idproperty"},"description":"Property name to identify cart by"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Cart retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCartResponse"}}}},"403":{"description":"Forbidden - missing required scope"},"404":{"description":"Not found - cart does not exist"},"422":{"description":"Validation error - invalid cartId"}}}},"/crm/v3/objects/commerce_payments":{"post":{"tags":["Commerce - Payments"],"summary":"Create Payment","description":"Create a new payment record.\n\nRequires a valid Bearer token with scope crm.objects.commercepayments.write.\nReturns HubSpot-compliant response format with createdResourceId and entity.\nAt minimum, 'hs_initial_amount' and 'hs_initiated_date' must be provided in properties.","operationId":"create_payment_crm_v3_objects_commerce_payments_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentRequest"}}}},"responses":{"201":{"description":"Payment created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePaymentResponse"}}}},"400":{"description":"Bad request - invalid associations or malformed data"},"403":{"description":"Forbidden - missing required scope crm.objects.commercepayments.write"},"422":{"description":"Validation error - property validation failed or invalid input"}}},"get":{"tags":["Commerce - Payments"],"summary":"List Payments","description":"Retrieve all payments with pagination and filtering.\n\nRequires crm.objects.commercepayments.read scope.\nSupports pagination, property filtering, association retrieval, and archived status filtering.","operationId":"list_payments_crm_v3_objects_commerce_payments_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Payments retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListPaymentsResponse"}}}},"403":{"description":"Forbidden - missing required scope"},"422":{"description":"Validation error - invalid query parameters"}}}},"/crm/v3/objects/commerce_payments/{commercePaymentId}":{"patch":{"tags":["Commerce - Payments"],"summary":"Update Payment","description":"Update an existing payment by ID or unique property.\n\nTo identify a payment by ID, include the ID in the request URL path.\nTo identify a payment by a unique property, include the property value in the\nrequest URL path, and add the idProperty query parameter.\n\nProperties provided will be overwritten. Properties values can be cleared by\npassing an empty string. Read-only and non-existent properties will result in an error.","operationId":"update_payment_crm_v3_objects_commerce_payments__commercePaymentId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"commercePaymentId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Payment ID or unique property value","title":"Commercepaymentid"},"description":"Payment ID or unique property value"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to identify payment by","title":"Idproperty"},"description":"Property name to identify payment by"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePaymentRequest"}}}},"responses":{"200":{"description":"Payment updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentEntity"}}}},"400":{"description":"Bad request - invalid properties or read-only property modification"},"403":{"description":"Forbidden - missing required scope crm.objects.commercepayments.write"},"404":{"description":"Not found - payment does not exist"},"422":{"description":"Validation error - property validation failed"}}},"delete":{"tags":["Commerce - Payments"],"summary":"Archive Payment","description":"Archive a payment by ID.\n\nDeleted payments can be restored within 90 days of deletion.\nThis sets the payment's archived status to True.","operationId":"archive_payment_crm_v3_objects_commerce_payments__commercePaymentId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"commercePaymentId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Payment ID to archive","title":"Commercepaymentid"},"description":"Payment ID to archive"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Payment archived successfully"},"403":{"description":"Forbidden - missing required scope crm.objects.commercepayments.write"},"404":{"description":"Not found - payment does not exist"},"409":{"description":"Conflict - payment is already archived"},"422":{"description":"Validation error - invalid commercePaymentId"}}},"get":{"tags":["Commerce - Payments"],"summary":"Get Payment","description":"Retrieve a single payment by ID or unique property.\n\nTo identify a payment by ID, include the ID in the request URL path.\nTo identify a payment by a unique property, include the\nproperty value in the request URL path, and add the idProperty query parameter.\n\nRequires crm.objects.commercepayments.read scope.","operationId":"get_payment_crm_v3_objects_commerce_payments__commercePaymentId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"commercePaymentId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Payment ID or unique property value","title":"Commercepaymentid"},"description":"Payment ID or unique property value"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to identify payment by","title":"Idproperty"},"description":"Property name to identify payment by"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Payment retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetPaymentResponse"}}}},"403":{"description":"Forbidden - missing required scope"},"404":{"description":"Not found - payment does not exist"},"422":{"description":"Validation error - invalid commercePaymentId"}}}},"/crm/v3/pipelines/{objectType}/{pipelineId}":{"get":{"tags":["CRM - Pipelines"],"summary":"Get Pipeline By Id","description":"Return a single pipeline object identified by its unique {pipelineId}.\n\nRequires a valid Bearer token with one of the documented scopes.\nReturns a single pipeline object with its stages.","operationId":"get_pipeline_by_id_crm_v3_pipelines__objectType___pipelineId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the pipeline being retrieved (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the pipeline being retrieved (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline to be retrieved","title":"Pipelineid"},"description":"The unique identifier of the pipeline to be retrieved"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved pipeline","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineResponse"}}}},"400":{"description":"Bad request - invalid objectType"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CRM - Pipelines"],"summary":"Update Pipeline","description":"Perform a partial update of the pipeline identified by {pipelineId}.\n\nRequires a valid Bearer token with one of the documented scopes.\nThe updated pipeline will be returned in the response.\n\nNote: The archived property should only be provided when restoring an archived pipeline.\nIf it's provided in any other call, the request will fail and a 400 Bad Request will be returned.","operationId":"update_pipeline_crm_v3_pipelines__objectType___pipelineId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the pipeline being updated (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the pipeline being updated (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline to be updated","title":"Pipelineid"},"description":"The unique identifier of the pipeline to be updated"},{"name":"validateDealStageUsagesBeforeDelete","in":"query","required":false,"schema":{"type":"boolean","description":"If true, before removing stages, ensure no deal records use those stages (deals object type only; no-op for other types).","default":false,"title":"Validatedealstageusagesbeforedelete"},"description":"If true, before removing stages, ensure no deal records use those stages (deals object type only; no-op for other types)."},{"name":"validateReferencesBeforeDelete","in":"query","required":false,"schema":{"type":"boolean","description":"If true, before removing/replacing the pipeline, ensure no records reference this pipeline (e.g. deals pipeline, tickets hs_pipeline).","default":false,"title":"Validatereferencesbeforedelete"},"description":"If true, before removing/replacing the pipeline, ensure no records reference this pipeline (e.g. deals pipeline, tickets hs_pipeline)."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineUpdateRequest"}}}},"responses":{"200":{"description":"Pipeline updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineResponse"}}}},"400":{"description":"Bad request - invalid archived field or objectType mismatch"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline not found"},"422":{"description":"Validation error - invalid input"}}},"delete":{"tags":["CRM - Pipelines"],"summary":"Delete Pipeline","description":"Delete a pipeline identified by {pipelineId}.\n\nRequires a valid Bearer token with one of the documented scopes.\nAll stages associated with the pipeline will be automatically deleted via cascade.","operationId":"delete_pipeline_crm_v3_pipelines__objectType___pipelineId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the pipeline being deleted (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the pipeline being deleted (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline to be deleted","title":"Pipelineid"},"description":"The unique identifier of the pipeline to be deleted"},{"name":"validateDealStageUsagesBeforeDelete","in":"query","required":false,"schema":{"type":"boolean","description":"If true, before removing stages, ensure no deal records use those stages (deals object type only; no-op for other types).","default":false,"title":"Validatedealstageusagesbeforedelete"},"description":"If true, before removing stages, ensure no deal records use those stages (deals object type only; no-op for other types)."},{"name":"validateReferencesBeforeDelete","in":"query","required":false,"schema":{"type":"boolean","description":"If true, before removing/replacing the pipeline, ensure no records reference this pipeline (e.g. deals pipeline, tickets hs_pipeline).","default":false,"title":"Validatereferencesbeforedelete"},"description":"If true, before removing/replacing the pipeline, ensure no records reference this pipeline (e.g. deals pipeline, tickets hs_pipeline)."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Pipeline deleted successfully"},"400":{"description":"Bad request - objectType mismatch"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["CRM - Pipelines"],"summary":"Replace Pipeline","description":"Replace all properties of an existing pipeline with the provided values.\n\nRequires a valid Bearer token with one of the documented scopes.\nThis performs a full replacement - all pipeline properties and all stages are replaced.\nOld stages are deleted and new ones are created. The createdAt timestamp is preserved.\n\nNote: Query parameters validateDealStageUsagesBeforeDelete and validateReferencesBeforeDelete\ncan be used to validate that no objects are using the pipeline before replacement.","operationId":"replace_pipeline_crm_v3_pipelines__objectType___pipelineId__put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the pipeline being replaced (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the pipeline being replaced (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline to be replaced","title":"Pipelineid"},"description":"The unique identifier of the pipeline to be replaced"},{"name":"validateDealStageUsagesBeforeDelete","in":"query","required":false,"schema":{"type":"boolean","description":"If true, before removing stages, ensure no deal records use those stages (deals object type only; no-op for other types).","default":false,"title":"Validatedealstageusagesbeforedelete"},"description":"If true, before removing stages, ensure no deal records use those stages (deals object type only; no-op for other types)."},{"name":"validateReferencesBeforeDelete","in":"query","required":false,"schema":{"type":"boolean","description":"If true, before removing/replacing the pipeline, ensure no records reference this pipeline (e.g. deals pipeline, tickets hs_pipeline).","default":false,"title":"Validatereferencesbeforedelete"},"description":"If true, before removing/replacing the pipeline, ensure no records reference this pipeline (e.g. deals pipeline, tickets hs_pipeline)."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineInput"}}}},"responses":{"200":{"description":"Pipeline replaced successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineResponse"}}}},"400":{"description":"Bad request - invalid objectType or objectType mismatch"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline not found"},"422":{"description":"Validation error - invalid input, metadata validation failed, or stage limit exceeded"}}}},"/crm/v3/pipelines/{objectType}":{"get":{"tags":["CRM - Pipelines"],"summary":"Get All Pipelines","description":"Retrieve all pipelines for the object type specified by {objectType}.\n\nRequires a valid Bearer token with one of the documented scopes.\nReturns an array of pipeline objects wrapped in a results object, sorted by displayOrder then alphabetically by label.","operationId":"get_all_pipelines_crm_v3_pipelines__objectType__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the pipelines to retrieve (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the pipelines to retrieve (ex. deals or tickets)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved all pipelines","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllPipelinesResponse"}}}},"400":{"description":"Bad request - invalid objectType"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["CRM - Pipelines"],"summary":"Create Pipeline","description":"Create a new pipeline with the provided property values.\n\nRequires a valid Bearer token with one of the documented scopes.\nThe entire pipeline object, including its unique ID, will be returned in the response.","operationId":"create_pipeline_crm_v3_pipelines__objectType__post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the pipeline being created (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the pipeline being created (ex. deals or tickets)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineInput"}}}},"responses":{"201":{"description":"Pipeline created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreatePipelineResponse"}}}},"400":{"description":"Bad request - invalid objectType"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"422":{"description":"Validation error - invalid input or metadata validation failed"}}}},"/crm/v3/pipelines/{objectType}/{pipelineId}/stages":{"post":{"tags":["CRM - Pipeline Stages"],"summary":"Create Pipeline Stage","description":"Create a new stage within the specified pipeline.\n\nRequires a valid Bearer token with one of the documented scopes.\nThe entire pipeline stage object, including its unique ID, will be returned in the response.","operationId":"create_pipeline_stage_crm_v3_pipelines__objectType___pipelineId__stages_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the stage being created (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the stage being created (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline to which the stage will be added","title":"Pipelineid"},"description":"The unique identifier of the pipeline to which the stage will be added"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStageInput"}}}},"responses":{"201":{"description":"Pipeline stage created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStageResponse"}}}},"400":{"description":"Bad request - invalid objectType or pipelineId"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline not found"},"422":{"description":"Validation error - invalid input, duplicate label, max stages exceeded, or metadata validation failed"}}},"get":{"tags":["CRM - Pipeline Stages"],"summary":"Get All Stages","description":"Return all the stages associated with the pipeline identified by pipelineId.\n\nRequires a valid Bearer token with one of the documented scopes.\nReturns an array of pipeline stage objects wrapped in a results object.","operationId":"get_all_stages_crm_v3_pipelines__objectType___pipelineId__stages_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the stages being retrieved (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the stages being retrieved (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline whose stages are being retrieved.","title":"Pipelineid"},"description":"The unique identifier of the pipeline whose stages are being retrieved."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved all pipeline stages","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetAllStagesResponse"}}}},"400":{"description":"Bad request - invalid objectType or invalid ID format"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/pipelines/{objectType}/{pipelineId}/stages/{stageId}":{"delete":{"tags":["CRM - Pipeline Stages"],"summary":"Delete Pipeline Stage","description":"Delete a specific stage from a pipeline.\n\nRequires a valid Bearer token with one of the documented scopes.","operationId":"delete_pipeline_stage_crm_v3_pipelines__objectType___pipelineId__stages__stageId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the stage being deleted (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the stage being deleted (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline from which the stage will be deleted","title":"Pipelineid"},"description":"The unique identifier of the pipeline from which the stage will be deleted"},{"name":"stageId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the stage to be deleted from the pipeline","title":"Stageid"},"description":"The unique identifier of the stage to be deleted from the pipeline"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Pipeline stage deleted successfully"},"400":{"description":"Bad request - invalid objectType"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline or stage not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CRM - Pipeline Stages"],"summary":"Update Pipeline Stage","description":"Perform a partial update on a specific stage of a pipeline.\n\nRequires a valid Bearer token with one of the documented scopes.\nThe updated pipeline stage object will be returned in the response.","operationId":"update_pipeline_stage_crm_v3_pipelines__objectType___pipelineId__stages__stageId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the stage being updated (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the stage being updated (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline containing the stage to be updated.","title":"Pipelineid"},"description":"The unique identifier of the pipeline containing the stage to be updated."},{"name":"stageId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the stage to be updated in the pipeline.","title":"Stageid"},"description":"The unique identifier of the stage to be updated in the pipeline."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStagePatchInput"}}}},"responses":{"200":{"description":"Pipeline stage updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStageResponse"}}}},"400":{"description":"Bad request - invalid objectType or invalid ID format"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline or stage not found"},"422":{"description":"Validation error - duplicate label, invalid metadata, or metadata validation failed"}}},"put":{"tags":["CRM - Pipeline Stages"],"summary":"Replace Pipeline Stage","description":"Replace all properties of an existing pipeline stage with the provided values.\n\nRequires a valid Bearer token with one of the documented scopes.\nThe createdAt timestamp is preserved, but all other properties are replaced.\nThe updated pipeline stage object will be returned in the response.","operationId":"replace_pipeline_stage_crm_v3_pipelines__objectType___pipelineId__stages__stageId__put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the stage being replaced (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the stage being replaced (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline containing the stage to be replaced.","title":"Pipelineid"},"description":"The unique identifier of the pipeline containing the stage to be replaced."},{"name":"stageId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the stage to be replaced in the pipeline.","title":"Stageid"},"description":"The unique identifier of the stage to be replaced in the pipeline."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStageInput"}}}},"responses":{"200":{"description":"Pipeline stage replaced successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStageResponse"}}}},"400":{"description":"Bad request - invalid objectType or invalid ID format"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline or stage not found"},"422":{"description":"Validation error - duplicate label, invalid metadata, or metadata validation failed"}}},"get":{"tags":["CRM - Pipeline Stages"],"summary":"Get Stage By Id","description":"Return a single pipeline stage identified by its unique stageId.\n\nRequires a valid Bearer token with one of the documented scopes.\nReturns a single pipeline stage object.","operationId":"get_stage_by_id_crm_v3_pipelines__objectType___pipelineId__stages__stageId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"The object type of the stage being retrieved (ex. deals or tickets)","title":"Objecttype"},"description":"The object type of the stage being retrieved (ex. deals or tickets)"},{"name":"pipelineId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the pipeline containing the stage.","title":"Pipelineid"},"description":"The unique identifier of the pipeline containing the stage."},{"name":"stageId","in":"path","required":true,"schema":{"type":"string","description":"The unique identifier of the stage to be retrieved.","title":"Stageid"},"description":"The unique identifier of the stage to be retrieved."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved pipeline stage","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PipelineStageResponse"}}}},"400":{"description":"Bad request - invalid objectType or invalid ID format"},"403":{"description":"Forbidden - missing required scope. Requires one of the documented scopes."},"404":{"description":"Not Found - pipeline or stage not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/users":{"get":{"tags":["Users"],"summary":"List Users","description":"List users with pagination support\n\nThis endpoint follows the HubSpot CRM Users v3 API specification:\n- Supports pagination with cursor-based approach (after/before)\n- Filters by archived status\n- Supports property filtering\n- Returns results in HubSpot format with URL-encoded cursors","operationId":"list_users_crm_v3_objects_users_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"before","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Previous page cursor token","title":"Before"},"description":"Previous page cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Users"],"summary":"Create User","description":"Create a user with the given properties and return a copy of the object, including the ID.\n\nThis endpoint follows the HubSpot CRM Users v3 API specification:\n- Accepts properties and optional associations\n- Returns created user with location, createdResourceId, and entity\n- Requires write scope for users","operationId":"create_user_crm_v3_objects_users_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateUserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/users/{userId}":{"get":{"tags":["Users"],"summary":"Get User","description":"Get a single user by ID\n\nThis endpoint follows the HubSpot CRM Users v3 API specification:\n- Supports property filtering\n- Supports custom ID property lookup via idProperty param\n- Returns single user in HubSpot format","operationId":"get_user_crm_v3_objects_users__userId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","title":"Userid"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Users"],"summary":"Update User","description":"Update a user with partial property updates\n\nThis endpoint follows the HubSpot CRM Users v3 API specification:\n- Supports partial updates via PATCH method\n- Properties provided will be overwritten\n- Empty string values clear properties\n- Read-only properties cannot be modified\n- Supports lookup by unique property via idProperty query param","operationId":"update_user_crm_v3_objects_users__userId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","title":"Userid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateUserRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Users"],"summary":"Archive User","description":"Archive a user\n\nThis endpoint follows the HubSpot CRM Users v3 API specification:\n- Returns 204 No Content on success\n- Moves user to recycling bin (archived = true)\n- Only accepts userId as path parameter","operationId":"archive_user_crm_v3_objects_users__userId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","title":"Userid"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/codes":{"get":{"tags":["Currencies"],"summary":"Get All Currency Codes","description":"Get all supported currency codes\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Returns list of all supported currency codes with labels\n- Requires multi-currency-read scope\n- No query parameters needed","operationId":"get_all_currency_codes_settings_v3_currencies_codes_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyCodesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/company-currency":{"get":{"tags":["Currencies"],"summary":"Get Company Currency","description":"Get the company currency details\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Returns company currency code (id) and creation timestamp\n- Requires settings.currencies.read scope\n- No query parameters needed","operationId":"get_company_currency_settings_v3_currencies_company_currency_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCurrencyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Currencies"],"summary":"Set Or Update Company Currency","description":"Set or update the company currency\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Sets the specified currency code as the company currency\n- Returns company currency code (id) and creation timestamp\n- Requires settings.currencies.write scope","operationId":"set_or_update_company_currency_settings_v3_currencies_company_currency_put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SetCompanyCurrencyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCurrencyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/exchange-rates":{"get":{"tags":["Currencies"],"summary":"Get Exchange Rates","description":"Get a list of exchange rates\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Returns a paginated list of exchange rates\n- Supports filtering by fromCurrencyCode and toCurrencyCode\n- Supports cursor-based pagination with limit and after parameters\n- Requires settings.currencies.read scope","operationId":"get_exchange_rates_settings_v3_currencies_exchange_rates_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","minimum":1,"description":"Maximum results per page","default":100,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"fromCurrencyCode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by from currency code","title":"Fromcurrencycode"},"description":"Filter by from currency code"},{"name":"toCurrencyCode","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Filter by to currency code","title":"Tocurrencycode"},"description":"Filter by to currency code"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRatesListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Currencies"],"summary":"Add New Exchange Rate","description":"Create an exchange rate\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Creates a new exchange rate for the specified currency\n- Requires settings.currencies.write scope","operationId":"add_new_exchange_rate_settings_v3_currencies_exchange_rates_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateExchangeRateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/exchange-rates/current":{"get":{"tags":["Currencies"],"summary":"Get All Current Exchange Rates","description":"Get current exchange rates\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Returns the latest exchange rate per currency (based on effectiveAt)\n- Returns rates regardless of visibility status (both visibleInUI true and false)\n- Requires settings.currencies.read scope","operationId":"get_all_current_exchange_rates_settings_v3_currencies_exchange_rates_current_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrentExchangeRatesListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/exchange-rates/{exchangeRateId}":{"get":{"tags":["Currencies"],"summary":"Get Details For Specific Exchange Rate","description":"Get exchange rate by ID\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Returns a specific exchange rate by ID\n- Requires settings.currencies.read scope","operationId":"get_details_for_specific_exchange_rate_settings_v3_currencies_exchange_rates__exchangeRateId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"exchangeRateId","in":"path","required":true,"schema":{"type":"string","description":"Exchange rate ID","title":"Exchangerateid"},"description":"Exchange rate ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Currencies"],"summary":"Update Conversion Rate","description":"Update an exchange rate\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Updates the conversion rate for a specific exchange rate\n- Requires settings.currencies.write scope","operationId":"update_conversion_rate_settings_v3_currencies_exchange_rates__exchangeRateId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"exchangeRateId","in":"path","required":true,"schema":{"type":"string","description":"Exchange rate ID","title":"Exchangerateid"},"description":"Exchange rate ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateExchangeRateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/exchange-rates/batch/create":{"post":{"tags":["Currencies"],"summary":"Create Multiple Exchange Rates","description":"Batch create exchange rates\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Creates multiple exchange rates in a single request\n- Requires settings.currencies.write scope","operationId":"create_multiple_exchange_rates_settings_v3_currencies_exchange_rates_batch_create_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateExchangeRateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateExchangeRateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/exchange-rates/batch/read":{"post":{"tags":["Currencies"],"summary":"Retrieve Multiple Rates","description":"Retrieve multiple rates\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Retrieves exchange rates by their IDs in a single request\n- Requires settings.currencies.read scope\n- Accepts a list of exchange rate IDs in the request body","operationId":"retrieve_multiple_rates_settings_v3_currencies_exchange_rates_batch_read_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadExchangeRateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadExchangeRateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/exchange-rates/batch/update":{"post":{"tags":["Currencies"],"summary":"Update Multiple Exchange Rates","description":"Batch update exchange rates\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Updates multiple exchange rates in a single request\n- Requires settings.currencies.write scope","operationId":"update_multiple_exchange_rates_settings_v3_currencies_exchange_rates_batch_update_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateExchangeRateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchUpdateExchangeRateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/exchange-rates/update-visibility":{"post":{"tags":["Currencies"],"summary":"Change Visibility Of Specific Currency Pairs","description":"Update currency visibility\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Shows or hides a currency in the UI\n- Returns 204 No Content (no body) per API spec\n- Requires settings.currencies.write scope","operationId":"change_visibility_of_specific_currency_pairs_settings_v3_currencies_exchange_rates_update_visibility_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateVisibilityRequest"}}}},"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/central-fx-rates/information":{"get":{"tags":["Currencies"],"summary":"Get Central Fx Rates Information","description":"Get central FX rates information\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Returns whether automatic exchange rate updates are enabled\n- Requires settings.currencies.read scope","operationId":"get_central_fx_rates_information_settings_v3_currencies_central_fx_rates_information_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CentralFxRatesInformationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/central-fx-rates/unsupported-currencies":{"get":{"tags":["Currencies"],"summary":"Get Unsupported Currencies","description":"Get unsupported currencies for automatic updates\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Returns list of currencies not supported for automatic exchange rate updates\n- Requires settings.currencies.read scope","operationId":"get_unsupported_currencies_settings_v3_currencies_central_fx_rates_unsupported_currencies_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CurrencyCodesResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/settings/v3/currencies/central-fx-rates/add-currency":{"post":{"tags":["Currencies"],"summary":"Add Currency With Auto Updates","description":"Add currency with automatic exchange rate updates\n\nThis endpoint follows the HubSpot Settings Currencies v3 API specification:\n- Adds a currency that will be automatically updated\n- Requires settings.currencies.write scope","operationId":"add_currency_with_auto_updates_settings_v3_currencies_central_fx_rates_add_currency_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AddCurrencyWithAutoUpdatesRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExchangeRateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns":{"post":{"tags":["Campaigns"],"summary":"Create Campaign","description":"Create a marketing campaign\n\nThis endpoint follows the HubSpot Marketing Campaigns v3 API specification:\n- Creates a new campaign with specified properties\n- Validates properties against standard HubSpot fields and custom properties\n- Returns campaign with campaignGuid and timestamps\n- Campaign names must be unique within the portal\n- Requires marketing.campaigns.write scope","operationId":"create_campaign_marketing_v3_campaigns_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Campaigns"],"summary":"Search Campaigns","description":"Search for campaigns using filters, sorting, and cursor pagination.\n\nMirrors HubSpot's GET /marketing/v3/campaigns endpoint:\n- Optional substring filter on hs_name\n- Supports projection of specific properties\n- Sorting on hs_name, createdAt, or updatedAt (ASC/DESC)\n- Cursor-based pagination with limit/after parameters\n- Requires marketing.campaigns.read scope","operationId":"search_campaigns_marketing_v3_campaigns_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Return campaigns whose names contain this substring (case-insensitive)","title":"Name"},"description":"Return campaigns whose names contain this substring (case-insensitive)"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of properties to return. Supports comma-separated values or repeated query parameters.","title":"Properties"},"description":"List of properties to return. Supports comma-separated values or repeated query parameters."},{"name":"sort","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Sort field (hs_name, createdAt, updatedAt). Prefix with '-' for descending (e.g., -createdAt). Defaults to hs_name.","title":"Sort"},"description":"Sort field (hs_name, createdAt, updatedAt). Prefix with '-' for descending (e.g., -createdAt). Defaults to hs_name."},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor token returned in paging.next.after","title":"After"},"description":"Cursor token returned in paging.next.after"},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","description":"Maximum results per page (1-100). Defaults to 50.","default":50,"title":"Limit"},"description":"Maximum results per page (1-100). Defaults to 50."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}":{"patch":{"tags":["Campaigns"],"summary":"Update Campaign","description":"Partially update a marketing campaign\n\nThis endpoint follows the HubSpot Marketing Campaigns v3 API specification:\n- PATCH request updates only the provided properties\n- Unknown or read-only properties return 400 errors\n- Requires marketing.campaigns.write scope","operationId":"update_campaign_marketing_v3_campaigns__campaignGuid__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignPayload"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["Campaigns"],"summary":"Get Campaign","description":"Retrieve a campaign by ID\n\nThis endpoint follows the HubSpot Marketing Campaigns v3 API specification:\n- Returns campaign details by GUID\n- Optionally filters properties to return\n- Can include asset information with date range for metrics\n- Requires marketing.campaigns.read scope","operationId":"get_campaign_marketing_v3_campaigns__campaignGuid__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"List of properties to return (e.g., hs_name, hs_start_date)","title":"Properties"},"description":"List of properties to return (e.g., hs_name, hs_start_date)"},{"name":"startDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date for asset metrics in YYYY-MM-DD format","title":"Startdate"},"description":"Start date for asset metrics in YYYY-MM-DD format"},{"name":"endDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date for asset metrics in YYYY-MM-DD format","title":"Enddate"},"description":"End date for asset metrics in YYYY-MM-DD format"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignDetailResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Campaigns"],"summary":"Delete Campaign","description":"Delete a campaign\n\nThis endpoint follows the HubSpot Marketing Campaigns v3 API specification:\n- Deletes a campaign by GUID\n- Always returns 204 No Content regardless of whether campaign exists\n- Requires marketing.campaigns.write scope","operationId":"delete_campaign_marketing_v3_campaigns__campaignGuid__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/reports/metrics":{"get":{"tags":["Campaigns"],"summary":"Get Campaign Metrics","description":"Return campaign attribution metrics per HubSpot spec.","operationId":"get_campaign_metrics_marketing_v3_campaigns__campaignGuid__reports_metrics_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","minLength":1,"pattern":"^\\S+.*$","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date","description":"The start date for the report data, formatted as YYYY-MM-DD.","default":"2025-01-01","title":"Startdate"},"description":"The start date for the report data, formatted as YYYY-MM-DD."},{"name":"endDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"End date for the report data, formatted as YYYY-MM-DD.","title":"Enddate"},"description":"End date for the report data, formatted as YYYY-MM-DD."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignMetricsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/reports/revenue":{"get":{"tags":["Campaigns"],"summary":"Get Campaign Revenue","description":"Return campaign revenue attribution metrics.","operationId":"get_campaign_revenue_marketing_v3_campaigns__campaignGuid__reports_revenue_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","minLength":1,"pattern":"^\\S+.*$","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"attributionModel","in":"query","required":false,"schema":{"$ref":"#/components/schemas/CampaignAttributionModel","description":"Attribution model to use when aggregating revenue.","default":"LINEAR"},"description":"Attribution model to use when aggregating revenue."},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date","description":"The start date for the report data, formatted as YYYY-MM-DD.","default":"2025-01-01","title":"Startdate"},"description":"The start date for the report data, formatted as YYYY-MM-DD."},{"name":"endDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"End date for the report data, formatted as YYYY-MM-DD.","title":"Enddate"},"description":"End date for the report data, formatted as YYYY-MM-DD."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignRevenueResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/reports/contacts/{contactType}":{"get":{"tags":["Campaigns"],"summary":"Get Campaign Contacts Report","description":"Return campaign contact IDs for the requested attribution metric.","operationId":"get_campaign_contacts_report_marketing_v3_campaigns__campaignGuid__reports_contacts__contactType__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","minLength":1,"pattern":"^\\S+.*$","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"contactType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/CampaignContactType","description":"Contact attribution metric to filter by."},"description":"Contact attribution metric to filter by."},{"name":"startDate","in":"query","required":false,"schema":{"type":"string","format":"date","description":"The start date for the report data, formatted as YYYY-MM-DD.","default":"2025-01-01","title":"Startdate"},"description":"The start date for the report data, formatted as YYYY-MM-DD."},{"name":"endDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"description":"End date for the report data, formatted as YYYY-MM-DD.","title":"Enddate"},"description":"End date for the report data, formatted as YYYY-MM-DD."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Limit for the number of contacts to fetch. Defaults to 100.","default":100,"title":"Limit"},"description":"Limit for the number of contacts to fetch. Defaults to 100."},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor for pagination. Starts results after given value.","title":"After"},"description":"Cursor for pagination. Starts results after given value."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignContactReportResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/budget":{"post":{"tags":["Campaigns"],"summary":"Add Budget Item","description":"Add a campaign budget item per HubSpot Marketing Campaigns API v3.","operationId":"add_budget_item_marketing_v3_campaigns__campaignGuid__budget_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignBudgetItemRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignBudgetItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/budget/totals":{"get":{"tags":["Campaigns"],"summary":"Get Campaign Budget Totals","description":"Retrieve budget totals and itemized spend for a campaign per HubSpot spec.","operationId":"get_campaign_budget_totals_marketing_v3_campaigns__campaignGuid__budget_totals_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignBudgetTotalsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/budget/{budgetId}":{"get":{"tags":["Campaigns"],"summary":"Get Campaign Budget Item","description":"Retrieve a single campaign budget item per HubSpot Marketing Campaigns API v3.","operationId":"get_campaign_budget_item_marketing_v3_campaigns__campaignGuid__budget__budgetId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"budgetId","in":"path","required":true,"schema":{"type":"integer","minimum":0,"description":"Numeric budget item ID (int64)","title":"Budgetid"},"description":"Numeric budget item ID (int64)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignBudgetItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Campaigns"],"summary":"Update Campaign Budget Item","description":"Update a campaign budget item per HubSpot Marketing Campaigns API v3.","operationId":"update_campaign_budget_item_marketing_v3_campaigns__campaignGuid__budget__budgetId__put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"budgetId","in":"path","required":true,"schema":{"type":"integer","minimum":0,"description":"Numeric budget item ID (int64)","title":"Budgetid"},"description":"Numeric budget item ID (int64)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignBudgetItemRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignBudgetItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Campaigns"],"summary":"Delete Campaign Budget Item","description":"Delete a campaign budget item per HubSpot Marketing Campaigns API v3.","operationId":"delete_campaign_budget_item_marketing_v3_campaigns__campaignGuid__budget__budgetId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"budgetId","in":"path","required":true,"schema":{"type":"integer","minimum":0,"description":"Numeric budget item ID (int64)","title":"Budgetid"},"description":"Numeric budget item ID (int64)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/spend":{"post":{"tags":["Campaigns"],"summary":"Create Campaign Spend Item","description":"Create a campaign spend item per HubSpot Marketing Campaigns API v3.","operationId":"create_campaign_spend_item_marketing_v3_campaigns__campaignGuid__spend_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCampaignSpendItemRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignSpendItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/spend/{spendId}":{"get":{"tags":["Campaigns"],"summary":"Get Campaign Spend Item","description":"Retrieve a single campaign spend item in accordance with the HubSpot API spec.","operationId":"get_campaign_spend_item_marketing_v3_campaigns__campaignGuid__spend__spendId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"spendId","in":"path","required":true,"schema":{"type":"integer","minimum":0,"description":"Numeric spend item ID (int64)","title":"Spendid"},"description":"Numeric spend item ID (int64)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignSpendItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Campaigns"],"summary":"Update Campaign Spend Item","description":"Update a campaign spend item following the HubSpot Marketing Campaigns API v3 spec.","operationId":"update_campaign_spend_item_marketing_v3_campaigns__campaignGuid__spend__spendId__put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"spendId","in":"path","required":true,"schema":{"type":"integer","minimum":0,"description":"Numeric spend item ID (int64)","title":"Spendid"},"description":"Numeric spend item ID (int64)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateCampaignSpendItemRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignSpendItemResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Campaigns"],"summary":"Delete Campaign Spend Item","description":"Delete a campaign spend item per HubSpot Marketing Campaigns API v3.","operationId":"delete_campaign_spend_item_marketing_v3_campaigns__campaignGuid__spend__spendId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"spendId","in":"path","required":true,"schema":{"type":"integer","minimum":0,"description":"Numeric spend item ID (int64)","title":"Spendid"},"description":"Numeric spend item ID (int64)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}/{assetId}":{"put":{"tags":["Campaigns"],"summary":"Add Asset Association","description":"Associate an asset with a campaign.","operationId":"add_asset_association_marketing_v3_campaigns__campaignGuid__assets__assetType___assetId__put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"assetType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/HubSpotAssetType","description":"The type of the asset."},"description":"The type of the asset."},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the asset.","title":"Assetid"},"description":"The ID of the asset."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Campaigns"],"summary":"Remove Asset Association","description":"Disassociate an asset from a campaign.","operationId":"remove_asset_association_marketing_v3_campaigns__campaignGuid__assets__assetType___assetId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"assetType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/HubSpotAssetType","description":"The type of the asset."},"description":"The type of the asset."},{"name":"assetId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The ID of the asset.","title":"Assetid"},"description":"The ID of the asset."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/marketing/v3/campaigns/{campaignGuid}/assets/{assetType}":{"get":{"tags":["Campaigns"],"summary":"List Assets","description":"Get all assets of a specific type for a campaign.","operationId":"list_assets_marketing_v3_campaigns__campaignGuid__assets__assetType__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"campaignGuid","in":"path","required":true,"schema":{"type":"string","format":"uuid","description":"Campaign GUID (UUID)","title":"Campaignguid"},"description":"Campaign GUID (UUID)"},{"name":"assetType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/HubSpotAssetType","description":"The type of the asset."},"description":"The type of the asset."},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Cursor token from paging.next.after for pagination.","title":"After"},"description":"Cursor token from paging.next.after for pagination."},{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"description":"Maximum number of results to return (default 10).","default":10,"title":"Limit"},"description":"Maximum number of results to return (default 10)."},{"name":"startDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Start date to fetch asset metrics (YYYY-MM-DD). Must be provided together with endDate.","title":"Startdate"},"description":"Start date to fetch asset metrics (YYYY-MM-DD). Must be provided together with endDate."},{"name":"endDate","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"End date to fetch asset metrics (YYYY-MM-DD). Must be provided together with startDate.","title":"Enddate"},"description":"End date to fetch asset metrics (YYYY-MM-DD). Must be provided together with startDate."},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CampaignAssetListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/business-units/v3/business-units/user/{userId}":{"get":{"tags":["Business Units"],"summary":"Get Business Units By User","description":"Get business units for a specific user\n\nThis endpoint follows the HubSpot Business Units v3 API specification:\n- Returns business units associated with a user\n- Supports filtering by business unit names (array)\n- Optionally includes logoMetadata if requested in properties array\n- Requires authentication","operationId":"get_business_units_by_user_business_units_v3_business_units_user__userId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"userId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Identifier of user to retrieve","title":"Userid"},"description":"Identifier of user to retrieve"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Names of properties to optionally include in response body. Valid value: logoMetadata","title":"Properties"},"description":"Names of properties to optionally include in response body. Valid value: logoMetadata"},{"name":"name","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Business Unit names to retrieve. If empty or omitted, all associated units returned","title":"Name"},"description":"Business Unit names to retrieve. If empty or omitted, all associated units returned"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BusinessUnitsCollectionResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/properties/{objectType}/groups":{"post":{"tags":["CRM - Properties"],"summary":"Create Property Group","description":"Create a new property group for the specified object type.\n\nProperty groups are used to organize custom properties in HubSpot.\nEach group has a name (internal API reference) and label (UI display).\n\nRequires appropriate write scope based on object type.","operationId":"create_property_group_crm_v3_properties__objectType__groups_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type (companies, contacts, deals, etc.)","title":"Objecttype"},"description":"CRM object type (companies, contacts, deals, etc.)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyGroupCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyGroupEntity"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["CRM - Properties"],"summary":"List Property Groups","description":"List all property groups for the specified object type.\n\nProperty groups are used to organize custom properties in HubSpot.\n\nRequires appropriate read scope based on object type.","operationId":"list_property_groups_crm_v3_properties__objectType__groups_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type (companies, contacts, deals, etc.)","title":"Objecttype"},"description":"CRM object type (companies, contacts, deals, etc.)"},{"name":"locale","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Locale for translating property group labels","title":"Locale"},"description":"Locale for translating property group labels"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/PropertyGroupEntity"},"title":"Response List Property Groups Crm V3 Properties  Objecttype  Groups Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/properties/{objectType}/groups/{groupName}":{"get":{"tags":["CRM - Properties"],"summary":"Get Property Group","description":"Get a specific property group by name.\n\nReturns property group details including name, label, and display order.\n\nRequires appropriate read scope based on object type.","operationId":"get_property_group_crm_v3_properties__objectType__groups__groupName__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type (companies, contacts, deals, etc.)","title":"Objecttype"},"description":"CRM object type (companies, contacts, deals, etc.)"},{"name":"groupName","in":"path","required":true,"schema":{"type":"string","description":"Internal property group name","title":"Groupname"},"description":"Internal property group name"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyGroupGetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["CRM - Properties"],"summary":"Archive Property Group","description":"Archive a property group by name.\n\nMove a property group to the recycling bin. Archived property groups\ncan be restored within a certain timeframe.\n\nRequires appropriate write scope based on object type.","operationId":"archive_property_group_crm_v3_properties__objectType__groups__groupName__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type (companies, contacts, deals, etc.)","title":"Objecttype"},"description":"CRM object type (companies, contacts, deals, etc.)"},{"name":"groupName","in":"path","required":true,"schema":{"type":"string","description":"Internal property group name to archive","title":"Groupname"},"description":"Internal property group name to archive"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CRM - Properties"],"summary":"Update Property Group","description":"Update a property group by name (partial update).\n\nUpdates the label and/or displayOrder of a property group.\nOnly provided fields will be updated.\n\nRequires appropriate write scope based on object type.","operationId":"update_property_group_crm_v3_properties__objectType__groups__groupName__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type (companies, contacts, deals, etc.)","title":"Objecttype"},"description":"CRM object type (companies, contacts, deals, etc.)"},{"name":"groupName","in":"path","required":true,"schema":{"type":"string","description":"Internal property group name to update","title":"Groupname"},"description":"Internal property group name to update"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyGroupUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyGroupUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/properties/{objectType}":{"get":{"tags":["CRM - Properties"],"summary":"List Properties","description":"List all properties for the specified object type.\n\nReturns all existing properties with optional filtering by archived status\nand data sensitivity level.","operationId":"list_properties_crm_v3_properties__objectType__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type","title":"Objecttype"},"description":"CRM object type"},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","description":"Return only archived properties","default":false,"title":"Archived"},"description":"Return only archived properties"},{"name":"dataSensitivity","in":"query","required":false,"schema":{"type":"string","pattern":"^(non_sensitive|sensitive|highly_sensitive)$","description":"Filter by data sensitivity level","default":"non_sensitive","title":"Datasensitivity"},"description":"Filter by data sensitivity level"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated list of properties to return","title":"Properties"},"description":"Comma-separated list of properties to return"},{"name":"locale","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Locale for localized properties","title":"Locale"},"description":"Locale for localized properties"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["CRM - Properties"],"summary":"Create Property","description":"Create a new property for the specified object type.\n\nProperties store information on CRM records and must be assigned to a property group.\nEach property has a type (data type) and fieldType (UI representation).\n\nRequired fields:\n- groupName: Property group to organize the property\n- name: Internal property name (lowercase, alphanumeric, underscores)\n- label: Display label in HubSpot UI\n- type: Property type (bool, enumeration, date, datetime, string, number, etc.)\n- fieldType: Field type for UI (text, select, checkbox, date, etc.)\n\nRequires appropriate write scope based on object type.","operationId":"create_property_crm_v3_properties__objectType__post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type (companies, contacts, deals, etc.)","title":"Objecttype"},"description":"CRM object type (companies, contacts, deals, etc.)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyCreateRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyGetResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/properties/{objectType}/{propertyName}":{"get":{"tags":["CRM - Properties"],"summary":"Get Property","description":"Read a single property identified by propertyName.\n\nReturns the property with all metadata including options,\nmodification metadata, and timestamps.","operationId":"get_property_crm_v3_properties__objectType___propertyName__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type","title":"Objecttype"},"description":"CRM object type"},{"name":"propertyName","in":"path","required":true,"schema":{"type":"string","description":"Internal property name","title":"Propertyname"},"description":"Internal property name"},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","description":"Return only archived property","default":false,"title":"Archived"},"description":"Return only archived property"},{"name":"dataSensitivity","in":"query","required":false,"schema":{"type":"string","pattern":"^(non_sensitive|sensitive|highly_sensitive)$","description":"Filter by data sensitivity level","default":"non_sensitive","title":"Datasensitivity"},"description":"Filter by data sensitivity level"},{"name":"locale","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Locale for localized property","title":"Locale"},"description":"Locale for localized property"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Comma-separated list of property fields to return","title":"Properties"},"description":"Comma-separated list of property fields to return"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CRM - Properties"],"summary":"Update Property","description":"Update a property with partial updates.\n\nOnly provided fields will be updated. At least one field must be provided.\n\nAll fields including type and fieldType can be updated.\nNote: hasUniqueValue cannot be changed after creation.","operationId":"update_property_crm_v3_properties__objectType___propertyName__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type","title":"Objecttype"},"description":"CRM object type"},{"name":"propertyName","in":"path","required":true,"schema":{"type":"string","description":"Internal property name","title":"Propertyname"},"description":"Internal property name"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdateRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyUpdateResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["CRM - Properties"],"summary":"Archive a property","description":"Archive a property by moving it to the recycling bin. Returns 204 No Content.","operationId":"archive_property_crm_v3_properties__objectType___propertyName__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type","title":"Objecttype"},"description":"CRM object type"},{"name":"propertyName","in":"path","required":true,"schema":{"type":"string","description":"Internal property name","title":"Propertyname"},"description":"Internal property name"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Property archived successfully"},"403":{"description":"Insufficient permissions"},"404":{"description":"Property not found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/properties/{objectType}/batch/create":{"post":{"tags":["CRM - Properties"],"summary":"Batch create properties","description":"Create multiple properties in a single request. Partial failures are allowed - some properties can succeed while others fail.","operationId":"batch_create_properties_crm_v3_properties__objectType__batch_create_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type","title":"Objecttype"},"description":"CRM object type"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreatePropertiesRequest"}}}},"responses":{"200":{"description":"Batch operation completed (check numErrors for failures)","content":{"application/json":{"schema":{}}}},"403":{"description":"Insufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/properties/{objectType}/batch/read":{"post":{"tags":["CRM - Properties"],"summary":"Batch read properties","description":"Read a provided list of properties by their names. Returns partial results if some properties are not found.","operationId":"batch_read_properties_crm_v3_properties__objectType__batch_read_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type","title":"Objecttype"},"description":"CRM object type"},{"name":"locale","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Locale for localized properties","title":"Locale"},"description":"Locale for localized properties"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadPropertiesRequest"}}}},"responses":{"200":{"description":"Batch operation completed (check numErrors for failures)","content":{"application/json":{"schema":{}}}},"403":{"description":"Insufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/properties/{objectType}/batch/archive":{"post":{"tags":["CRM - Properties"],"summary":"Archive a batch of properties","description":"Archive multiple properties. Returns 204 No Content regardless of initial state (active, already archived, non-existent).","operationId":"batch_archive_properties_crm_v3_properties__objectType__batch_archive_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"CRM object type","title":"Objecttype"},"description":"CRM object type"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchArchivePropertiesRequest"}}}},"responses":{"204":{"description":"Properties archived successfully (or already archived/non-existent)"},"403":{"description":"Insufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/property-validations/{objectTypeId}":{"get":{"tags":["Property Validations"],"summary":"Read all property validation rules for an object","description":"Read all properties with validation rules for a given object. Returns properties that have validation rules configured.","operationId":"get_property_validations_crm_v3_property_validations__objectTypeId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectTypeId","in":"path","required":true,"schema":{"type":"string","description":"Object type ID (e.g., 'contacts', 'companies', custom object ID)","title":"Objecttypeid"},"description":"Object type ID (e.g., 'contacts', 'companies', custom object ID)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved property validations","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyValidationsResponse"}}}},"400":{"description":"Bad request - invalid object type"},"403":{"description":"Insufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/property-validations/{objectTypeId}/{propertyName}":{"get":{"tags":["Property Validations"],"summary":"Read validation rules for a property","description":"Read a property's validation rules identified by objectTypeId and propertyName.","operationId":"get_property_validation_rules_crm_v3_property_validations__objectTypeId___propertyName__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectTypeId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the object type to which the property belongs","title":"Objecttypeid"},"description":"The ID of the object type to which the property belongs"},{"name":"propertyName","in":"path","required":true,"schema":{"type":"string","description":"The name of the property whose validation rules are being retrieved","title":"Propertyname"},"description":"The name of the property whose validation rules are being retrieved"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved validation rules for property (returns empty array if no rules configured)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyRulesResponse"}}}},"400":{"description":"Bad request - invalid object type"},"403":{"description":"Insufficient permissions"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/property-validations/{objectTypeId}/{propertyName}/rule-type/{ruleType}":{"get":{"tags":["Property Validations"],"summary":"Retrieve a validation rule for a specific property and rule type","description":"Retrieve a specific validation rule for a property identified by its name and rule type, providing details on how property values should be formatted.","operationId":"get_property_validation_rule_crm_v3_property_validations__objectTypeId___propertyName__rule_type__ruleType__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectTypeId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the object type to which the property belongs","title":"Objecttypeid"},"description":"The ID of the object type to which the property belongs"},{"name":"propertyName","in":"path","required":true,"schema":{"type":"string","description":"The name of the property whose validation rule is being retrieved","title":"Propertyname"},"description":"The name of the property whose validation rule is being retrieved"},{"name":"ruleType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RuleTypeEnum","description":"The type of validation rule (e.g., FORMAT, ALPHANUMERIC, MAX_LENGTH)"},"description":"The type of validation rule (e.g., FORMAT, ALPHANUMERIC, MAX_LENGTH)"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved validation rule","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PropertyValidationRuleResponse"}}}},"400":{"description":"Bad request - invalid object type"},"403":{"description":"Insufficient permissions"},"404":{"description":"Validation rule not found for property"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["Property Validations"],"summary":"Update a validation rule for a specific property and rule type","description":"Update a specific validation rule for a property identified by its name and rule type, allowing customization of property value constraints.","operationId":"update_property_validation_rule_crm_v3_property_validations__objectTypeId___propertyName__rule_type__ruleType__put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectTypeId","in":"path","required":true,"schema":{"type":"string","description":"The ID of the object type to which the property belongs","title":"Objecttypeid"},"description":"The ID of the object type to which the property belongs"},{"name":"propertyName","in":"path","required":true,"schema":{"type":"string","description":"The name of the property for which the validation rule is being updated","title":"Propertyname"},"description":"The name of the property for which the validation rule is being updated"},{"name":"ruleType","in":"path","required":true,"schema":{"$ref":"#/components/schemas/RuleTypeEnum","description":"The type of validation rule being updated"},"description":"The type of validation rule being updated"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdatePropertyValidationRuleRequest"}}}},"responses":{"204":{"description":"Validation rule updated successfully"},"400":{"description":"Bad request - malformed input, unknown object type, or property not found"},"403":{"description":"Insufficient permissions"},"422":{"description":"Validation error - invalid rule arguments for the specified rule type"}}}},"/account-info/v3/details":{"get":{"tags":["Accounts"],"summary":"Retrieve Account Details","description":"Retrieve account details such as the account type, time zone, currencies, and data hosting location.\n\nThis endpoint follows the HubSpot Account Info v3 API specification:\n- Returns account information from the first account_info record\n- Requires oauth scope","operationId":"retrieve_account_details_account_info_v3_details_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountDetailsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/companies":{"post":{"tags":["CRM - Companies"],"summary":"Create Company","description":"Create a company with the given properties and return a copy of the object, including the ID.","operationId":"create_company_crm_v3_objects_companies_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyCreateRequest"}}}},"responses":{"201":{"description":"Company created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyEntity"}}}},"400":{"description":"Bad request - invalid associations or malformed data"},"403":{"description":"Forbidden - requires one of: crm.objects.companies.read, crm.objects.companies.write"},"409":{"description":"Conflict - company with this domain already exists"},"422":{"description":"Validation error - property validation failed or invalid input"}}},"get":{"tags":["CRM - Companies"],"summary":"List Companies","description":"Retrieve all companies with pagination and filtering.\n\nRequires crm.objects.companies.read scope.\nSupports pagination, property filtering, association retrieval, and archived status filtering.","operationId":"list_companies_crm_v3_objects_companies_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Companies retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCompaniesResponse"}}}},"403":{"description":"Forbidden - requires crm.objects.companies.read scope"},"422":{"description":"Validation error - invalid query parameters"}}}},"/crm/v3/objects/companies/{companyId}":{"get":{"tags":["CRM - Companies"],"summary":"Get Company","description":"Retrieve a single company by ID or unique property.\n\nTo identify a company by ID, include the ID in the request URL path.\nTo identify a company by their domain or other unique property, include the\nproperty value in the request URL path, and add the idProperty query parameter.\n\nRequires crm.objects.companies.read scope.","operationId":"get_company_crm_v3_objects_companies__companyId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Company ID or unique property value","title":"Companyid"},"description":"Company ID or unique property value"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to identify company by (e.g., 'domain')","title":"Idproperty"},"description":"Property name to identify company by (e.g., 'domain')"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Company retrieved successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetCompanyResponse"}}}},"403":{"description":"Forbidden - requires crm.objects.companies.read scope"},"404":{"description":"Not found - company does not exist"},"422":{"description":"Validation error - invalid companyId"}}},"patch":{"tags":["CRM - Companies"],"summary":"Update Company","description":"Update an existing company by ID or unique property.\n\nTo identify a company by ID, include the ID in the request URL path.\nTo identify a company by their domain or other unique property, include the\nproperty value in the request URL path, and add the idProperty query parameter.\n\nProperties provided will be overwritten. Properties values can be cleared by\npassing an empty string. Read-only and non-existent properties will result in an error.\n\nRequires crm.objects.companies.write scope.","operationId":"update_company_crm_v3_objects_companies__companyId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Company ID or unique property value","title":"Companyid"},"description":"Company ID or unique property value"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to identify company by (e.g., 'domain')","title":"Idproperty"},"description":"Property name to identify company by (e.g., 'domain')"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyUpdateRequest"}}}},"responses":{"200":{"description":"Company updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyEntity"}}}},"400":{"description":"Bad request - invalid properties or read-only property modification"},"403":{"description":"Forbidden - requires crm.objects.companies.write scope"},"404":{"description":"Not found - company does not exist"},"422":{"description":"Validation error - property validation failed"}}},"delete":{"tags":["CRM - Companies"],"summary":"Archive Company","description":"Archive a company by ID.\n\nDeleted companies can be restored within 90 days of deletion.\nThis sets the company's archived status to True.","operationId":"archive_company_crm_v3_objects_companies__companyId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"companyId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Company ID to archive","title":"Companyid"},"description":"Company ID to archive"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Company archived successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ArchiveCompanyResponse"}}}},"403":{"description":"Forbidden - missing required scope crm.objects.companies.write"},"404":{"description":"Not found - company does not exist"},"422":{"description":"Validation error - invalid companyId"}}}},"/crm/v3/objects/companies/merge":{"post":{"tags":["CRM - Companies"],"summary":"Merge Companies","description":"Merge two company records.\n\nThe company specified in objectIdToMerge will be merged into the primaryObjectId.\nProperties from the merged company will be added to the primary company, with the\nprimary company's properties taking precedence on conflicts.\nAssociations from the merged company will be transferred to the primary company.\nThe merged company will be archived after the merge.\n\nRequires crm.objects.companies.write scope.","operationId":"merge_companies_crm_v3_objects_companies_merge_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyMergeRequest"}}}},"responses":{"200":{"description":"Companies merged successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CompanyEntity"}}}},"400":{"description":"Bad request - cannot merge company with itself"},"403":{"description":"Forbidden - missing required scope crm.objects.companies.write"},"404":{"description":"Not found - one or both companies do not exist"},"422":{"description":"Validation error - invalid company IDs"}}}},"/crm/v3/objects/contacts":{"post":{"tags":["CRM - Contacts"],"summary":"Create Contact","description":"Create a new contact record.\n\nRequires a valid Bearer token with scope crm.objects.contacts.write.\nReturns HubSpot-compliant response format with createdResourceId and entity.","operationId":"create_contact_crm_v3_objects_contacts_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactCreateRequest"}}}},"responses":{"201":{"description":"Contact created successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactEntity"}}}},"400":{"description":"Bad request - invalid associations or malformed data"},"403":{"description":"Forbidden - missing required scope crm.objects.contacts.write"},"422":{"description":"Validation error - property validation failed or invalid input"}}},"get":{"tags":["CRM - Contacts"],"summary":"List Contacts","description":"Retrieve all contacts with pagination and filtering.\nRequires crm.objects.contacts.read scope.","operationId":"list_contacts_crm_v3_objects_contacts_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":10,"title":"Limit"}},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListContactsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/contacts/{contactId}":{"get":{"tags":["CRM - Contacts"],"summary":"Get Contact","description":"Retrieve a single contact by ID or unique property value.\n\nYou can retrieve by contactId (default) or by a unique property value\nby specifying the idProperty parameter (e.g., idProperty=\"email\").\n\nRequires crm.objects.contacts.read scope only.","operationId":"get_contact_crm_v3_objects_contacts__contactId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string","title":"Contactid"}},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Properties"}},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Propertieswithhistory"}},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"title":"Associations"}},{"name":"archived","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Archived"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successfully retrieved contact","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetContactResponse"}}}},"403":{"description":"Missing authorization or crm.objects.contacts.read scope (write scope is not sufficient)"},"404":{"description":"Contact not found or archived status mismatch"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["CRM - Contacts"],"summary":"Update Contact","description":"Update an existing contact by ID or email/unique property.\n\nTo identify a contact by ID, include the ID in the request URL path.\nTo identify a contact by their email or other unique property, include the\nemail/property value in the request URL path, and add the idProperty query parameter.\n\nUpdates contact properties. Provided property values will be overwritten.\nProperties values can be cleared by passing an empty string.\nRead-only and non-existent properties will result in an error.\n\nRequires crm.objects.contacts.write scope.","operationId":"update_contact_crm_v3_objects_contacts__contactId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string","title":"Contactid"}},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to identify contact by (e.g., 'email')","title":"Idproperty"},"description":"Property name to identify contact by (e.g., 'email')"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactUpdateRequest"}}}},"responses":{"200":{"description":"Contact updated successfully","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactEntity"}}}},"400":{"description":"Bad request - invalid properties or read-only property modification"},"403":{"description":"Forbidden - missing required scope crm.objects.contacts.write"},"404":{"description":"Not found - contact does not exist"},"422":{"description":"Validation error - property validation failed"}}},"delete":{"tags":["CRM - Contacts"],"summary":"Delete Contact","description":"Archive a contact by ID.\n\nDeleted contacts can be restored within 90 days of deletion.\nThis sets the contact's archived status to True.","operationId":"delete_contact_crm_v3_objects_contacts__contactId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"Contact ID to archive","title":"Contactid"},"description":"Contact ID to archive"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Contact archived successfully"},"403":{"description":"Forbidden - missing required scope crm.objects.contacts.write"},"404":{"description":"Not found - contact does not exist"},"409":{"description":"Conflict - contact is already archived"},"422":{"description":"Validation error - invalid contactId"}}}},"/crm/v3/objects/contacts/merge":{"post":{"tags":["CRM - Contacts"],"summary":"Merge Contacts","description":"Merge two contact records into one.\n\nMerges objectIdToMerge into primaryObjectId. The primary contact's\nproperties are generally prioritized. Activities and associations\nfrom both contacts are combined.","operationId":"merge_contacts_crm_v3_objects_contacts_merge_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactMergeRequest"}}}},"responses":{"200":{"description":"Contacts successfully merged","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactEntity"}}}},"400":{"description":"Bad request - cannot merge contact with itself"},"403":{"description":"Forbidden - missing required scope crm.objects.contacts.write"},"404":{"description":"Not found - primary or secondary contact does not exist"},"409":{"description":"Conflict - contact is archived or merge limit reached (250)"},"422":{"description":"Validation error - invalid objectIdToMerge or primaryObjectId"}}}},"/crm/v3/objects/contacts/gdpr-delete":{"post":{"tags":["CRM - Contacts"],"summary":"Gdpr Delete Contact","description":"Permanently delete a contact (GDPR-compliant).\n\nPermanently deletes a contact and all associated content to follow GDPR.\nUse optional property idProperty set to 'email' to identify contact by email address.\nIf email address is not found, the email address will be added to a blocklist.","operationId":"gdpr_delete_contact_crm_v3_objects_contacts_gdpr_delete_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ContactGdprDeleteRequest"}}}},"responses":{"204":{"description":"Contact permanently deleted successfully"},"403":{"description":"Forbidden - missing required scope crm.objects.contacts.write"},"404":{"description":"Not found - contact does not exist"},"422":{"description":"Validation error - invalid objectId"}}}},"/crm/v3/objects/invoices":{"get":{"tags":["Invoices"],"summary":"List Invoices","description":"Read a page of invoices matching HubSpot CRM invoices API contract.\n\nSupports:\n- Cursor-based pagination via `limit` and `after`\n- Filtering on archived status\n- Property and association selection mirroring HubSpot parameters","operationId":"list_invoices_crm_v3_objects_invoices_get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"Maximum results per page","default":10,"title":"Limit"},"description":"Maximum results per page"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Paging cursor token","title":"After"},"description":"Paging cursor token"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceListResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["Invoices"],"summary":"Create Invoice","description":"Create a invoice with the given properties and return a copy of the object, including the ID.\n\nDocumentation and examples for creating standard invoices is provided.","operationId":"create_invoice_crm_v3_objects_invoices_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateInvoiceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/objects/invoices/{invoiceId}":{"get":{"tags":["Invoices"],"summary":"Read Invoice","description":"Read an Object identified by {invoiceId}.\n\n{invoiceId} refers to the internal object ID by default, or optionally any unique property value as specified by the idProperty query param.\nControl what is returned via the properties query param.","operationId":"read_invoice_crm_v3_objects_invoices__invoiceId__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","description":"Invoice ID","title":"Invoiceid"},"description":"Invoice ID"},{"name":"properties","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties to return","title":"Properties"},"description":"Properties to return"},{"name":"propertiesWithHistory","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Properties with history","title":"Propertieswithhistory"},"description":"Properties with history"},{"name":"associations","in":"query","required":false,"schema":{"anyOf":[{"type":"array","items":{"type":"string"}},{"type":"null"}],"description":"Associated object types","title":"Associations"},"description":"Associated object types"},{"name":"archived","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"Return archived only","default":false,"title":"Archived"},"description":"Return archived only"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The name of a property whose values are unique for this object","title":"Idproperty"},"description":"The name of a property whose values are unique for this object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"patch":{"tags":["Invoices"],"summary":"Update Invoice","description":"Update an invoice with partial property updates.","operationId":"update_invoice_crm_v3_objects_invoices__invoiceId__patch","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","description":"Invoice ID","title":"Invoiceid"},"description":"Invoice ID"},{"name":"idProperty","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Property name to use for lookup instead of ID","title":"Idproperty"},"description":"Property name to use for lookup instead of ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateInvoiceRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/InvoiceResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["Invoices"],"summary":"Archive Invoice","description":"Archive an invoice (moves to recycling bin).","operationId":"archive_invoice_crm_v3_objects_invoices__invoiceId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"invoiceId","in":"path","required":true,"schema":{"type":"string","description":"Invoice ID","title":"Invoiceid"},"description":"Invoice ID"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}":{"get":{"tags":["CRM Associations"],"summary":"List Associations","description":"List all associations of an object by object type. Limit 500 per call.\n\nThis endpoint follows the HubSpot CRM Associations v4 API specification:\n- Returns associations between a source object and target object type\n- Supports pagination via `after` cursor and `limit` parameter\n- Returns association types with category, typeId, and label information","operationId":"list_associations_crm_v4_objects__objectType___objectId__associations__toObjectType__get","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the source object in the association","title":"Objecttype"},"description":"Specifies the type of the source object in the association"},{"name":"objectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The unique identifier for the source object whose associations are being retrieved","title":"Objectid"},"description":"The unique identifier for the source object whose associations are being retrieved"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the target object in the association","title":"Toobjecttype"},"description":"Specifies the type of the target object in the association"},{"name":"after","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The paging cursor token of the last successfully read resource","title":"After"},"description":"The paging cursor token of the last successfully read resource"},{"name":"limit","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"description":"The maximum number of results to display per page","default":500,"title":"Limit"},"description":"The maximum number of results to display per page"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListAssociationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create":{"post":{"tags":["CRM Associations"],"summary":"Create Association","description":"Create multiple associations between specified from and to object types in a single batch request.\n\nThis endpoint follows the HubSpot CRM Associations v3 batch/create API specification:\n- POST /crm/v3/associations/{fromObjectType}/{toObjectType}/batch/create\n- Accepts inputs array of {from.id, to.id, type} objects\n- Returns 201 with batch response including completedAt, results, startedAt, status","operationId":"create_association_crm_v3_associations__fromObjectType___toObjectType__batch_create_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"fromObjectType","in":"path","required":true,"schema":{"type":"string","description":"The type of the source object in the association","title":"Fromobjecttype"},"description":"The type of the source object in the association"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"The type of the target object in the association","title":"Toobjecttype"},"description":"The type of the target object in the association"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssociationBatchRequest","description":"Batch create request with array of {from.id, to.id, type} inputs"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssociationBatchResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v4/objects/{fromObjectType}/{fromObjectId}/associations/default/{toObjectType}/{toObjectId}":{"put":{"tags":["CRM Associations"],"summary":"Create Default Association","description":"Create the default (most generic) association type between two object types.\n\nThis endpoint follows the HubSpot CRM Associations v4 API specification:\n- Creates bidirectional associations automatically (forward and reverse directions)\n- Uses default (unlabeled) association typeIds automatically\n- Requires one of the following write scopes (any valid CRM write scope)\n- Returns batch response format with both associations in results array","operationId":"create_default_association_crm_v4_objects__fromObjectType___fromObjectId__associations_default__toObjectType___toObjectId__put","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"fromObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the source object in the association to be created","title":"Fromobjecttype"},"description":"Specifies the type of the source object in the association to be created"},{"name":"fromObjectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The unique identifier for the source object in the association to be created","title":"Fromobjectid"},"description":"The unique identifier for the source object in the association to be created"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the target object in the association to be created","title":"Toobjecttype"},"description":"Specifies the type of the target object in the association to be created"},{"name":"toObjectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The unique identifier for the target object in the association to be created","title":"Toobjectid"},"description":"The unique identifier for the target object in the association to be created"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateDefaultAssociationResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/associations/v4/{fromObjectType}/{toObjectType}/labels":{"post":{"tags":["CRM Associations"],"summary":"Create Association Label","description":"Create a user-defined association label between two object types.\n\nThis endpoint follows the HubSpot CRM Associations v4 API specification:\n- Creates a new user-defined association type with a label\n- Generates a unique typeId for the association type\n- Requires one of the following write scopes (any valid CRM write scope)\n- Returns the created association type with typeId","operationId":"create_association_label_crm_associations_v4__fromObjectType___toObjectType__labels_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"fromObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the source object in the association","title":"Fromobjecttype"},"description":"Specifies the type of the source object in the association"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the target object in the association","title":"Toobjecttype"},"description":"Specifies the type of the target object in the association"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssociationLabelRequest","description":"Association label definition with name, label, and optional inverseLabel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateAssociationLabelResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v4/objects/{objectType}/{objectId}/associations/{toObjectType}/{toObjectId}":{"delete":{"tags":["CRM Associations"],"summary":"Delete Association","description":"Delete all associations between two records.\n\nThis endpoint follows the HubSpot CRM Associations v4 API specification:\n- Deletes all associations between a source object and target object\n- Requires one of the following write scopes (any valid CRM write scope)\n- Returns 204 No Content on success","operationId":"delete_association_crm_v4_objects__objectType___objectId__associations__toObjectType___toObjectId__delete","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"objectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the source object in the association to be deleted","title":"Objecttype"},"description":"Specifies the type of the source object in the association to be deleted"},{"name":"objectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The unique identifier for the source object in the association to be deleted","title":"Objectid"},"description":"The unique identifier for the source object in the association to be deleted"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the target object in the association to be deleted","title":"Toobjecttype"},"description":"Specifies the type of the target object in the association to be deleted"},{"name":"toObjectId","in":"path","required":true,"schema":{"type":"string","minLength":1,"description":"The unique identifier for the target object in the association to be deleted","title":"Toobjectid"},"description":"The unique identifier for the target object in the association to be deleted"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"responses":{"204":{"description":"Successful Response"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/read":{"post":{"tags":["CRM Associations"],"summary":"Batch Read Associations","description":"Batch read associations for objects to specific object type.\n\nThis endpoint follows the HubSpot CRM Associations v4 API specification:\n- Reads associations for multiple objects in a single request\n- The 'after' field in a returned paging object can be added alongside the 'id'\n  to retrieve the next page of associations from that objectId\n- The 'link' field is deprecated and should be ignored\n- Note: The 'paging' field will only be present if there are more pages and absent otherwise\n- Requires one of the following read scopes (any valid CRM read scope)","operationId":"batch_read_associations_crm_v4_associations__fromObjectType___toObjectType__batch_read_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"fromObjectType","in":"path","required":true,"schema":{"type":"string","description":"The type of the from Object","title":"Fromobjecttype"},"description":"The type of the from Object"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"The type of the to Object","title":"Toobjecttype"},"description":"The type of the to Object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadAssociationsRequest","description":"Batch read associations request with inputs array"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchReadAssociationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/create":{"post":{"tags":["CRM Associations"],"summary":"Batch Create Associations","description":"Batch create associations for objects.\n\nThis endpoint follows the HubSpot CRM Associations v4 API specification:\n- Creates associations between multiple source and target object pairs\n- Accepts array of inputs with types, from.id, and to.id\n- Requires one of the following write scopes (any valid CRM write scope)\n- Returns batch response with results and errors","operationId":"batch_create_associations_crm_v4_associations__fromObjectType___toObjectType__batch_create_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"fromObjectType","in":"path","required":true,"schema":{"type":"string","description":"The type of the from Object","title":"Fromobjecttype"},"description":"The type of the from Object"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"The type of the to Object","title":"Toobjecttype"},"description":"The type of the to Object"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateAssociationsRequest","description":"Batch create associations request with inputs array"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateAssociationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/crm/v4/associations/{fromObjectType}/{toObjectType}/batch/associate/default":{"post":{"tags":["CRM Associations"],"summary":"Batch Create Default Associations","description":"Batch create default associations for objects.\n\nThis endpoint follows the HubSpot CRM Associations v4 API specification:\n- Creates the default (most generic) association type between multiple source and target object pairs\n- Accepts array of inputs with from.id and to.id\n- Requires one of the following write scopes (any valid CRM write scope)\n- Returns batch response with results and errors","operationId":"batch_create_default_associations_crm_v4_associations__fromObjectType___toObjectType__batch_associate_default_post","security":[{"HTTPBearerHubSpot":[]}],"parameters":[{"name":"fromObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the source object in the association","title":"Fromobjecttype"},"description":"Specifies the type of the source object in the association"},{"name":"toObjectType","in":"path","required":true,"schema":{"type":"string","description":"Specifies the type of the target object in the association","title":"Toobjecttype"},"description":"Specifies the type of the target object in the association"},{"name":"x-database-id","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Database ID for multi-tenant support (optional)","title":"X-Database-Id"},"description":"Database ID for multi-tenant support (optional)"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateDefaultAssociationsRequest","description":"Batch create default associations request with inputs array"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BatchCreateDefaultAssociationsResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/":{"get":{"summary":"Root","description":"Root endpoint - returns OpenAPI schema","operationId":"root__get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/health":{"get":{"summary":"Health Check","description":"Health check endpoint","operationId":"health_check_health_get","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/reset":{"post":{"summary":"Reset With Database Refresh","operationId":"reset_with_database_refresh_reset_post","requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Body"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Reset With Database Refresh Reset Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/step":{"post":{"summary":"Step With Headers","operationId":"step_with_headers_step_post","requestBody":{"content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Body"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Step With Headers Step Post"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/state":{"get":{"summary":"Get State","operationId":"get_state_state_get","parameters":[{"name":"verify_queries","in":"query","required":false,"schema":{"type":"array","items":{"type":"string"},"default":[],"title":"Verify Queries"}},{"name":"include_tools_list","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Include Tools List"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Get State State Get"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"AbStatus":{"type":"string","enum":["master","variant","loser_variant","mab_master","mab_variant","automated_master","automated_variant","automated_loser_variant"],"title":"AbStatus","description":"Valid AB status values"},"AccessTokenMetadataResponse":{"properties":{"token":{"type":"string","title":"Token","description":"Access token"},"user":{"type":"string","title":"User","description":"User email"},"hub_domain":{"type":"string","title":"Hub Domain","description":"Hub domain"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"OAuth scopes"},"signed_access_token":{"$ref":"#/components/schemas/SignedAccessToken","description":"Signed token metadata"},"portal_id":{"type":"integer","title":"Portal Id","description":"Portal ID (tenant identifier)"},"app_id":{"type":"integer","title":"App Id","description":"Application ID"},"expires_in":{"type":"integer","title":"Expires In","description":"Token expiration time in seconds"},"user_id":{"type":"integer","title":"User Id","description":"User ID"},"token_type":{"type":"string","title":"Token Type","description":"Token type","default":"access"},"is_private_distribution":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Private Distribution","description":"Whether token is for private distribution"}},"type":"object","required":["token","user","hub_domain","scopes","signed_access_token","portal_id","app_id","expires_in","user_id"],"title":"AccessTokenMetadataResponse","description":"Access token metadata response schema matching HubSpot format"},"AccountDetailsResponse":{"properties":{"accountType":{"$ref":"#/components/schemas/AccountType","description":"Account type"},"additionalCurrencies":{"items":{"type":"string"},"type":"array","title":"Additionalcurrencies","description":"Additional currencies"},"companyCurrency":{"type":"string","title":"Companycurrency","description":"Company currency"},"dataHostingLocation":{"type":"string","title":"Datahostinglocation","description":"Data hosting location"},"portalId":{"type":"integer","title":"Portalid","description":"Portal ID"},"timeZone":{"type":"string","title":"Timezone","description":"Time zone"},"uiDomain":{"type":"string","title":"Uidomain","description":"UI domain"},"utcOffset":{"type":"string","title":"Utcoffset","description":"UTC offset"},"utcOffsetMilliseconds":{"type":"integer","title":"Utcoffsetmilliseconds","description":"UTC offset in milliseconds"}},"type":"object","required":["accountType","additionalCurrencies","companyCurrency","dataHostingLocation","portalId","timeZone","uiDomain","utcOffset","utcOffsetMilliseconds"],"title":"AccountDetailsResponse","description":"Response schema for account details matching HubSpot format"},"AccountType":{"type":"string","enum":["APP_DEVELOPER","DEVELOPER_TEST","SANDBOX","STANDARD"],"title":"AccountType","description":"Account type enum matching HubSpot API."},"AddCurrencyWithAutoUpdatesRequest":{"properties":{"currencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"Currency code"}},"type":"object","required":["currencyCode"],"title":"AddCurrencyWithAutoUpdatesRequest","description":"Request schema for adding currency with automatic updates matching HubSpot format"},"ArchiveCompanyResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Confirmation that the company was archived"}},"type":"object","required":["message"],"title":"ArchiveCompanyResponse","description":"Response schema for archiving a company"},"ArchiveLeadResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Confirmation that the lead was deleted"}},"type":"object","required":["message"],"title":"ArchiveLeadResponse","description":"Response schema for archiving a lead"},"ArchiveProductResponse":{"properties":{"message":{"type":"string","title":"Message","description":"Confirmation that the product was deleted"}},"type":"object","required":["message"],"title":"ArchiveProductResponse","description":"Response schema for archiving a product"},"AssociationCategory-Output":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED"],"title":"AssociationCategory","description":"Association category enum matching HubSpot v4 API."},"AssociationInput":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__AssociationCategory","description":"The category of the association, such as 'HUBSPOT_DEFINED'"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"The ID representing the specific type of association"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationInput","description":"Input schema for creating an association matching HubSpot v4 API format."},"AssociationObjectId":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object"}},"type":"object","required":["id"],"title":"AssociationObjectId","description":"Object ID schema for from/to objects in default association response."},"AssociationPaging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/AssociationPagingNext"},{"type":"null"}]}},"type":"object","title":"AssociationPaging","description":"Paging for associations"},"AssociationPagingNext":{"properties":{"after":{"type":"string","title":"After","description":"A paging cursor token for retrieving subsequent pages"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"A URL that can be used to retrieve the next page results"}},"type":"object","required":["after"],"title":"AssociationPagingNext","description":"Paging next for associations"},"AssociationResultWithPaging-Input":{"properties":{"associationTypes":{"items":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__AssociationType"},"type":"array","title":"Associationtypes","description":"Array of association types for this association"},"toObjectId":{"type":"string","title":"Toobjectid","description":"The unique identifier for the target object in the association"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_associations__schema__Paging"},{"type":"null"}],"description":"Pagination information for this association result"}},"type":"object","required":["associationTypes","toObjectId"],"title":"AssociationResultWithPaging","description":"Association result schema with optional paging for batch read response."},"AssociationResultWithPaging-Output":{"properties":{"associationTypes":{"items":{"$ref":"#/components/schemas/AssociationType-Output"},"type":"array","title":"Associationtypes","description":"Array of association types for this association"},"toObjectId":{"type":"string","title":"Toobjectid","description":"The unique identifier for the target object in the association"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_associations__schema__Paging"},{"type":"null"}],"description":"Pagination information for this association result"}},"type":"object","required":["associationTypes","toObjectId"],"title":"AssociationResultWithPaging","description":"Association result schema with optional paging for batch read response."},"AssociationSpec-Input":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__AssociationCategory","description":"The category of the association, such as 'HUBSPOT_DEFINED'"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"The ID representing the specific type of association"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationSpec","description":"Association specification schema for default association response."},"AssociationSpec-Output":{"properties":{"associationCategory":{"$ref":"#/components/schemas/AssociationCategory-Output","description":"The category of the association, such as 'HUBSPOT_DEFINED'"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"The ID representing the specific type of association"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationSpec","description":"Association specification schema for default association response."},"AssociationType-Output":{"properties":{"typeId":{"type":"integer","title":"Typeid","description":"The unique identifier for the type of association"},"category":{"type":"string","title":"Category","description":"The category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED)"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"A label describing the association between two objects"}},"type":"object","required":["typeId","category"],"title":"AssociationType","description":"Association type schema matching HubSpot v4 API format."},"AttachToLangGroupRequest":{"properties":{"languageGroupId":{"type":"string","title":"Languagegroupid","description":"The language group ID to attach to"}},"type":"object","required":["languageGroupId"],"title":"AttachToLangGroupRequest","description":"Attach to language group request schema"},"BatchArchiveCmsPostsRequest":{"properties":{"inputs":{"items":{"additionalProperties":{"type":"string"},"type":"object"},"type":"array","maxItems":100,"minItems":1,"title":"Inputs","description":"List of CMS post IDs to archive"}},"type":"object","required":["inputs"],"title":"BatchArchiveCmsPostsRequest","description":"Batch archive CMS posts request schema"},"BatchArchiveCmsPostsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BatchCmsPostResponse"},"type":"array","title":"Results","description":"List of batch archive results"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch operation completed"},"numErrors":{"type":"integer","title":"Numerrors","description":"Number of errors in the batch"},"requestedAt":{"type":"string","format":"date-time","title":"Requestedat","description":"The timestamp when the batch operation was requested"}},"type":"object","required":["results","completedAt","numErrors","requestedAt"],"title":"BatchArchiveCmsPostsResponse","description":"Batch archive CMS posts response schema"},"BatchArchivePropertiesRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchArchivePropertyInput"},"type":"array","minItems":1,"title":"Inputs","description":"Array of property names to archive"}},"type":"object","required":["inputs"],"title":"BatchArchivePropertiesRequest","description":"Request schema for batch archiving properties"},"BatchArchivePropertyInput":{"properties":{"name":{"type":"string","title":"Name","description":"Property name to archive"}},"type":"object","required":["name"],"title":"BatchArchivePropertyInput","description":"Input for a single property in batch archive"},"BatchCmsPostResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the CMS post"},"status":{"type":"string","title":"Status","description":"The status of the operation"},"result":{"anyOf":[{"$ref":"#/components/schemas/CmsPostResponse"},{"type":"null"}],"description":"The result if successful"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error","description":"The error message if failed"}},"type":"object","required":["id","status"],"title":"BatchCmsPostResponse","description":"Batch CMS post response schema"},"BatchCreateAssociationsError":{"properties":{"context":{"additionalProperties":true,"type":"object","title":"Context","description":"Additional context-specific information related to the error"},"links":{"additionalProperties":{"type":"string"},"type":"object","title":"Links","description":"URLs linking to documentation or resources associated with the error"},"category":{"type":"string","title":"Category","description":"The main category of the error"},"message":{"type":"string","title":"Message","description":"A human-readable string describing the error and possible remediation steps"},"errors":{"items":{"$ref":"#/components/schemas/BatchCreateAssociationsErrorDetail"},"type":"array","title":"Errors","description":"The detailed error objects"},"status":{"type":"string","title":"Status","description":"The HTTP status code associated with the error"},"subCategory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Subcategory","description":"A more specific error category within each main category"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"A unique ID for the error instance"}},"type":"object","required":["context","links","category","message","errors","status"],"title":"BatchCreateAssociationsError","description":"Error object for batch create associations matching HubSpot v4 API format."},"BatchCreateAssociationsErrorDetail":{"properties":{"message":{"type":"string","title":"Message","description":"A human readable message describing the error along with remediation steps where appropriate"},"subCategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"A specific category that contains more specific detail about the error"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The status code associated with the error detail"},"in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In","description":"The name of the field or parameter in which the error was found"},"context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context","description":"Context about the error condition"}},"type":"object","required":["message"],"title":"BatchCreateAssociationsErrorDetail","description":"Detailed error information for batch create associations matching HubSpot v4 API format."},"BatchCreateAssociationsInput":{"properties":{"types":{"items":{"$ref":"#/components/schemas/AssociationInput"},"type":"array","title":"Types","description":"Array of association type objects with category and typeId"},"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"$ref":"#/components/schemas/AssociationObjectId","description":"The target object in the association"}},"type":"object","required":["types","from","to"],"title":"BatchCreateAssociationsInput","description":"Input schema for batch create associations matching HubSpot v4 API format."},"BatchCreateAssociationsRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchCreateAssociationsInput"},"type":"array","minItems":1,"title":"Inputs","description":"Array of input objects with types, from.id, and to.id"}},"type":"object","required":["inputs"],"title":"BatchCreateAssociationsRequest","description":"Request schema for batch create associations matching HubSpot v4 API format."},"BatchCreateAssociationsResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch processing was completed, in ISO 8601 format"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"The timestamp when the batch processing began, in ISO 8601 format"},"results":{"items":{"$ref":"#/components/schemas/BatchCreateAssociationsResult"},"type":"array","title":"Results","description":"Array of batch create association results"},"status":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__BatchStatus","description":"The status of the batch processing request: PENDING, PROCESSING, CANCELED, or COMPLETE"},"numErrors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numerrors","description":"The number of errors encountered during the batch processing"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"The timestamp when the batch request was initially made, in ISO 8601 format"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"An object containing relevant links related to the batch request"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/BatchCreateAssociationsError"},"type":"array"},{"type":"null"}],"title":"Errors","description":"The detailed error objects"}},"type":"object","required":["completedAt","startedAt","results","status"],"title":"BatchCreateAssociationsResponse","description":"Response schema for batch create associations matching HubSpot v4 API format."},"BatchCreateAssociationsResult":{"properties":{"fromObjectTypeId":{"type":"string","title":"Fromobjecttypeid","description":"The type ID of the source object in the association"},"toObjectId":{"type":"string","title":"Toobjectid","description":"The ID of the target object in the association"},"toObjectTypeId":{"type":"string","title":"Toobjecttypeid","description":"The type ID of the target object in the association"},"fromObjectId":{"type":"string","title":"Fromobjectid","description":"The ID of the source object in the association"},"labels":{"items":{"type":"string"},"type":"array","title":"Labels","description":"An array of labels associated with the relationship between the objects"}},"type":"object","required":["fromObjectTypeId","toObjectId","toObjectTypeId","fromObjectId","labels"],"title":"BatchCreateAssociationsResult","description":"Result schema for batch create associations matching HubSpot v4 API format."},"BatchCreateBlogTagsInput":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the tag (required, must be unique)"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The URL slug of the tag (auto-generated from name if not provided)"},"language":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Language","description":"The ISO 639 language code"},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletedat","description":"Deleted at timestamp (ISO 8601)"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created","description":"Created timestamp (ISO 8601)"},"updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated","description":"Updated timestamp (ISO 8601)"},"translatedFromId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Translatedfromid","description":"ID of primary tag this was translated from"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Tag ID (optional, auto-generated if not provided)"}},"type":"object","title":"BatchCreateBlogTagsInput","description":"Input schema for batch creating blog tags - matches CreateBlogTagRequest pattern\nOnly 'name' is required. All other fields are optional.\nValidation errors are handled in the service to support batch error collection."},"BatchCreateBlogTagsRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchCreateBlogTagsInput"},"type":"array","minItems":1,"title":"Inputs","description":"List of tags to create"}},"type":"object","required":["inputs"],"title":"BatchCreateBlogTagsRequest","description":"Request schema for batch creating blog tags"},"BatchCreateBlogTagsResponse":{"properties":{"status":{"$ref":"#/components/schemas/app__modules__cms__cms_tags__schema__BatchStatus"},"results":{"items":{"$ref":"#/components/schemas/BlogTagResponse"},"type":"array","title":"Results","description":"List of created tags"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"Time of batch operation completion"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"Time of batch operation start"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"Time of batch operation request"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"Links associated with batch operation"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/BatchUpdateError"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors for failed creates"},"numErrors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numerrors","description":"Number of errors in the batch operation"}},"type":"object","required":["status","results","completedAt","startedAt"],"title":"BatchCreateBlogTagsResponse","description":"Response schema for batch creating blog tags"},"BatchCreateCmsPostsRequest":{"properties":{"inputs":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":100,"minItems":1,"title":"Inputs","description":"List of CMS posts to create"}},"type":"object","required":["inputs"],"title":"BatchCreateCmsPostsRequest","description":"Batch create CMS posts request schema"},"BatchCreateCmsPostsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BatchCmsPostResponse"},"type":"array","title":"Results","description":"List of batch create results"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch operation completed"},"numErrors":{"type":"integer","title":"Numerrors","description":"Number of errors in the batch"},"requestedAt":{"type":"string","format":"date-time","title":"Requestedat","description":"The timestamp when the batch operation was requested"}},"type":"object","required":["results","completedAt","numErrors","requestedAt"],"title":"BatchCreateCmsPostsResponse","description":"Batch create CMS posts response schema"},"BatchCreateDefaultAssociationsError":{"properties":{"context":{"additionalProperties":true,"type":"object","title":"Context","description":"Additional context-specific information related to the error"},"links":{"additionalProperties":{"type":"string"},"type":"object","title":"Links","description":"URLs linking to documentation or resources associated with the error"},"category":{"type":"string","title":"Category","description":"The main category of the error"},"message":{"type":"string","title":"Message","description":"A human-readable string describing the error and possible remediation steps"},"errors":{"items":{"$ref":"#/components/schemas/BatchCreateDefaultAssociationsErrorDetail"},"type":"array","title":"Errors","description":"The detailed error objects"},"status":{"type":"string","title":"Status","description":"The HTTP status code associated with the error"},"subCategory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Subcategory","description":"A more specific error category within each main category"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"A unique ID for the error instance"}},"type":"object","required":["context","links","category","message","errors","status"],"title":"BatchCreateDefaultAssociationsError","description":"Error object for batch create default associations matching HubSpot v4 API format."},"BatchCreateDefaultAssociationsErrorDetail":{"properties":{"message":{"type":"string","title":"Message","description":"A human readable message describing the error along with remediation steps where appropriate"},"subCategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"A specific category that contains more specific detail about the error"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The status code associated with the error detail"},"in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In","description":"The name of the field or parameter in which the error was found"},"context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context","description":"Context about the error condition"}},"type":"object","required":["message"],"title":"BatchCreateDefaultAssociationsErrorDetail","description":"Detailed error information for batch create default associations matching HubSpot v4 API format."},"BatchCreateDefaultAssociationsInput":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"$ref":"#/components/schemas/AssociationObjectId","description":"The target object in the association"}},"type":"object","required":["from","to"],"title":"BatchCreateDefaultAssociationsInput","description":"Input schema for batch create default associations matching HubSpot v4 API format."},"BatchCreateDefaultAssociationsRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchCreateDefaultAssociationsInput"},"type":"array","minItems":1,"title":"Inputs","description":"Array of input objects with from.id and to.id"}},"type":"object","required":["inputs"],"title":"BatchCreateDefaultAssociationsRequest","description":"Request schema for batch create default associations matching HubSpot v4 API format."},"BatchCreateDefaultAssociationsResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch process was completed, in ISO 8601 format"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"The timestamp when the batch process began execution, in ISO 8601 format"},"results":{"items":{"$ref":"#/components/schemas/BatchCreateDefaultAssociationsResult-Output"},"type":"array","title":"Results","description":"Array of batch create default association results"},"status":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__BatchStatus","description":"The status of the batch processing request: PENDING, PROCESSING, CANCELED, or COMPLETE"},"numErrors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numerrors","description":"The number of errors encountered during the batch processing"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"The timestamp when the batch process was initiated, in ISO 8601 format"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"An object containing relevant links related to the batch request"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/BatchCreateDefaultAssociationsError"},"type":"array"},{"type":"null"}],"title":"Errors","description":"The detailed error objects"}},"type":"object","required":["completedAt","startedAt","results","status"],"title":"BatchCreateDefaultAssociationsResponse","description":"Response schema for batch create default associations matching HubSpot v4 API format."},"BatchCreateDefaultAssociationsResult-Input":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"$ref":"#/components/schemas/AssociationObjectId","description":"The target object in the association"},"associationSpec":{"$ref":"#/components/schemas/AssociationSpec-Input","description":"Defines the type, direction, and details of the relationship between two CRM objects"},"status":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__BatchStatus","description":"The status of the batch processing request: PENDING, PROCESSING, CANCELED, or COMPLETE"}},"type":"object","required":["from","to","associationSpec","status"],"title":"BatchCreateDefaultAssociationsResult","description":"Result schema for batch create default associations matching HubSpot v4 API format."},"BatchCreateDefaultAssociationsResult-Output":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"$ref":"#/components/schemas/AssociationObjectId","description":"The target object in the association"},"associationSpec":{"$ref":"#/components/schemas/AssociationSpec-Output","description":"Defines the type, direction, and details of the relationship between two CRM objects"},"status":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__BatchStatus","description":"The status of the batch processing request: PENDING, PROCESSING, CANCELED, or COMPLETE"}},"type":"object","required":["from","to","associationSpec","status"],"title":"BatchCreateDefaultAssociationsResult","description":"Result schema for batch create default associations matching HubSpot v4 API format."},"BatchCreateExchangeRateRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/CreateExchangeRateRequest"},"type":"array","title":"Inputs","description":"List of exchange rates to create"}},"type":"object","required":["inputs"],"title":"BatchCreateExchangeRateRequest","description":"Request schema for batch creating exchange rates matching HubSpot format"},"BatchCreateExchangeRateResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"Completion timestamp in ISO format"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"Start timestamp in ISO format"},"results":{"items":{"$ref":"#/components/schemas/ExchangeRateResponse"},"type":"array","title":"Results","description":"List of created exchange rates"},"status":{"$ref":"#/components/schemas/StatusEnum","description":"Status of the batch operation"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"Request timestamp in ISO format"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"Links to the batch operation"}},"type":"object","required":["completedAt","startedAt","results","status"],"title":"BatchCreateExchangeRateResponse","description":"Response schema for batch creating exchange rates matching HubSpot format"},"BatchCreatePropertiesRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchPropertyInput"},"type":"array","minItems":1,"title":"Inputs","description":"Array of properties to create"}},"type":"object","required":["inputs"],"title":"BatchCreatePropertiesRequest","description":"Request schema for batch creating properties"},"BatchLanguageVariationRequest":{"properties":{"inputs":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":100,"minItems":1,"title":"Inputs","description":"List of language variations to process"}},"type":"object","required":["inputs"],"title":"BatchLanguageVariationRequest","description":"Batch language variation request schema"},"BatchLanguageVariationResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/MultiLanguageOperationResponse"},"type":"array","title":"Results","description":"List of batch operation results"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch operation completed"},"numErrors":{"type":"integer","title":"Numerrors","description":"Number of errors in the batch"},"requestedAt":{"type":"string","format":"date-time","title":"Requestedat","description":"The timestamp when the batch operation was requested"}},"type":"object","required":["results","completedAt","numErrors","requestedAt"],"title":"BatchLanguageVariationResponse","description":"Batch language variation response schema"},"BatchPropertyInput":{"properties":{"groupName":{"type":"string","title":"Groupname","description":"Property group name (must exist)"},"name":{"type":"string","title":"Name","description":"Internal property name (lowercase, alphanumeric, underscores)"},"label":{"type":"string","title":"Label","description":"Human-readable label for HubSpot UI"},"type":{"$ref":"#/components/schemas/PropertyTypeEnum","description":"Property type: bool, enumeration, date, datetime, string, number, phone_number"},"fieldType":{"$ref":"#/components/schemas/FieldTypeEnum","description":"Field type: booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Property description"},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"Display order (-1 for last position)","default":-1},"hidden":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hidden","description":"Whether property is hidden in UI","default":false},"formField":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Formfield","description":"Whether property appears in forms","default":true},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOptionSchema"},"type":"array"},{"type":"null"}],"title":"Options","description":"Options for enumeration/select/checkbox types"},"hasUniqueValue":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasuniquevalue","description":"Whether property is a unique identifier","default":false},"calculationFormula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculationformula","description":"Formula for calculation_equation fieldType"},"externalOptions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Externaloptions","description":"Whether options come from external source","default":false},"showCurrencySymbol":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showcurrencysymbol","description":"For number properties displaying currency"},"currencyPropertyName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currencypropertyname","description":"The property that stores the currency code for currency-formatted number properties"},"numberDisplayHint":{"anyOf":[{"$ref":"#/components/schemas/NumberDisplayHintEnum"},{"type":"null"}],"description":"Display hint for number fields: currency, duration, formatted, percentage, probability, unformatted"},"referencedObjectType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referencedobjecttype","description":"Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users"},"dataSensitivity":{"anyOf":[{"$ref":"#/components/schemas/DataSensitivityEnum"},{"type":"null"}],"description":"Data sensitivity level: non_sensitive, sensitive, highly_sensitive"}},"type":"object","required":["groupName","name","label","type","fieldType"],"title":"BatchPropertyInput","description":"Input for a single property in batch create\nInherits all fields from PropertyCreateRequest"},"BatchReadAssociationsError":{"properties":{"context":{"additionalProperties":true,"type":"object","title":"Context","description":"Additional context-specific information related to the error"},"links":{"additionalProperties":{"type":"string"},"type":"object","title":"Links","description":"URLs linking to documentation or resources associated with the error"},"category":{"type":"string","title":"Category","description":"The main category of the error"},"message":{"type":"string","title":"Message","description":"A human-readable string describing the error and possible remediation steps"},"errors":{"items":{"$ref":"#/components/schemas/BatchReadAssociationsErrorDetail"},"type":"array","title":"Errors","description":"The detailed error objects"},"status":{"type":"string","title":"Status","description":"The HTTP status code associated with the error"},"subCategory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Subcategory","description":"A more specific error category within each main category"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"A unique ID for the error instance"}},"type":"object","required":["context","links","category","message","errors","status"],"title":"BatchReadAssociationsError","description":"Error object for batch read associations matching HubSpot v4 API format."},"BatchReadAssociationsErrorDetail":{"properties":{"message":{"type":"string","title":"Message","description":"A human readable message describing the error along with remediation steps where appropriate"},"subCategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"A specific category that contains more specific detail about the error"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"The status code associated with the error detail"},"in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In","description":"The name of the field or parameter in which the error was found"},"context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context","description":"Context about the error condition"}},"type":"object","required":["message"],"title":"BatchReadAssociationsErrorDetail","description":"Detailed error information for batch read associations matching HubSpot v4 API format."},"BatchReadAssociationsInput":{"properties":{"id":{"type":"string","title":"Id","description":"The unique identifier for the object whose associations are being fetched"},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"A paging cursor token used to retrieve the next set of results in a paginated response"}},"type":"object","required":["id"],"title":"BatchReadAssociationsInput","description":"Input schema for batch read associations matching HubSpot v4 API format."},"BatchReadAssociationsRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchReadAssociationsInput"},"type":"array","minItems":1,"title":"Inputs","description":"Array of input objects with id and optional after cursor"}},"type":"object","required":["inputs"],"title":"BatchReadAssociationsRequest","description":"Request schema for batch read associations matching HubSpot v4 API format."},"BatchReadAssociationsResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch processing was completed, in ISO 8601 format"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"The timestamp when the batch processing began, in ISO 8601 format"},"results":{"items":{"$ref":"#/components/schemas/BatchReadAssociationsResult-Output"},"type":"array","title":"Results","description":"Array of batch read association results"},"status":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__BatchStatus","description":"The status of the batch processing request: PENDING, PROCESSING, CANCELED, or COMPLETE"},"numErrors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numerrors","description":"The number of errors encountered during the batch processing"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"The timestamp when the batch request was initially made, in ISO 8601 format"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"An object containing relevant links related to the batch request"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/BatchReadAssociationsError"},"type":"array"},{"type":"null"}],"title":"Errors","description":"The detailed error objects"}},"type":"object","required":["completedAt","startedAt","results","status"],"title":"BatchReadAssociationsResponse","description":"Response schema for batch read associations matching HubSpot v4 API format."},"BatchReadAssociationsResult-Input":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"items":{"$ref":"#/components/schemas/AssociationResultWithPaging-Input"},"type":"array","title":"To","description":"Array of target objects with their associations and optional paging"}},"type":"object","required":["from","to"],"title":"BatchReadAssociationsResult","description":"Result schema for batch read associations matching HubSpot v4 API format."},"BatchReadAssociationsResult-Output":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"items":{"$ref":"#/components/schemas/AssociationResultWithPaging-Output"},"type":"array","title":"To","description":"Array of target objects with their associations and optional paging"}},"type":"object","required":["from","to"],"title":"BatchReadAssociationsResult","description":"Result schema for batch read associations matching HubSpot v4 API format."},"BatchReadBlogTagsRequest":{"properties":{"inputs":{"items":{"type":"string"},"type":"array","title":"Inputs","description":"The JSON array of Blog Tag ids"}},"type":"object","required":["inputs"],"title":"BatchReadBlogTagsRequest","description":"Request schema for batch reading blog tags - Wrapper for providing an array of strings as inputs"},"BatchReadBlogTagsResponse":{"properties":{"status":{"$ref":"#/components/schemas/app__modules__cms__cms_tags__schema__BatchStatus"},"results":{"items":{"$ref":"#/components/schemas/BlogTagResponse"},"type":"array","title":"Results","description":"Results of batch operation"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"Time of batch operation completion"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"Time of batch operation start"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"Time of batch operation request"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"Links associated with batch operation"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/BatchUpdateError"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors for failed reads"},"numErrors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numerrors","description":"Number of errors in the batch operation"}},"type":"object","required":["status","results","completedAt","startedAt"],"title":"BatchReadBlogTagsResponse","description":"Response schema for batch reading blog tags"},"BatchReadCmsPostsRequest":{"properties":{"inputs":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":100,"minItems":1,"title":"Inputs","description":"List of CMS post IDs to read"},"properties":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Properties","description":"Properties to return"},"propertiesWithHistory":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history to return"},"associations":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Associations","description":"Associations to return"}},"type":"object","required":["inputs"],"title":"BatchReadCmsPostsRequest","description":"Batch read CMS posts request schema"},"BatchReadCmsPostsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BatchCmsPostResponse"},"type":"array","title":"Results","description":"List of batch read results"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch operation completed"},"numErrors":{"type":"integer","title":"Numerrors","description":"Number of errors in the batch"},"requestedAt":{"type":"string","format":"date-time","title":"Requestedat","description":"The timestamp when the batch operation was requested"}},"type":"object","required":["results","completedAt","numErrors","requestedAt"],"title":"BatchReadCmsPostsResponse","description":"Batch read CMS posts response schema"},"BatchReadExchangeRateRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchReadInput"},"type":"array","title":"Inputs","description":"List of exchange rate IDs to retrieve"}},"type":"object","required":["inputs"],"title":"BatchReadExchangeRateRequest","description":"Request schema for batch reading exchange rates matching HubSpot format"},"BatchReadExchangeRateResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"Completion timestamp in ISO format"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"Start timestamp in ISO format"},"results":{"items":{"$ref":"#/components/schemas/ExchangeRateResponse"},"type":"array","title":"Results","description":"List of retrieved exchange rates"},"status":{"$ref":"#/components/schemas/StatusEnum","description":"Status of the batch operation"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"Request timestamp in ISO format"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"Links to the batch operation"}},"type":"object","required":["completedAt","startedAt","results","status"],"title":"BatchReadExchangeRateResponse","description":"Response schema for batch reading exchange rates matching HubSpot format"},"BatchReadInput":{"properties":{"id":{"type":"string","title":"Id","description":"Exchange rate ID (as string)"}},"type":"object","required":["id"],"title":"BatchReadInput","description":"Input schema for batch read matching HubSpot format"},"BatchReadPropertiesRequest":{"properties":{"archived":{"type":"boolean","title":"Archived","description":"Whether to return archived properties (required)"},"inputs":{"items":{"$ref":"#/components/schemas/BatchReadPropertyInput"},"type":"array","minItems":1,"title":"Inputs","description":"Array of property names to read"},"dataSensitivity":{"type":"string","pattern":"^(non_sensitive|sensitive|highly_sensitive)$","title":"Datasensitivity","description":"Filter by data sensitivity level (required)"}},"type":"object","required":["archived","inputs","dataSensitivity"],"title":"BatchReadPropertiesRequest","description":"Request schema for batch reading properties - matches HubSpot spec exactly"},"BatchReadPropertyInput":{"properties":{"name":{"type":"string","title":"Name","description":"Property name to read"}},"type":"object","required":["name"],"title":"BatchReadPropertyInput","description":"Input for a single property in batch read - matches HubSpot spec"},"BatchUpdateBlogTagsInput":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Tag ID"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The name of the tag"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The URL slug of the tag"},"language":{"anyOf":[{"$ref":"#/components/schemas/LanguageCode"},{"type":"null"}],"description":"The ISO 639 language code"},"deletedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deletedat","description":"Deleted at timestamp"},"created":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created","description":"Created timestamp"},"updated":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated","description":"Updated timestamp"},"translatedFromId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Translatedfromid","description":"ID of primary tag this was translated from"}},"type":"object","title":"BatchUpdateBlogTagsInput","description":"Input schema for batch updating blog tags"},"BatchUpdateBlogTagsRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchUpdateBlogTagsInput"},"type":"array","title":"Inputs","description":"List of tags to update"}},"type":"object","required":["inputs"],"title":"BatchUpdateBlogTagsRequest","description":"Request schema for batch updating blog tags"},"BatchUpdateBlogTagsResponse":{"properties":{"status":{"$ref":"#/components/schemas/app__modules__cms__cms_tags__schema__BatchStatus"},"results":{"items":{"$ref":"#/components/schemas/BlogTagResponse"},"type":"array","title":"Results","description":"Results of batch operation"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"Time of batch operation completion"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"Time of batch operation start"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"Time of batch operation request"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"Links associated with batch operation"},"errors":{"anyOf":[{"items":{"$ref":"#/components/schemas/BatchUpdateError"},"type":"array"},{"type":"null"}],"title":"Errors","description":"List of errors for failed updates"},"numErrors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numerrors","description":"Number of errors in the batch operation"}},"type":"object","required":["status","results","completedAt","startedAt"],"title":"BatchUpdateBlogTagsResponse","description":"Response schema for batch updating blog tags"},"BatchUpdateCmsPostsRequest":{"properties":{"inputs":{"items":{"additionalProperties":true,"type":"object"},"type":"array","maxItems":100,"minItems":1,"title":"Inputs","description":"List of CMS posts to update"}},"type":"object","required":["inputs"],"title":"BatchUpdateCmsPostsRequest","description":"Batch update CMS posts request schema"},"BatchUpdateCmsPostsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BatchCmsPostResponse"},"type":"array","title":"Results","description":"List of batch update results"},"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch operation completed"},"numErrors":{"type":"integer","title":"Numerrors","description":"Number of errors in the batch"},"requestedAt":{"type":"string","format":"date-time","title":"Requestedat","description":"The timestamp when the batch operation was requested"}},"type":"object","required":["results","completedAt","numErrors","requestedAt"],"title":"BatchUpdateCmsPostsResponse","description":"Batch update CMS posts response schema"},"BatchUpdateError":{"properties":{"category":{"type":"string","title":"Category","description":"Error category"},"message":{"type":"string","title":"Message","description":"Error message"},"status":{"type":"string","title":"Status","description":"HTTP status code as string"},"id":{"type":"string","title":"Id","description":"Tag ID that failed"},"context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context","description":"Error context"},"errors":{"items":{"$ref":"#/components/schemas/BatchUpdateErrorDetail"},"type":"array","title":"Errors","description":"Error details"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"Error links"},"subCategory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Subcategory","description":"Error subcategory"}},"type":"object","required":["category","message","status","id","errors"],"title":"BatchUpdateError","description":"Error object in batch update response"},"BatchUpdateErrorDetail":{"properties":{"message":{"type":"string","title":"Message","description":"Error message"},"code":{"type":"string","title":"Code","description":"Error code"},"context":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Context","description":"Error context"},"in":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"In","description":"Error location"},"subCategory":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Subcategory","description":"Error subcategory"}},"type":"object","required":["message","code"],"title":"BatchUpdateErrorDetail","description":"Error detail within batch update error"},"BatchUpdateExchangeRateRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/BatchUpdateInput"},"type":"array","title":"Inputs","description":"List of exchange rates to update"}},"type":"object","required":["inputs"],"title":"BatchUpdateExchangeRateRequest","description":"Request schema for batch updating exchange rates matching HubSpot format"},"BatchUpdateExchangeRateResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"Completion timestamp in ISO format"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"Start timestamp in ISO format"},"results":{"items":{"$ref":"#/components/schemas/ExchangeRateResponse"},"type":"array","title":"Results","description":"List of updated exchange rates"},"status":{"$ref":"#/components/schemas/StatusEnum","description":"Status of the batch operation"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"Request timestamp in ISO format"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"Links to the batch operation"}},"type":"object","required":["completedAt","startedAt","results","status"],"title":"BatchUpdateExchangeRateResponse","description":"Response schema for batch updating exchange rates matching HubSpot format"},"BatchUpdateInput":{"properties":{"id":{"type":"string","title":"Id","description":"Exchange rate ID (as string)"},"conversionRate":{"type":"number","exclusiveMinimum":0.0,"title":"Conversionrate","description":"Conversion rate as number"},"effectiveAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Effectiveat","description":"Effective date (ISO 8601). If not provided, existing value is preserved. Cannot be None. Must be past or present."}},"type":"object","required":["id","conversionRate"],"title":"BatchUpdateInput","description":"Input schema for batch update matching HubSpot format"},"BlogTagListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BlogTagResponse"},"type":"array","title":"Results","description":"Collection of blog tags"},"total":{"type":"integer","title":"Total","description":"Total number of blog tags"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__cms__cms_tags__schema__Paging"},{"type":"null"}],"description":"Pagination information"}},"type":"object","required":["results","total"],"title":"BlogTagListResponse","description":"Blog tags list response schema matching HubSpot format"},"BlogTagResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique ID of the Blog Tag"},"name":{"type":"string","title":"Name","description":"The name of the tag"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The URL slug of the tag"},"language":{"anyOf":[{"$ref":"#/components/schemas/LanguageCode"},{"type":"null"}],"description":"The explicitly defined ISO 639 language code of the tag"},"created":{"type":"string","format":"date-time","title":"Created","description":"The timestamp (ISO8601 format) when this Blog Tag was created"},"updated":{"type":"string","format":"date-time","title":"Updated","description":"The timestamp (ISO8601 format) when this Blog Tag was updated"},"deletedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deletedat","description":"The timestamp (ISO8601 format) when this Blog Tag was deleted"},"translatedFromId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Translatedfromid","description":"ID of the primary tag this object was translated from"}},"type":"object","required":["id","name","created","updated"],"title":"BlogTagResponse","description":"Single blog tag response schema matching HubSpot API v3 format"},"Body_get_access_token_oauth_v1_token_post":{"properties":{"grant_type":{"type":"string","title":"Grant Type","description":"OAuth grant type"},"code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code","description":"Authorization code"},"refresh_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Refresh Token","description":"Refresh token"},"redirect_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Redirect Uri","description":"Redirect URI"},"client_id":{"type":"string","title":"Client Id","description":"OAuth client ID"},"client_secret":{"type":"string","title":"Client Secret","description":"OAuth client secret"},"code_verifier":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Code Verifier","description":"Code verifier for PKCE"},"scope":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Scope","description":"OAuth scopes"}},"type":"object","required":["grant_type","client_id","client_secret"],"title":"Body_get_access_token_oauth_v1_token_post"},"BusinessUnitInfo":{"properties":{"id":{"type":"integer","title":"Id","description":"Business unit ID (integer per HubSpot API)"}},"type":"object","required":["id"],"title":"BusinessUnitInfo","description":"Business unit information schema - used in campaign responses. Per HubSpot API, only id is returned."},"BusinessUnitResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Business unit ID"},"name":{"type":"string","title":"Name","description":"Business unit name"},"logoMetadata":{"anyOf":[{"$ref":"#/components/schemas/LogoMetadata"},{"type":"null"}],"description":"Logo metadata (optional)"}},"type":"object","required":["id","name"],"title":"BusinessUnitResponse","description":"Business unit response schema matching HubSpot format"},"BusinessUnitsCollectionResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/BusinessUnitResponse"},"type":"array","title":"Results","description":"List of business units"}},"type":"object","required":["results"],"title":"BusinessUnitsCollectionResponse","description":"Business units collection response schema matching HubSpot format"},"CallListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/CallResponse"},"type":"array","title":"Results","description":"List of calls"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__engagements__calls__schema__Paging"},{"type":"null"}],"description":"Pagination information — absent when no next page"}},"type":"object","required":["results"],"title":"CallListResponse","description":"Calls list response schema aligning with HubSpot format"},"CallResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Call ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Call properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"CallResponse","description":"Single call response schema matching HubSpot format."},"CampaignAsset":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the asset."},"type":{"type":"string","title":"Type","description":"The type of the asset."},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The asset name, when available for the asset type."},"metrics":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Metrics","description":"Asset metrics for the requested date range. Returned only when both startDate and endDate are provided."}},"type":"object","required":["id","type"],"title":"CampaignAsset","description":"A single asset associated with a campaign."},"CampaignAssetDetail":{"properties":{"id":{"type":"string","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"CampaignAssetDetail","description":"Detailed information for a single asset."},"CampaignAssetListPaging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/CampaignAssetPagingNext"},{"type":"null"}],"description":"Cursor info for fetching the next page of results."}},"type":"object","title":"CampaignAssetListPaging","description":"Paging metadata for campaign asset list responses."},"CampaignAssetListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/CampaignAsset"},"type":"array","title":"Results","description":"A list of assets."},"paging":{"anyOf":[{"$ref":"#/components/schemas/CampaignAssetListPaging"},{"type":"null"}],"description":"Paging metadata for the results."}},"type":"object","required":["results"],"title":"CampaignAssetListResponse","description":"Response for listing assets associated with a campaign."},"CampaignAssetPaging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/CampaignAssetPagingNext"},{"type":"null"}]},"prev":{"anyOf":[{"$ref":"#/components/schemas/CampaignAssetPagingPrev"},{"type":"null"}]},"results":{"items":{"$ref":"#/components/schemas/CampaignAssetDetail"},"type":"array","title":"Results"}},"type":"object","required":["results"],"title":"CampaignAssetPaging","description":"Paging object for campaign assets."},"CampaignAssetPagingNext":{"properties":{"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"},"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After"}},"type":"object","title":"CampaignAssetPagingNext","description":"Paging 'next' object for campaign assets."},"CampaignAssetPagingPrev":{"properties":{"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"},"before":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Before"}},"type":"object","title":"CampaignAssetPagingPrev","description":"Paging 'prev' object for campaign assets."},"CampaignAssetTypeDetail-Input":{"properties":{"paging":{"$ref":"#/components/schemas/CampaignAssetPaging"}},"type":"object","required":["paging"],"title":"CampaignAssetTypeDetail","description":"Container for a specific asset type's paged results."},"CampaignAssetTypeDetail-Output":{"properties":{"paging":{"$ref":"#/components/schemas/CampaignAssetPaging"}},"type":"object","required":["paging"],"title":"CampaignAssetTypeDetail","description":"Container for a specific asset type's paged results."},"CampaignAttributionModel":{"type":"string","enum":["LINEAR","FIRST_INTERACTION","LAST_INTERACTION","FULL_PATH","U_SHAPED","W_SHAPED","TIME_DECAY","J_SHAPED","INVERSE_J_SHAPED"],"title":"CampaignAttributionModel","description":"Attribution model options for revenue reporting."},"CampaignBudgetItemResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Item ID (GUID)"},"amount":{"type":"number","title":"Amount","description":"Monetary amount"},"name":{"type":"string","title":"Name","description":"Item name"},"order":{"type":"integer","title":"Order","description":"Display order for the item"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description of the item"},"createdAt":{"type":"integer","title":"Createdat","description":"Created timestamp in milliseconds since epoch"},"updatedAt":{"type":"integer","title":"Updatedat","description":"Updated timestamp in milliseconds since epoch"}},"type":"object","required":["id","amount","name","order","createdAt","updatedAt"],"title":"CampaignBudgetItemResponse","description":"Response schema for campaign budget item operations."},"CampaignBudgetTotalsResponse":{"properties":{"spendItems":{"items":{"$ref":"#/components/schemas/CampaignSpendItemResponse"},"type":"array","title":"Spenditems","description":"Spend line items applied to the campaign"},"budgetItems":{"items":{"$ref":"#/components/schemas/CampaignBudgetItemResponse"},"type":"array","title":"Budgetitems","description":"Budget allocations defined for the campaign"},"budgetTotal":{"type":"number","title":"Budgettotal","description":"Sum of all budget item amounts recorded for the campaign"},"spendTotal":{"type":"number","title":"Spendtotal","description":"Sum of all spend item amounts recorded for the campaign"},"remainingBudget":{"type":"number","title":"Remainingbudget","description":"Remaining budget after subtracting total spend from budget"},"currencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"ISO currency code tied to the campaign budget"}},"type":"object","required":["budgetTotal","spendTotal","remainingBudget","currencyCode"],"title":"CampaignBudgetTotalsResponse","description":"Aggregate budget + spend totals for a campaign."},"CampaignContactReportResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/CampaignContactResult"},"type":"array","title":"Results","description":"List of contact IDs"},"paging":{"anyOf":[{"$ref":"#/components/schemas/CampaignPaging"},{"type":"null"}],"description":"Paging information for fetching the next page of contacts"}},"type":"object","title":"CampaignContactReportResponse","description":"Response schema for GET /reports/contacts/{contactType}."},"CampaignContactResult":{"properties":{"id":{"type":"string","title":"Id","description":"Contact ID influenced by the campaign"}},"type":"object","required":["id"],"title":"CampaignContactResult","description":"Individual contact ID record in campaign contact report."},"CampaignContactType":{"type":"string","enum":["contactFirstTouch","contactLastTouch","influencedContacts"],"title":"CampaignContactType","description":"Contact type filters for campaign contact reports."},"CampaignDetailResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Campaign GUID (UUID)"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Campaign properties"},"createdAt":{"type":"string","title":"Createdat","description":"Created timestamp (ISO 8601)"},"updatedAt":{"type":"string","title":"Updatedat","description":"Updated timestamp (ISO 8601)"},"businessUnits":{"items":{"$ref":"#/components/schemas/BusinessUnitInfo"},"type":"array","title":"Businessunits","description":"Associated business units (Brands add-on). Returns empty array when no units assigned."},"assets":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/CampaignAssetTypeDetail-Output"},"type":"object"},{"type":"null"}],"title":"Assets","description":"Campaign assets (when requested with date parameters)"}},"type":"object","required":["id","properties","createdAt","updatedAt"],"title":"CampaignDetailResponse","description":"Single-campaign GET response — extends CampaignResponse with assets.\nassets is only populated when startDate/endDate are provided."},"CampaignListResponse":{"properties":{"total":{"type":"integer","title":"Total","description":"Total number of campaigns matching the query"},"results":{"items":{"$ref":"#/components/schemas/CampaignResponse"},"type":"array","title":"Results","description":"List of campaign records"},"paging":{"anyOf":[{"$ref":"#/components/schemas/CampaignPaging"},{"type":"null"}],"description":"Paging info when more results are available"}},"type":"object","required":["total","results"],"title":"CampaignListResponse","description":"Response schema for GET /marketing/v3/campaigns search endpoint"},"CampaignMetricsResponse":{"properties":{"sessions":{"type":"integer","title":"Sessions","description":"Number of sessions attributed to campaign"},"newContactsFirstTouch":{"type":"integer","title":"Newcontactsfirsttouch","description":"New contacts attributed as first touch"},"influencedContacts":{"type":"integer","title":"Influencedcontacts","description":"Total influenced contacts for the campaign"},"newContactsLastTouch":{"type":"integer","title":"Newcontactslasttouch","description":"New contacts attributed as last touch"}},"type":"object","required":["sessions","newContactsFirstTouch","influencedContacts","newContactsLastTouch"],"title":"CampaignMetricsResponse","description":"Response schema for GET /reports/metrics."},"CampaignPaging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/CampaignPagingNext"},{"type":"null"}],"description":"Information about the next page of results"},"prev":{"anyOf":[{"$ref":"#/components/schemas/CampaignPagingPrev"},{"type":"null"}],"description":"Information about the previous page of results"}},"type":"object","title":"CampaignPaging","description":"Paging container for campaign search responses"},"CampaignPagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Cursor token for fetching the next page"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Relative link (path + query string) to fetch the next page"}},"type":"object","title":"CampaignPagingNext","description":"Paging.next structure for campaign search responses"},"CampaignPagingPrev":{"properties":{"before":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Before","description":"Cursor token for fetching the previous page"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"URL to fetch the previous page of results"}},"type":"object","title":"CampaignPagingPrev","description":"Paging.prev structure for campaign search responses"},"CampaignProperties":{"properties":{"hs_start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Hs Start Date","description":"Start date (YYYY-MM-DD)"},"hs_end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Hs End Date","description":"End date (YYYY-MM-DD)"},"hs_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hs Notes","description":"Campaign notes"},"hs_audience":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hs Audience","description":"Target audience"},"hs_currency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hs Currency Code","description":"ISO currency code (e.g., USD, EUR)"},"hs_campaign_status":{"anyOf":[{"$ref":"#/components/schemas/CampaignStatus"},{"type":"null"}],"description":"Campaign status"},"hs_utm":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Hs Utm","description":"UTM values"},"hs_name":{"type":"string","maxLength":256,"minLength":1,"title":"Hs Name","description":"Campaign name (required, unique)"}},"additionalProperties":true,"type":"object","required":["hs_name"],"title":"CampaignProperties","description":"Campaign properties for creation per HubSpot Marketing Campaigns API v3"},"CampaignResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Campaign GUID (UUID)"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Campaign properties"},"createdAt":{"type":"string","title":"Createdat","description":"Created timestamp (ISO 8601)"},"updatedAt":{"type":"string","title":"Updatedat","description":"Updated timestamp (ISO 8601)"},"businessUnits":{"items":{"$ref":"#/components/schemas/BusinessUnitInfo"},"type":"array","title":"Businessunits","description":"Associated business units (Brands add-on). Returns empty array when no units assigned."}},"type":"object","required":["id","properties","createdAt","updatedAt"],"title":"CampaignResponse","description":"Campaign response schema per HubSpot API — used for list/search and create/update endpoints."},"CampaignRevenueResponse":{"properties":{"contactsNumber":{"type":"integer","title":"Contactsnumber","description":"Number of contacts in the model"},"dealAmount":{"type":"number","title":"Dealamount","description":"Total deal amount in the range"},"dealsNumber":{"type":"integer","title":"Dealsnumber","description":"Total number of deals in the range"},"revenueAmount":{"type":"number","title":"Revenueamount","description":"Revenue amount for the campaign"},"currencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"ISO currency code for the monetary values"}},"type":"object","required":["contactsNumber","dealAmount","dealsNumber","revenueAmount","currencyCode"],"title":"CampaignRevenueResponse","description":"Response schema for revenue reports."},"CampaignSpendItemResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Item ID (GUID)"},"amount":{"type":"number","title":"Amount","description":"Monetary amount"},"name":{"type":"string","title":"Name","description":"Item name"},"order":{"type":"integer","title":"Order","description":"Display order for the item"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Optional description of the item"},"createdAt":{"type":"integer","title":"Createdat","description":"Created timestamp in milliseconds since epoch"},"updatedAt":{"type":"integer","title":"Updatedat","description":"Updated timestamp in milliseconds since epoch"}},"type":"object","required":["id","amount","name","order","createdAt","updatedAt"],"title":"CampaignSpendItemResponse","description":"Response schema for campaign spend item operations."},"CampaignStatus":{"type":"string","enum":["planned","in_progress","active","paused","completed"],"title":"CampaignStatus","description":"Campaign status values per HubSpot Marketing Campaigns API v3"},"CartEntity":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"CartEntity","description":"Entity response for cart operations"},"CartListItem-Input":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"associations":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationCollection"},"type":"object"},{"type":"null"}],"title":"Associations"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"CartListItem","description":"Single cart in list response"},"CartListItem-Output":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"associations":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationCollection"},"type":"object"},{"type":"null"}],"title":"Associations"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"CartListItem","description":"Single cart in list response"},"CentralFxRatesInformationResponse":{"properties":{"centralExchangeRatesEnabled":{"type":"boolean","title":"Centralexchangeratesenabled","description":"Automatic exchange rate updates enabled"}},"type":"object","required":["centralExchangeRatesEnabled"],"title":"CentralFxRatesInformationResponse","description":"Response schema for central FX rates information matching HubSpot format"},"CloneCmsPostRequest":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to be cloned"},"cloneName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Clonename","description":"Optional name for the cloned object"}},"type":"object","required":["id"],"title":"CloneCmsPostRequest","description":"Clone CMS post request schema - matches HubSpot API spec"},"CmsPostListResponse":{"properties":{"total":{"type":"integer","title":"Total","description":"Total number of blog posts"},"results":{"items":{"$ref":"#/components/schemas/GetCmsPostResponse"},"type":"array","title":"Results","description":"List of CMS posts"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__cms__cms_posts__schema__Paging"},{"type":"null"}],"description":"Pagination info"}},"type":"object","required":["total","results"],"title":"CmsPostListResponse","description":"CMS posts list response schema matching HubSpot format"},"CmsPostResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Post ID"},"created":{"type":"string","title":"Created","description":"Created timestamp in ISO format"},"updated":{"type":"string","title":"Updated","description":"Updated timestamp in ISO format"},"archivedAt":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp (Unix milliseconds)"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"}},"additionalProperties":true,"type":"object","required":["id","created","updated"],"title":"CmsPostResponse","description":"Single CMS post response schema matching HubSpot format\n\nProperties are flattened to top level per HubSpot API v3 format.\nAdditional properties from the JSON column are included at the top level.\n\nNote: HubSpot API uses \"created\" and \"updated\" (not \"createdAt\"/\"updatedAt\")\nand archivedAt as integer timestamp (milliseconds)."},"CmsPostRevisionListResponse":{"properties":{"total":{"type":"integer","title":"Total","description":"Total number of revisions for the blog post"},"results":{"items":{"$ref":"#/components/schemas/CmsPostRevisionResponse"},"type":"array","title":"Results","description":"List of CMS post revisions"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__cms__cms_posts__schema__Paging"},{"type":"null"}],"description":"Pagination info"}},"type":"object","required":["total","results"],"title":"CmsPostRevisionListResponse","description":"CMS post revisions list response schema"},"CmsPostRevisionResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Revision ID"},"object":{"$ref":"#/components/schemas/GetCmsPostResponse","description":"Snapshot of the blog post at this revision"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"user":{"$ref":"#/components/schemas/CmsPostRevisionUser","description":"User metadata associated with the revision"}},"type":"object","required":["id","object","updatedAt","user"],"title":"CmsPostRevisionResponse","description":"Single CMS post revision response schema"},"CmsPostRevisionUser":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the user that triggered the revision","default":"1"},"email":{"type":"string","title":"Email","description":"Email address of the user that triggered the revision","default":"user@example.com"},"fullName":{"type":"string","title":"Fullname","description":"Full name of the user that triggered the revision","default":"Unknown User"}},"type":"object","title":"CmsPostRevisionUser","description":"Metadata describing the user responsible for a revision"},"CompanyCreateRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Company properties. Accepts any type (strings, numbers, booleans, etc.) as per HubSpot docs. At least 'name' OR 'domain' must be provided."},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__Association"},"type":"array"},{"type":"null"}],"title":"Associations"}},"type":"object","required":["properties"],"title":"CompanyCreateRequest","description":"Request schema for creating a company"},"CompanyCurrencyResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Currency code (e.g., USD, EUR)"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Creation timestamp in ISO format"}},"type":"object","required":["id","createdAt"],"title":"CompanyCurrencyResponse","description":"Company currency response schema matching HubSpot format"},"CompanyEntity":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"CompanyEntity","description":"Entity response for company operations"},"CompanyListItem":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"CompanyListItem","description":"Single company in list response"},"CompanyMergeRequest":{"properties":{"objectIdToMerge":{"type":"string","title":"Objectidtomerge","description":"The ID of the company to merge into the primary"},"primaryObjectId":{"type":"string","title":"Primaryobjectid","description":"The ID of the primary company, which the other will merge into"}},"type":"object","required":["objectIdToMerge","primaryObjectId"],"title":"CompanyMergeRequest","description":"Request schema for merging two companies"},"CompanyUpdateRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Company property values to set. Accepts any type (strings, numbers, booleans, etc.) as per HubSpot docs. Empty strings clear properties."}},"type":"object","required":["properties"],"title":"CompanyUpdateRequest","description":"Request schema for updating a company"},"ContactCreateRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Contact properties. Types must match each property's schema (strings for text fields, numbers for numeric fields, etc.)."},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_contact__schemas__contacts__Association"},"type":"array"},{"type":"null"}],"title":"Associations"}},"type":"object","required":["properties"],"title":"ContactCreateRequest","description":"Request schema for creating a contact"},"ContactEntity":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":true,"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"ContactEntity"},"ContactGdprDeleteRequest":{"properties":{"objectId":{"type":"string","minLength":1,"title":"Objectid","description":"The ID of the contact to permanently delete"},"idProperty":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idproperty","description":"The name of a property whose values are unique for this object (e.g., 'email')"}},"type":"object","required":["objectId"],"title":"ContactGdprDeleteRequest","description":"Request schema for GDPR-compliant permanent deletion"},"ContactListItem":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":true,"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"ContactListItem","description":"Single contact in list response"},"ContactMergeRequest":{"properties":{"objectIdToMerge":{"type":"string","minLength":1,"title":"Objectidtomerge","description":"The object ID of the record that the merge will not set as the current value after the merge."},"primaryObjectId":{"type":"string","minLength":1,"title":"Primaryobjectid","description":"The object ID of the record that the merge will generally set as the current value after the merge."}},"type":"object","required":["objectIdToMerge","primaryObjectId"],"title":"ContactMergeRequest","description":"Request schema for merging two contacts"},"ContactUpdateRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Contact property values to set. Accepts any type (strings, numbers, booleans, etc.) as per HubSpot docs. Empty strings clear properties."}},"type":"object","required":["properties"],"title":"ContactUpdateRequest","description":"Request schema for updating a contact"},"ContentTypeCategory":{"type":"string","enum":["0","1","2","3","4","5","6","7","8","9","10","11","12","13","14","15","16","17","18","19","20","21","22"],"title":"ContentTypeCategory","description":"Valid contentTypeCategory values (0-22), 0 = BLOG_POST"},"CreateAssociationBatchInputItem":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId"},"to":{"$ref":"#/components/schemas/AssociationObjectId"},"type":{"type":"string","minLength":1,"title":"Type","description":"The type of association between the from and to objects"}},"type":"object","required":["from","to","type"],"title":"CreateAssociationBatchInputItem","description":"One input item for POST /crm/v3/associations/{from}/{to}/batch/create body."},"CreateAssociationBatchRequest":{"properties":{"inputs":{"items":{"$ref":"#/components/schemas/CreateAssociationBatchInputItem"},"type":"array","minItems":1,"title":"Inputs"}},"type":"object","required":["inputs"],"title":"CreateAssociationBatchRequest","description":"Request body for POST /crm/v3/associations/{from}/{to}/batch/create."},"CreateAssociationBatchResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat"},"results":{"items":{"$ref":"#/components/schemas/CreateAssociationBatchResultItem"},"type":"array","title":"Results"},"startedAt":{"type":"string","format":"date-time","title":"Startedat"},"status":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__BatchStatus"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat"}},"type":"object","required":["completedAt","results","startedAt","status"],"title":"CreateAssociationBatchResponse","description":"201 response for POST /crm/v3/associations/{from}/{to}/batch/create."},"CreateAssociationBatchResultItem":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId"},"to":{"$ref":"#/components/schemas/AssociationObjectId"},"type":{"type":"string","title":"Type"}},"type":"object","required":["from","to","type"],"title":"CreateAssociationBatchResultItem","description":"One result item in the batch create response."},"CreateAssociationLabelRequest":{"properties":{"name":{"type":"string","minLength":1,"title":"Name","description":"The name of the association label"},"label":{"type":"string","minLength":1,"title":"Label","description":"The label for the association"},"inverseLabel":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Inverselabel","description":"The inverse label for the association"}},"type":"object","required":["name","label"],"title":"CreateAssociationLabelRequest","description":"Request schema for creating association labels matching HubSpot v4 API format."},"CreateAssociationLabelResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/CreateAssociationLabelResult"},"type":"array","title":"Results","description":"Array of created association label results"}},"type":"object","required":["results"],"title":"CreateAssociationLabelResponse","description":"Response schema for creating association labels matching HubSpot v4 API format."},"CreateAssociationLabelResult":{"properties":{"typeId":{"type":"integer","title":"Typeid","description":"The unique identifier for the type of association"},"category":{"type":"string","title":"Category","description":"The category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED)"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"A label describing the association between two objects"}},"type":"object","required":["typeId","category"],"title":"CreateAssociationLabelResult","description":"Result schema for created association label matching HubSpot v4 API format."},"CreateBlogTagRequest":{"properties":{"name":{"type":"string","title":"Name","description":"The name of the tag (required, must be unique)"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The URL slug of the tag (auto-generated from name if not provided)"},"language":{"anyOf":[{"$ref":"#/components/schemas/LanguageCode"},{"type":"null"}],"description":"The ISO 639 language code"},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletedat","description":"Deleted at timestamp (ISO 8601)"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created","description":"Created timestamp (ISO 8601)"},"updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated","description":"Updated timestamp (ISO 8601)"},"translatedFromId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Translatedfromid","description":"ID of primary tag this was translated from"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Tag ID (optional, auto-generated if not provided)"}},"type":"object","required":["name"],"title":"CreateBlogTagRequest","description":"Request schema for creating a blog tag - matches HubSpot API v3\nOnly 'name' is required. All other fields are optional.\nDuplicate names will return 409 Conflict."},"CreateCallRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new call"},"associations":{"items":{"$ref":"#/components/schemas/app__modules__engagements__calls__schema__Association"},"type":"array","title":"Associations","description":"Associations to link the new call with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateCallRequest","description":"Request schema for creating a call"},"CreateCampaignBudgetItemRequest":{"properties":{"amount":{"type":"number","exclusiveMinimum":0.0,"title":"Amount","description":"Amount to record for the spend item (must be a number, not boolean)"},"name":{"type":"string","maxLength":256,"minLength":1,"title":"Name","description":"Name of the spend item"},"order":{"type":"integer","minimum":0.0,"title":"Order","description":"Order in which this spend item should appear (must be an integer, not boolean)"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Description","description":"Optional description of the spend item"}},"type":"object","required":["amount","name","order"],"title":"CreateCampaignBudgetItemRequest","description":"Body schema for POST /marketing/v3/campaigns/{campaignGuid}/budget."},"CreateCampaignRequest":{"properties":{"properties":{"$ref":"#/components/schemas/CampaignProperties","description":"Campaign properties"}},"type":"object","required":["properties"],"title":"CreateCampaignRequest","description":"Create campaign request schema"},"CreateCampaignSpendItemRequest":{"properties":{"amount":{"type":"number","exclusiveMinimum":0.0,"title":"Amount","description":"Amount to record for the spend item (must be a number, not boolean)"},"name":{"type":"string","maxLength":256,"minLength":1,"title":"Name","description":"Name of the spend item"},"order":{"type":"integer","minimum":0.0,"title":"Order","description":"Order in which this spend item should appear (must be an integer, not boolean)"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Description","description":"Optional description of the spend item"}},"type":"object","required":["amount","name","order"],"title":"CreateCampaignSpendItemRequest","description":"Body schema for POST /marketing/v3/campaigns/{campaignGuid}/spend."},"CreateCartRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Cart properties. Properties accept any type (strings, numbers, booleans, etc.) as per HubSpot docs."},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__commerce__carts_schema__Association"},"type":"array"},{"type":"null"}],"title":"Associations"}},"type":"object","required":["properties"],"title":"CreateCartRequest","description":"Request schema for creating a cart"},"CreateCartResponse":{"properties":{"id":{"type":"string","title":"Id"},"createdResourceId":{"type":"string","title":"Createdresourceid"},"entity":{"$ref":"#/components/schemas/CartEntity"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location"}},"type":"object","required":["id","createdResourceId","entity"],"title":"CreateCartResponse","description":"HubSpot-compliant create cart response"},"CreateCmsPostRequest":{"properties":{"publishDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publishdate","description":"Publish date in ISO 8601 format"},"language":{"anyOf":[{"$ref":"#/components/schemas/LanguageCode"},{"type":"null"}],"description":"Language code (ISO 639-1 with optional country code, e.g., 'en', 'es', 'en-US', 'pt-BR')"},"enableLayoutStylesheets":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enablelayoutstylesheets","description":"Boolean to determine whether or not the styles from the template should be applied"},"metaDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Metadescription","description":"A description that goes in <meta> tag on the page"},"attachedStylesheets":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Attachedstylesheets","description":"List of stylesheets to attach to this blog post"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password","description":"Set this to create a password protected page"},"htmlTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Htmltitle","description":"The HTML title of the post"},"publishImmediately":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publishimmediately","description":"Set this to true if you want to be published immediately when the schedule publish endpoint is called"},"translations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Translations","description":"Translations object"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The unique ID of the blog post"},"state":{"anyOf":[{"$ref":"#/components/schemas/PostState"},{"type":"null"}],"description":"An enumeration describing the current publish state of the post"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The URL slug of the blog post"},"createdById":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdbyid","description":"The ID of the user that created the post"},"rssBody":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rssbody","description":"The contents of the RSS body for this Blog Post"},"currentlyPublished":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Currentlypublished","description":"Currently published status"},"archivedInDashboard":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archivedindashboard","description":"If True, the post will not show up in your dashboard"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created","description":"Created timestamp in ISO 8601 format"},"contentTypeCategory":{"anyOf":[{"$ref":"#/components/schemas/ContentTypeCategory"},{"type":"null"}],"description":"An ENUM describing the type of this object. Should always be BLOG_POST (0)"},"mabExperimentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mabexperimentid","description":"MAB experiment ID"},"updatedById":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedbyid","description":"The ID of the user that updated the post"},"translatedFromId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Translatedfromid","description":"ID of the primary blog post that this post was translated from"},"folderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folderid","description":"Folder ID"},"widgetContainers":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Widgetcontainers","description":"A data structure containing the data for all the modules inside the containers for this post"},"pageExpiryRedirectId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pageexpiryredirectid","description":"Page expiry redirect ID"},"dynamicPageDataSourceType":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dynamicpagedatasourcetype","description":"Dynamic page data source type"},"featuredImage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featuredimage","description":"The featuredImage of this Blog Post"},"authorName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorname","description":"The name of the blog author associated with the post"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain","description":"The domain that the post lives on"},"name":{"type":"string","title":"Name","description":"The internal name of the post"},"dynamicPageHubDbTableId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamicpagehubdbtableid","description":"For dynamic HubDB pages, the ID of the HubDB table this post references"},"campaign":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Campaign","description":"The GUID of the marketing campaign the post is associated with"},"dynamicPageDataSourceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamicpagedatasourceid","description":"Dynamic page data source ID"},"enableDomainStylesheets":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabledomainstylesheets","description":"Boolean to determine whether or not the styles from the template should be applied"},"includeDefaultCustomCss":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Includedefaultcustomcss","description":"Boolean to determine whether or not the Primary CSS Files should be applied"},"layoutSections":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Layoutsections","description":"Layout sections"},"updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated","description":"Updated timestamp in ISO 8601 format"},"footerHtml":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Footerhtml","description":"Custom HTML for embed codes, javascript that should be placed before the </body> tag"},"tagIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Tagids","description":"The IDs of the tags associated with this post"},"widgets":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Widgets","description":"A data structure containing the data for all the modules for this page"},"postSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postsummary","description":"The summary of the blog post that will appear on the main listing page"},"headHtml":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Headhtml","description":"Custom HTML for embed codes, javascript, etc. that goes in the <head> tag"},"pageExpiryRedirectUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pageexpiryredirecturl","description":"Page expiry redirect URL"},"abStatus":{"anyOf":[{"$ref":"#/components/schemas/AbStatus"},{"type":"null"}],"description":"AB status: master, variant, loser_variant, mab_master, mab_variant, automated_master, automated_variant, automated_loser_variant"},"useFeaturedImage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Usefeaturedimage","description":"Boolean to determine if this post should use a featured image"},"abTestId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Abtestid","description":"AB test ID"},"featuredImageAltText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featuredimagealttext","description":"Alt Text of the featuredImage"},"blogAuthorId":{"type":"string","title":"Blogauthorid","description":"The ID of the blog author associated with this post"},"contentGroupId":{"type":"string","title":"Contentgroupid","description":"The ID of the post's parent blog"},"rssSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rsssummary","description":"The contents of the RSS summary for this Blog Post"},"pageExpiryEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pageexpiryenabled","description":"Page expiry enabled"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"A generated field representing the URL of this blog post"},"enableGoogleAmpOutputOverride":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enablegoogleampoutputoverride","description":"Boolean to allow overriding the AMP settings for the blog"},"publicAccessRules":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Publicaccessrules","description":"Rules for require member registration to access private content"},"archivedAt":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Archivedat","description":"The timestamp (ISO8601 format) when this Blog Post was deleted"},"postBody":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postbody","description":"The HTML of the main post body"},"themeSettingsValues":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Themesettingsvalues","description":"Theme settings values"},"pageExpiryDate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pageexpirydate","description":"Page expiry date"},"publicAccessRulesEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publicaccessrulesenabled","description":"Boolean to determine whether or not to respect publicAccessRules"},"currentState":{"anyOf":[{"$ref":"#/components/schemas/CurrentState"},{"type":"null"}],"description":"A generated ENUM describing the current state of this Blog Post"},"categoryId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Categoryid","description":"ID of the object type"},"linkRelCanonicalUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linkrelcanonicalurl","description":"Optional override to set the URL to be used in the rel=canonical link tag on the page"}},"additionalProperties":true,"type":"object","required":["name","blogAuthorId","contentGroupId"],"title":"CreateCmsPostRequest","description":"Create CMS post request schema - matches HubSpot API v3 documentation exactly\n\nAll fields are at the top level per HubSpot API specification.\nRequired fields per actual HubSpot API: name, contentGroupId, blogAuthorId"},"CreateDealRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new deal"},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__deals__schema__Association"},"type":"array"},{"type":"null"}],"title":"Associations","description":"Associations to link the new deal with other CRM objects"}},"type":"object","required":["properties"],"title":"CreateDealRequest","description":"Request schema for creating a deal"},"CreateDefaultAssociationResponse":{"properties":{"completedAt":{"type":"string","format":"date-time","title":"Completedat","description":"The timestamp when the batch process was completed, in ISO 8601 format"},"startedAt":{"type":"string","format":"date-time","title":"Startedat","description":"The timestamp when the batch process began execution, in ISO 8601 format"},"results":{"items":{"$ref":"#/components/schemas/CreateDefaultAssociationResult-Output"},"type":"array","title":"Results","description":"Array of association results"},"status":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__BatchStatus","description":"The status of the batch processing request: PENDING, PROCESSING, CANCELED, or COMPLETE"},"numErrors":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Numerrors","description":"The number of errors encountered during the batch processing"},"requestedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Requestedat","description":"The timestamp when the batch process was initiated, in ISO 8601 format"},"links":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Links","description":"An object containing relevant links related to the batch request"},"errors":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Errors","description":"The detailed error objects"}},"type":"object","required":["completedAt","startedAt","results","status"],"title":"CreateDefaultAssociationResponse","description":"Response schema for creating default associations matching HubSpot v4 API format."},"CreateDefaultAssociationResult-Input":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"$ref":"#/components/schemas/AssociationObjectId","description":"The target object in the association"},"associationSpec":{"$ref":"#/components/schemas/AssociationSpec-Input","description":"Defines the type, direction, and details of the relationship"}},"type":"object","required":["from","to","associationSpec"],"title":"CreateDefaultAssociationResult","description":"Result schema for default association creation matching HubSpot v4 API format."},"CreateDefaultAssociationResult-Output":{"properties":{"from":{"$ref":"#/components/schemas/AssociationObjectId","description":"The source object in the association"},"to":{"$ref":"#/components/schemas/AssociationObjectId","description":"The target object in the association"},"associationSpec":{"$ref":"#/components/schemas/AssociationSpec-Output","description":"Defines the type, direction, and details of the relationship"}},"type":"object","required":["from","to","associationSpec"],"title":"CreateDefaultAssociationResult","description":"Result schema for default association creation matching HubSpot v4 API format."},"CreateExchangeRateRequest":{"properties":{"fromCurrencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"From currency code"},"conversionRate":{"type":"number","exclusiveMinimum":0.0,"title":"Conversionrate","description":"Conversion rate as number"},"effectiveAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Effectiveat","description":"Effective date (ISO 8601). Defaults to current datetime if not provided. Must be past or present."}},"type":"object","required":["fromCurrencyCode","conversionRate"],"title":"CreateExchangeRateRequest","description":"Request schema for creating an exchange rate matching HubSpot format"},"CreateGoalTargetRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new goal target"},"associations":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__goals__schema__Association"},"type":"array","title":"Associations","description":"Associations to link the new goal target with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateGoalTargetRequest","description":"Request schema for creating a goal target"},"CreateGoalTargetResponse":{"properties":{"createdResourceId":{"type":"string","title":"Createdresourceid","description":"Created goal target ID"},"entity":{"$ref":"#/components/schemas/GoalResponse","description":"Created goal target entity"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"Location header value"}},"type":"object","required":["createdResourceId","entity"],"title":"CreateGoalTargetResponse","description":"Response schema for creating a goal target matching HubSpot format"},"CreateInvoiceRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new invoice"},"associations":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__invoices__schema__Association"},"type":"array","title":"Associations","description":"Optional associations to link the new invoice with other CRM objects. A draft invoice can be created without any associations."}},"type":"object","required":["properties"],"title":"CreateInvoiceRequest","description":"Request schema for creating an invoice"},"CreateInvoiceResponse":{"properties":{"createdResourceId":{"type":"string","title":"Createdresourceid","description":"Created invoice ID"},"entity":{"$ref":"#/components/schemas/InvoiceResponse","description":"Created invoice entity"},"location":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Location","description":"Location header value"}},"type":"object","required":["createdResourceId","entity"],"title":"CreateInvoiceResponse","description":"Response schema for creating an invoice matching HubSpot format"},"CreateLanguageVariationRequest":{"properties":{"language":{"type":"string","maxLength":10,"minLength":2,"title":"Language","description":"The language code for the variation"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Properties for the language variation"}},"type":"object","required":["language"],"title":"CreateLanguageVariationRequest","description":"Create language variation request schema"},"CreateLeadRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new lead"},"associations":{"items":{"$ref":"#/components/schemas/LeadAssociation"},"type":"array","minItems":1,"title":"Associations","description":"Associations to link the new lead with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateLeadRequest","description":"Request schema for creating a lead"},"CreateLineItemRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new line item"},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__line_items__schema__Association"},"type":"array"},{"type":"null"}],"title":"Associations","description":"Associations to link the new line item with other CRM objects"}},"type":"object","required":["properties"],"title":"CreateLineItemRequest"},"CreateLineItemResponse":{"properties":{"location":{"type":"string","title":"Location","description":"Location of the created resource"},"createdResourceId":{"type":"string","title":"Createdresourceid","description":"ID of the created resource"},"entity":{"$ref":"#/components/schemas/LineItemResponse","description":"The created line item entity"}},"type":"object","required":["location","createdResourceId","entity"],"title":"CreateLineItemResponse"},"CreateNoteRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new note"},"associations":{"items":{"$ref":"#/components/schemas/app__modules__engagements__notes__schema__Association"},"type":"array","title":"Associations","description":"Associations to link the new note with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateNoteRequest","description":"Request schema for creating a note"},"CreateOrderRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new order"},"associations":{"items":{"$ref":"#/components/schemas/OrderAssociation"},"type":"array","minItems":1,"title":"Associations","description":"Associations to link the new order with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateOrderRequest","description":"Request schema for creating an order"},"CreatePaymentRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Payment properties. At minimum, 'hs_initial_amount' and 'hs_initiated_date' must be provided."},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__Association"},"type":"array"},{"type":"null"}],"title":"Associations"}},"type":"object","required":["properties"],"title":"CreatePaymentRequest","description":"Request schema for creating a payment"},"CreatePaymentResponse":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"CreatePaymentResponse","description":"HubSpot-compliant create payment response — flat CRM object per doc 201"},"CreatePipelineResponse":{"properties":{"id":{"type":"string","title":"Id","description":"A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline"},"label":{"type":"string","title":"Label","description":"A unique label used to organize pipelines in HubSpot's UI"},"displayOrder":{"type":"integer","title":"Displayorder","description":"The order for displaying this pipeline"},"createdAt":{"type":"string","title":"Createdat","description":"The date the pipeline was created (ISO 8601 format)"},"updatedAt":{"type":"string","title":"Updatedat","description":"The date the pipeline was last updated (ISO 8601 format)"},"archived":{"type":"boolean","title":"Archived","description":"Whether the pipeline is archived","default":false},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"The date the pipeline was archived. Only present if archived (ISO 8601 format)"},"stages":{"items":{"$ref":"#/components/schemas/PipelineStageResponse"},"type":"array","title":"Stages","description":"Array of pipeline stage definitions"}},"type":"object","required":["id","label","displayOrder","createdAt","updatedAt","stages"],"title":"CreatePipelineResponse","description":"Response schema for creating a pipeline"},"CreateProductRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new product"},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__products__schema__Association"},"type":"array"},{"type":"null"}],"title":"Associations","description":"Associations to link the new product with other CRM objects"}},"type":"object","required":["properties"],"title":"CreateProductRequest","description":"Request schema for creating a product used by the API router."},"CreateProductResponse":{"properties":{"archived":{"type":"boolean","title":"Archived","description":"Whether the object is archived"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"The timestamp when the object was created, in ISO 8601 format"},"id":{"type":"string","title":"Id","description":"The unique ID of the object"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs representing the properties of the object"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"The timestamp when the object was last updated, in ISO 8601 format"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"The timestamp when the object was archived, in ISO 8601 format"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"An identifier used for tracing the write request for the object"},"propertiesWithHistory":{"additionalProperties":true,"type":"object","title":"Propertieswithhistory","description":"Key-value pairs representing the properties of the object along with their history"}},"type":"object","required":["archived","createdAt","id","properties","updatedAt"],"title":"CreateProductResponse","description":"Create product response schema - matches HubSpot API exactly (no associations)"},"CreateQuoteRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new quote"},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__quotes__schema__Association"},"type":"array"},{"type":"null"}],"title":"Associations","description":"Associations to link the new quote with other CRM objects"}},"type":"object","required":["properties"],"title":"CreateQuoteRequest","description":"Request schema for creating a quote used by the API router."},"CreateQuoteResponse":{"properties":{"location":{"type":"string","title":"Location","description":"Location of the created resource"},"createdResourceId":{"type":"string","title":"Createdresourceid","description":"ID of the created resource"},"entity":{"$ref":"#/components/schemas/QuoteResponse","description":"The created quote entity"}},"type":"object","required":["location","createdResourceId","entity"],"title":"CreateQuoteResponse","description":"Response schema for creating a quote matching HubSpot format"},"CreateTaskRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new task"},"associations":{"items":{"$ref":"#/components/schemas/app__modules__engagements__tasks__schema__Association"},"type":"array","title":"Associations","description":"Associations to link the new task with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateTaskRequest","description":"Request schema for creating a task"},"CreateTaxRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new tax"},"associations":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__taxes__schema__Association"},"type":"array","title":"Associations","description":"Associations to link the new tax with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateTaxRequest","description":"Request schema for creating a tax used by the API router."},"CreateTicketRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new ticket"},"associations":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__tickets__schema__Association"},"type":"array","title":"Associations","description":"Associations to link the new ticket with other CRM objects"}},"type":"object","required":["properties","associations"],"title":"CreateTicketRequest","description":"Request schema for creating a ticket used by the API router."},"CreateUserRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs for setting properties for the new user. Only specific HubSpot properties are supported - see docstring above."},"associations":{"anyOf":[{"items":{"$ref":"#/components/schemas/app__modules__settings__users__schema__Association"},"type":"array"},{"type":"null"}],"title":"Associations","description":"Associations to link the new user with other CRM objects"}},"type":"object","required":["properties"],"title":"CreateUserRequest","description":"Request schema for creating a user used by the API router.\n\nAccording to HubSpot API documentation, the following user properties can be set:\n- email (String): Email address for user identification\n- hs_additional_phone (String): Additional phone number\n- hs_availability_status (String): \"available\" or \"away\"\n- hs_job_title (String): Job title\n- hs_main_user_language_skill (String): Main language skill (da, de, en, es, fr, it, nl, no, pl, ptbr, fi, sv, zhtw, ja)\n- hs_out_of_office_hours (String): Out of office hours (JSON string)\n- hs_secondary_user_language_skill (String): Secondary language skill\n- hs_standard_time_zone (String): Timezone (e.g., \"America/New_York\")\n- hs_uncategorized_skills (String): Custom uncategorized skill\n- hs_working_hours (String): Working hours (JSON stringified array)\n\nNote: The 'email' field is commonly used in practice for user identification.\nSee https://developers.hubspot.com/docs/api-reference/crm-users-v3/guide for details."},"CreateUserResponse":{"properties":{"location":{"type":"string","title":"Location","description":"Location of the created resource"},"createdResourceId":{"type":"string","title":"Createdresourceid","description":"ID of the created resource"},"entity":{"$ref":"#/components/schemas/UserResponse","description":"The created user entity"}},"type":"object","required":["location","createdResourceId","entity"],"title":"CreateUserResponse","description":"Response schema for creating a user matching HubSpot format"},"CurrencyCodesResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/app__modules__settings__currencies__schema__CurrencyCode"},"type":"array","title":"Results","description":"List of supported currency codes"}},"type":"object","required":["results"],"title":"CurrencyCodesResponse","description":"Currency codes list response schema matching HubSpot format"},"CurrentExchangeRatesListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ExchangeRateResponse"},"type":"array","title":"Results","description":"List of current exchange rates"}},"type":"object","required":["results"],"title":"CurrentExchangeRatesListResponse","description":"Current exchange rates list response schema matching HubSpot format"},"CurrentState":{"type":"string","enum":["AGENT_GENERATED","AUTOMATED","AUTOMATED_DRAFT","AUTOMATED_SENDING","AUTOMATED_FOR_FORM","AUTOMATED_FOR_FORM_BUFFER","AUTOMATED_FOR_FORM_DRAFT","AUTOMATED_FOR_FORM_LEGACY","BLOG_EMAIL_DRAFT","BLOG_EMAIL_PUBLISHED","DRAFT","DRAFT_AB","DRAFT_AB_VARIANT","ERROR","LOSER_AB_VARIANT","PAGE_STUB","PRE_PROCESSING","PROCESSING","PUBLISHED","PUBLISHED_AB","PUBLISHED_AB_VARIANT","PUBLISHED_OR_SCHEDULED","RSS_TO_EMAIL_DRAFT","RSS_TO_EMAIL_PUBLISHED","SCHEDULED","SCHEDULED_AB","SCHEDULED_OR_PUBLISHED","AUTOMATED_AB","AUTOMATED_AB_VARIANT","AUTOMATED_DRAFT_AB","AUTOMATED_DRAFT_ABVARIANT","AUTOMATED_LOSER_ABVARIANT"],"title":"CurrentState","description":"Valid currentState values from HubSpot API"},"DataSensitivityEnum":{"type":"string","enum":["non_sensitive","sensitive","highly_sensitive"],"title":"DataSensitivityEnum","description":"Data sensitivity levels for properties"},"DateDisplayHintEnum":{"type":"string","enum":["absolute","absolute_with_relative","time_since","time_until"],"title":"DateDisplayHintEnum","description":"Date display hint options for date/datetime properties"},"DealListItem":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":true,"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"DealListItem","description":"Single deal in list response"},"DealResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Deal ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Deal properties"},"createdAt":{"type":"string","title":"Createdat","description":"Created at timestamp in ISO 8601 format"},"updatedAt":{"type":"string","title":"Updatedat","description":"Updated at timestamp in ISO 8601 format"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp in ISO 8601 format"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"DealResponse","description":"Single deal response schema matching HubSpot SimplePublicObject."},"DetachFromLangGroupRequest":{"properties":{"languageGroupId":{"type":"string","title":"Languagegroupid","description":"The language group ID to detach from"}},"type":"object","required":["languageGroupId"],"title":"DetachFromLangGroupRequest","description":"Detach from language group request schema"},"ExchangeRateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Exchange rate ID (as string)"},"fromCurrencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"From currency code"},"toCurrencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"To currency code (company currency)"},"conversionRate":{"type":"number","title":"Conversionrate","description":"Conversion rate as number"},"visibleInUI":{"type":"boolean","title":"Visibleinui","description":"Visible in UI flag"},"effectiveAt":{"type":"string","format":"date-time","title":"Effectiveat","description":"Effective date (ISO 8601). Always set, never None."},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Creation timestamp in ISO format"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Update timestamp in ISO format"}},"type":"object","required":["id","fromCurrencyCode","toCurrencyCode","conversionRate","visibleInUI","effectiveAt","createdAt","updatedAt"],"title":"ExchangeRateResponse","description":"Exchange rate response schema matching HubSpot format"},"ExchangeRatesListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ExchangeRateResponse"},"type":"array","title":"Results","description":"List of exchange rates"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__settings__currencies__schema__Paging"},{"type":"null"}],"description":"Pagination information"}},"type":"object","required":["results"],"title":"ExchangeRatesListResponse","description":"Exchange rates list response schema matching HubSpot format"},"FieldTypeEnum":{"type":"string","enum":["booleancheckbox","calculation_equation","checkbox","date","file","html","number","phonenumber","radio","select","text","textarea"],"title":"FieldTypeEnum","description":"Property field types for UI representation"},"GetAllPipelinesResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PipelineResponse"},"type":"array","title":"Results","description":"Array of pipeline objects"}},"type":"object","required":["results"],"title":"GetAllPipelinesResponse","description":"Response schema for getting all pipelines"},"GetAllStagesResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PipelineStageResponse"},"type":"array","title":"Results","description":"Array of pipeline stage objects"}},"type":"object","required":["results"],"title":"GetAllStagesResponse","description":"Response schema for getting all stages of a pipeline"},"GetCartResponse":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"associations":{"additionalProperties":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationCollection"},"type":"object","title":"Associations","default":{}},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"GetCartResponse","description":"Response schema for getting a single cart by ID"},"GetCmsPostResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique ID of the blog post"},"publishDate":{"type":"string","title":"Publishdate","description":"The date (ISO8601 format) the blog post is to be published at"},"created":{"type":"string","format":"date-time","title":"Created","description":"Created timestamp in ISO 8601 format"},"updated":{"type":"string","format":"date-time","title":"Updated","description":"Updated timestamp in ISO 8601 format"},"archivedAt":{"type":"integer","title":"Archivedat","description":"The timestamp (ISO8601 format) when this Blog Post was deleted"},"language":{"$ref":"#/components/schemas/LanguageCode","description":"The explicitly defined ISO 639 language code of the post"},"translations":{"additionalProperties":true,"type":"object","title":"Translations","description":"Translations object"},"translatedFromId":{"type":"string","title":"Translatedfromid","description":"ID of the primary blog post that this post was translated from"},"name":{"type":"string","title":"Name","description":"The internal name of the post"},"slug":{"type":"string","title":"Slug","description":"The URL slug of the blog post"},"postBody":{"type":"string","title":"Postbody","description":"The HTML of the main post body"},"postSummary":{"type":"string","title":"Postsummary","description":"The summary of the blog post that will appear on the main listing page"},"metaDescription":{"type":"string","title":"Metadescription","description":"A description that goes in <meta> tag on the page"},"htmlTitle":{"type":"string","title":"Htmltitle","description":"The HTML title of the post"},"rssBody":{"type":"string","title":"Rssbody","description":"The contents of the RSS body for this Blog Post"},"rssSummary":{"type":"string","title":"Rsssummary","description":"The contents of the RSS summary for this Blog Post"},"blogAuthorId":{"type":"string","title":"Blogauthorid","description":"The ID of the blog author associated with this post"},"authorName":{"type":"string","title":"Authorname","description":"The name of the blog author associated with the post"},"contentGroupId":{"type":"string","title":"Contentgroupid","description":"The ID of the post's parent blog"},"state":{"$ref":"#/components/schemas/PostState","maxLength":25,"description":"An enumeration describing the current publish state of the post"},"currentState":{"$ref":"#/components/schemas/CurrentState","description":"A generated ENUM describing the current state of this Blog Post"},"currentlyPublished":{"type":"boolean","title":"Currentlypublished","description":"Currently published status"},"publishImmediately":{"type":"boolean","title":"Publishimmediately","description":"Set this to true if you want to be published immediately when the schedule publish endpoint is called"},"contentTypeCategory":{"$ref":"#/components/schemas/ContentTypeCategory","description":"An ENUM describing the type of this object. Should always be BLOG_POST"},"categoryId":{"type":"integer","title":"Categoryid","description":"ID of the object type"},"createdById":{"type":"string","title":"Createdbyid","description":"The ID of the user that created the post"},"updatedById":{"type":"string","title":"Updatedbyid","description":"The ID of the user that updated the post"},"featuredImage":{"type":"string","title":"Featuredimage","description":"The featuredImage of this Blog Post"},"featuredImageAltText":{"type":"string","title":"Featuredimagealttext","description":"Alt Text of the featuredImage"},"useFeaturedImage":{"type":"boolean","title":"Usefeaturedimage","description":"Boolean to determine if this post should use a featured image"},"tagIds":{"items":{"type":"integer"},"type":"array","title":"Tagids","description":"The IDs of the tags associated with this post"},"campaign":{"type":"string","title":"Campaign","description":"The GUID of the marketing campaign the post is associated with"},"domain":{"type":"string","title":"Domain","description":"The domain that the post lives on"},"url":{"type":"string","title":"Url","description":"A generated field representing the URL of this blog post"},"linkRelCanonicalUrl":{"type":"string","title":"Linkrelcanonicalurl","description":"Optional override to set the URL to be used in the rel=canonical link tag on the page"},"enableLayoutStylesheets":{"type":"boolean","title":"Enablelayoutstylesheets","description":"Boolean to determine whether or not the styles from the template should be applied"},"enableDomainStylesheets":{"type":"boolean","title":"Enabledomainstylesheets","description":"Boolean to determine whether or not the styles from the template should be applied"},"includeDefaultCustomCss":{"type":"boolean","title":"Includedefaultcustomcss","description":"Boolean to determine whether or not the Primary CSS Files should be applied"},"attachedStylesheets":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Attachedstylesheets","description":"List of stylesheets to attach to this blog post"},"headHtml":{"type":"string","title":"Headhtml","description":"Custom HTML for embed codes, javascript, etc. that goes in the <head> tag"},"footerHtml":{"type":"string","title":"Footerhtml","description":"Custom HTML for embed codes, javascript that should be placed before the </body> tag"},"layoutSections":{"additionalProperties":true,"type":"object","title":"Layoutsections","description":"Layout sections"},"widgetContainers":{"additionalProperties":true,"type":"object","title":"Widgetcontainers","description":"A data structure containing the data for all the modules inside the containers for this post"},"widgets":{"additionalProperties":true,"type":"object","title":"Widgets","description":"A data structure containing the data for all the modules for this page"},"themeSettingsValues":{"additionalProperties":true,"type":"object","title":"Themesettingsvalues","description":"Theme settings values"},"archivedInDashboard":{"type":"boolean","title":"Archivedindashboard","description":"If True, the post will not show up in your dashboard, although the post could still be live"},"pageExpiryEnabled":{"type":"boolean","title":"Pageexpiryenabled","description":"Page expiry enabled"},"pageExpiryDate":{"type":"integer","title":"Pageexpirydate","description":"Page expiry date"},"pageExpiryRedirectId":{"type":"integer","title":"Pageexpiryredirectid","description":"Page expiry redirect ID"},"pageExpiryRedirectUrl":{"type":"string","title":"Pageexpiryredirecturl","description":"Page expiry redirect URL"},"dynamicPageDataSourceType":{"type":"integer","title":"Dynamicpagedatasourcetype","description":"Dynamic page data source type"},"dynamicPageDataSourceId":{"type":"string","title":"Dynamicpagedatasourceid","description":"Dynamic page data source ID"},"dynamicPageHubDbTableId":{"type":"string","title":"Dynamicpagehubdbtableid","description":"For dynamic HubDB pages, the ID of the HubDB table this post references"},"abStatus":{"anyOf":[{"$ref":"#/components/schemas/AbStatus"},{"type":"null"}],"description":"AB status"},"abTestId":{"type":"string","title":"Abtestid","description":"AB test ID"},"mabExperimentId":{"type":"string","title":"Mabexperimentid","description":"MAB experiment ID"},"folderId":{"type":"string","title":"Folderid","description":"Folder ID"},"publicAccessRulesEnabled":{"type":"boolean","title":"Publicaccessrulesenabled","description":"Boolean to determine whether or not to respect publicAccessRules"},"publicAccessRules":{"items":{"additionalProperties":true,"type":"object"},"type":"array","title":"Publicaccessrules","description":"Rules for require member registration to access private content"},"password":{"type":"string","title":"Password","description":"Set this to create a password protected page"},"enableGoogleAmpOutputOverride":{"type":"boolean","title":"Enablegoogleampoutputoverride","description":"Boolean to allow overriding the AMP settings for the blog"}},"type":"object","required":["id","publishDate","created","updated","archivedAt","language","translations","translatedFromId","name","slug","postBody","postSummary","metaDescription","htmlTitle","rssBody","rssSummary","blogAuthorId","authorName","contentGroupId","state","currentState","currentlyPublished","publishImmediately","contentTypeCategory","categoryId","createdById","updatedById","featuredImage","featuredImageAltText","useFeaturedImage","tagIds","campaign","domain","url","linkRelCanonicalUrl","enableLayoutStylesheets","enableDomainStylesheets","includeDefaultCustomCss","attachedStylesheets","headHtml","footerHtml","layoutSections","widgetContainers","widgets","themeSettingsValues","archivedInDashboard","pageExpiryEnabled","pageExpiryDate","pageExpiryRedirectId","pageExpiryRedirectUrl","dynamicPageDataSourceType","dynamicPageDataSourceId","dynamicPageHubDbTableId","abTestId","mabExperimentId","folderId","publicAccessRulesEnabled","publicAccessRules","password","enableGoogleAmpOutputOverride"],"title":"GetCmsPostResponse","description":"Complete CMS post response schema matching HubSpot API documentation\n\nThis schema includes all 60+ fields from the HubSpot API documentation\nfor retrieving a blog post by ID.\nReference: https://developers.hubspot.com/docs/api-reference/cms-posts-v3/basic/get-cms-v3-blogs-posts-objectId"},"GetCompanyResponse":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"associations":{"additionalProperties":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__AssociationCollection-Output"},"type":"object","title":"Associations","default":{}},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"GetCompanyResponse","description":"Response schema for getting a single company by ID"},"GetContactResponse":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":true,"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"associations":{"additionalProperties":true,"type":"object","title":"Associations","default":{}},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"GetContactResponse","description":"Response schema for getting a single contact by ID"},"GetPaymentResponse":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"associations":{"additionalProperties":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationCollection"},"type":"object","title":"Associations","default":{}},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"GetPaymentResponse","description":"Response schema for getting a single payment by ID"},"GoalListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/GoalResponse"},"type":"array","title":"Results","description":"List of goals"},"paging":{"$ref":"#/components/schemas/app__modules__crm_objects__goals__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"GoalListResponse","description":"Goals list response schema aligning with HubSpot format"},"GoalResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Goal ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Goal properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"GoalResponse","description":"Single goal response schema matching HubSpot format."},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"HubSpotAssetType":{"type":"string","enum":["AD_CAMPAIGN","BLOG_POST","SOCIAL_BROADCAST","WEB_INTERACTIVE","CTA","EXTERNAL_WEB_URL","FORM","LANDING_PAGE","MARKETING_EMAIL","MARKETING_EVENT","OBJECT_LIST","SITE_PAGE","AUTOMATION_PLATFORM_FLOW","MARKETING_SMS"],"title":"HubSpotAssetType","description":"Campaign asset types as documented in HubSpot Marketing Campaigns API.\n\nPer HubSpot API documentation, these values must be UPPERCASE.\nSee: https://developers.hubspot.com/docs/api/marketing/campaigns\n\nAsset Type Mapping:\n- AD_CAMPAIGN: Ad campaigns (No metrics available)\n- BLOG_POST: Blog posts\n- SOCIAL_BROADCAST: Social posts\n- WEB_INTERACTIVE: CTAs (new format)\n- CTA: CTAs (legacy format)\n- EXTERNAL_WEB_URL: External website pages\n- FORM: Forms\n- LANDING_PAGE: Landing pages\n- MARKETING_EMAIL: Emails\n- MARKETING_EVENT: Marketing events\n- OBJECT_LIST: Static lists\n- SITE_PAGE: Website pages\n- AUTOMATION_PLATFORM_FLOW: Workflows\n- MARKETING_SMS: Marketing SMS"},"InvoiceListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/InvoiceResponse"},"type":"array","title":"Results","description":"List of invoices"},"paging":{"$ref":"#/components/schemas/app__modules__crm_objects__invoices__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"InvoiceListResponse","description":"Invoices list response schema aligning with HubSpot format"},"InvoiceResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Invoice ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Invoice properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"InvoiceResponse","description":"Single invoice response schema matching HubSpot format."},"LanguageCode":{"type":"string","enum":["af","af-za","am","am-et","ar","ar-ae","ar-bh","ar-dz","ar-eg","ar-iq","ar-jo","ar-kw","ar-lb","ar-ly","ar-ma","ar-om","ar-qa","ar-sa","ar-sy","ar-tn","ar-ye","az","az-az","be","be-by","bg","bg-bg","bn","bn-bd","bn-in","bs","bs-ba","ca","ca-es","cs","cs-cz","cy","cy-gb","da","da-dk","de","de-at","de-ch","de-de","de-li","de-lu","el","el-gr","en","en-001","en-150","en-ae","en-ag","en-ai","en-as","en-at","en-au","en-bb","en-be","en-bi","en-bm","en-bs","en-bw","en-bz","en-ca","en-cc","en-ch","en-ck","en-cm","en-cx","en-cy","en-de","en-dg","en-dk","en-dm","en-er","en-fi","en-fj","en-fk","en-fm","en-gb","en-gd","en-gg","en-gh","en-gi","en-gm","en-gu","en-gy","en-hk","en-ie","en-il","en-im","en-in","en-io","en-je","en-jm","en-ke","en-ki","en-kn","en-ky","en-lc","en-lr","en-ls","en-mg","en-mh","en-mo","en-ms","en-mt","en-mu","en-mw","en-my","en-na","en-nf","en-ng","en-nl","en-nr","en-nu","en-nz","en-pg","en-ph","en-pk","en-pn","en-pr","en-pw","en-rw","en-sb","en-sc","en-sd","en-se","en-sg","en-sh","en-si","en-sl","en-ss","en-sx","en-sz","en-tc","en-tk","en-to","en-tt","en-tv","en-tz","en-ug","en-um","en-us","en-vc","en-vg","en-vi","en-vu","en-ws","en-za","en-zm","en-zw","es","es-419","es-ar","es-bo","es-br","es-bz","es-cl","es-co","es-cr","es-cu","es-do","es-ec","es-es","es-gq","es-gt","es-hn","es-mx","es-ni","es-pa","es-pe","es-ph","es-pr","es-py","es-sv","es-us","es-uy","es-ve","et","et-ee","eu","eu-es","fa","fa-ir","fi","fi-fi","fil","fil-ph","fo","fo-fo","fr","fr-be","fr-bf","fr-bi","fr-bj","fr-bl","fr-ca","fr-cd","fr-cf","fr-cg","fr-ch","fr-ci","fr-cm","fr-dj","fr-dz","fr-fr","fr-ga","fr-gf","fr-gn","fr-gp","fr-gq","fr-ht","fr-km","fr-lu","fr-ma","fr-mc","fr-mf","fr-mg","fr-ml","fr-mq","fr-mr","fr-mu","fr-nc","fr-ne","fr-pf","fr-pm","fr-re","fr-rw","fr-sc","fr-sn","fr-sy","fr-td","fr-tg","fr-tn","fr-vu","fr-wf","fr-yt","ga","ga-ie","gd","gd-gb","gl","gl-es","gu","gu-in","gv","gv-im","ha","ha-gh","ha-ne","ha-ng","he","he-il","hi","hi-in","hr","hr-ba","hr-hr","hu","hu-hu","hy","hy-am","id","id-id","ig","ig-ng","ii","ii-cn","is","is-is","it","it-ch","it-it","it-sm","it-va","ja","ja-jp","jv","jv-id","ka","ka-ge","ki","ki-ke","kk","kk-kz","kl","kl-gl","km","km-kh","kn","kn-in","ko","ko-kp","ko-kr","ks","ks-in","kw","kw-gb","ky","ky-kg","lb","lb-lu","lg","lg-ug","ln","ln-ao","ln-cd","ln-cf","ln-cg","lo","lo-la","lt","lt-lt","lu","lu-cd","lv","lv-lv","mg","mg-mg","mi","mi-nz","mk","mk-mk","ml","ml-in","mn","mn-mn","mr","mr-in","ms","ms-bn","ms-my","ms-sg","mt","mt-mt","my","my-mm","nb","nb-no","nd","nd-zw","ne","ne-in","ne-np","nl","nl-aw","nl-be","nl-bq","nl-cw","nl-nl","nl-sr","nl-sx","nn","nn-no","no","no-no","om","om-et","om-ke","or","or-in","os","os-ge","os-ru","pa","pa-in","pa-pk","pl","pl-pl","ps","ps-af","ps-pk","pt","pt-ao","pt-br","pt-ch","pt-cv","pt-gq","pt-gw","pt-lu","pt-mo","pt-mz","pt-pt","pt-st","pt-tl","qu","qu-bo","qu-ec","qu-pe","rm","rm-ch","rn","rn-bi","ro","ro-md","ro-ro","ru","ru-by","ru-kg","ru-kz","ru-md","ru-ru","ru-ua","rw","rw-rw","sa","sa-in","sc","sc-it","sd","sd-in","sd-pk","se","se-fi","se-no","se-se","sg","sg-cf","si","si-lk","sk","sk-sk","sl","sl-si","sn","sn-zw","so","so-dj","so-et","so-ke","so-so","sq","sq-al","sq-mk","sq-xk","sr","sr-ba","sr-me","sr-rs","sr-xk","sv","sv-ax","sv-fi","sv-se","sw","sw-cd","sw-ke","sw-tz","sw-ug","ta","ta-in","ta-lk","ta-my","ta-sg","te","te-in","tg","tg-tj","th","th-th","ti","ti-er","ti-et","tk","tk-tm","to","to-to","tr","tr-cy","tr-tr","tt","tt-ru","ug","ug-cn","uk","uk-ua","ur","ur-in","ur-pk","uz","uz-af","uz-uz","vi","vi-vn","vo","vo-001","vun","vun-tz","wae","wae-ch","wo","wo-sn","xh","xh-za","xog","xog-ug","yav","yav-cm","yo","yo-bj","yo-ng","yue","yue-cn","yue-hk","zgh","zgh-ma","zh","zh-cn","zh-hk","zh-mo","zh-sg","zh-tw","zh-hans","zh-hant","zu","zu-za"],"title":"LanguageCode","description":"HubSpot supported language codes (ISO 639-1 with optional country codes)\n\nBased on HubSpot API documentation, supports 150+ language codes.\nFormat: 2-letter language code (ISO 639-1) optionally followed by -COUNTRY (ISO 3166-1 alpha-2)\nExamples: en, es, fr, en-US, es-ES, pt-BR, zh-CN, etc."},"LanguageGroupResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the language group"},"primaryLanguage":{"type":"string","title":"Primarylanguage","description":"The primary language code"},"languages":{"items":{"type":"string"},"type":"array","title":"Languages","description":"List of language codes in the group"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"The timestamp when the group was created"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"The timestamp when the group was last updated"},"portalId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Portalid","description":"The portal ID"}},"type":"object","required":["id","primaryLanguage","languages","createdAt","updatedAt"],"title":"LanguageGroupResponse","description":"Language group response schema"},"LanguageVariationResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the language variation"},"language":{"type":"string","title":"Language","description":"The language code"},"languageGroupId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Languagegroupid","description":"The language group ID"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"The timestamp when the variation was created"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"The timestamp when the variation was last updated"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Language variation properties"},"portalId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Portalid","description":"The portal ID"}},"type":"object","required":["id","language","createdAt","updatedAt"],"title":"LanguageVariationResponse","description":"Language variation response schema"},"LeadAssociation":{"properties":{"types":{"items":{"$ref":"#/components/schemas/LeadAssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"},"to":{"$ref":"#/components/schemas/LeadAssociationTo","description":"Target object"}},"type":"object","required":["types","to"],"title":"LeadAssociation","description":"Association schema for lead creation"},"LeadAssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"LeadAssociationTo","description":"Association target schema for lead creation"},"LeadAssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__leads__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"LeadAssociationType","description":"Association type schema for lead creation"},"LeadListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ListLeadResponse-Output"},"type":"array","title":"Results","description":"List of leads"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__leads__schema__Paging"},{"type":"null"}],"description":"Pagination information; absent when no next page"}},"type":"object","required":["results"],"title":"LeadListResponse","description":"Leads list response schema matching HubSpot format"},"LeadResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Lead ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Lead properties"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdat","description":"Created at timestamp"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"LeadResponse","description":"Single lead response schema matching HubSpot format"},"LineItemListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/LineItemResponse"},"type":"array","title":"Results","description":"List of line items"},"paging":{"$ref":"#/components/schemas/app__modules__crm_objects__line_items__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"LineItemListResponse","description":"Line items list response schema matching HubSpot format"},"LineItemResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Line item ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Line item properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"LineItemResponse","description":"Single line item response schema matching HubSpot format"},"ListAssociationsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__AssociationResult-Output"},"type":"array","title":"Results","description":"Array of association results"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_associations__schema__Paging"},{"type":"null"}],"description":"Pagination information"}},"type":"object","required":["results"],"title":"ListAssociationsResponse","description":"Response schema for listing associations matching HubSpot v4 API format."},"ListCartsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/CartListItem-Output"},"type":"array","title":"Results"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__Paging"},{"type":"null"}]}},"type":"object","required":["results"],"title":"ListCartsResponse","description":"Response schema for listing carts"},"ListCompaniesResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/CompanyListItem"},"type":"array","title":"Results"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__Paging"},{"type":"null"}]}},"type":"object","required":["results"],"title":"ListCompaniesResponse","description":"Response schema for listing companies"},"ListContactsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ContactListItem"},"type":"array","title":"Results"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__crm_contact__schemas__contacts__Paging"},{"type":"null"}]}},"type":"object","required":["results"],"title":"ListContactsResponse","description":"Response schema for listing contacts"},"ListDealsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/DealListItem"},"type":"array","title":"Results"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__deals__schema__Paging"},{"type":"null"}]}},"type":"object","required":["results"],"title":"ListDealsResponse","description":"Response schema for listing deals"},"ListLeadResponse-Input":{"properties":{"id":{"type":"string","title":"Id","description":"Lead ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Lead properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"ListLeadResponse","description":"Single lead response schema matching HubSpot format"},"ListLeadResponse-Output":{"properties":{"id":{"type":"string","title":"Id","description":"Lead ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Lead properties"},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdat","description":"Created at timestamp"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"ListLeadResponse","description":"Single lead response schema matching HubSpot format"},"ListPaymentsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PaymentListItem-Output"},"type":"array","title":"Results"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__Paging"},{"type":"null"}]}},"type":"object","required":["results"],"title":"ListPaymentsResponse","description":"Response schema for listing payments"},"LogoMetadata":{"properties":{"logoUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logourl","description":"Logo URL"},"resizedUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Resizedurl","description":"Resized logo URL"},"logoAltText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Logoalttext","description":"Logo alt text"}},"type":"object","title":"LogoMetadata","description":"Logo metadata schema"},"MCPRequest":{"properties":{"jsonrpc":{"type":"string","title":"Jsonrpc","description":"JSON-RPC version (must be '2.0')","default":"2.0","examples":["2.0"]},"method":{"type":"string","title":"Method","description":"MCP method to call","examples":["initialize","tools/list","tools/call","resources/list","resources/read"]},"params":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Params","description":"Method parameters","default":{},"examples":[{},{"arguments":{"properties":{"email":"john.doe@example.com"}},"name":"create_contact"}]},"id":{"anyOf":[{"type":"string"},{"type":"integer"},{"type":"null"}],"title":"Id","description":"Request ID (omit for notifications)","examples":[1,"request-1"]}},"type":"object","required":["method"],"title":"MCPRequest","description":"JSON-RPC 2.0 request model for MCP protocol","examples":[{"id":1,"jsonrpc":"2.0","method":"tools/list","params":{}}]},"MergeTicketRequest":{"properties":{"objectIdToMerge":{"type":"string","title":"Objectidtomerge","description":"Secondary ticket ID to merge into primary"},"primaryObjectId":{"type":"string","title":"Primaryobjectid","description":"Primary ticket ID (will be the resulting record)"}},"type":"object","required":["objectIdToMerge","primaryObjectId"],"title":"MergeTicketRequest","description":"Request schema for merging two tickets used by the API router."},"MultiLanguageOperationResponse":{"properties":{"success":{"type":"boolean","title":"Success","description":"Whether the operation was successful"},"message":{"type":"string","title":"Message","description":"Operation result message"},"languageVariation":{"anyOf":[{"$ref":"#/components/schemas/LanguageVariationResponse"},{"type":"null"}],"description":"The language variation if created"},"languageGroup":{"anyOf":[{"$ref":"#/components/schemas/LanguageGroupResponse"},{"type":"null"}],"description":"The language group if modified"}},"type":"object","required":["success","message"],"title":"MultiLanguageOperationResponse","description":"Multi-language operation response schema"},"NoteListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/NoteResponse"},"type":"array","title":"Results","description":"List of notes"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__engagements__notes__schema__Paging"},{"type":"null"}],"description":"Pagination information"}},"type":"object","required":["results"],"title":"NoteListResponse","description":"Notes list response schema aligning with HubSpot format"},"NoteResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Note ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Note properties"},"createdAt":{"type":"string","title":"Createdat","description":"ISO 8601 creation timestamp"},"updatedAt":{"type":"string","title":"Updatedat","description":"ISO 8601 last update timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"ISO 8601 archived timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"NoteResponse","description":"Single note response schema matching HubSpot SimplePublicObject format."},"NumberDisplayHintEnum":{"type":"string","enum":["currency","duration","formatted","percentage","probability","unformatted"],"title":"NumberDisplayHintEnum","description":"Display hint options for number properties"},"OrderAssociation":{"properties":{"types":{"items":{"$ref":"#/components/schemas/OrderAssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"},"to":{"$ref":"#/components/schemas/OrderAssociationTo","description":"Target object"}},"type":"object","required":["types","to"],"title":"OrderAssociation","description":"Association schema for order creation"},"OrderAssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"OrderAssociationTo","description":"Association target schema for order creation"},"OrderAssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__orders__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"OrderAssociationType","description":"Association type schema for order creation"},"OrderListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/OrderResponse"},"type":"array","title":"Results","description":"List of orders"},"paging":{"$ref":"#/components/schemas/app__modules__crm_objects__orders__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"OrderListResponse","description":"Orders list response schema aligning with HubSpot format"},"OrderResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Order ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Order properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"OrderResponse","description":"Single order response schema matching HubSpot format."},"OrderWriteResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Order ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Order properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"OrderWriteResponse","description":"Write response schema for create/update operations — no associations field."},"PaymentEntity":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"PaymentEntity","description":"Entity response for payment operations"},"PaymentListItem-Input":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"associations":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationCollection"},"type":"object"},{"type":"null"}],"title":"Associations"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"PaymentListItem","description":"Single payment in list response"},"PaymentListItem-Output":{"properties":{"id":{"type":"string","title":"Id"},"properties":{"additionalProperties":{"anyOf":[{"type":"string"},{"type":"null"}]},"type":"object","title":"Properties"},"createdAt":{"type":"string","title":"Createdat"},"updatedAt":{"type":"string","title":"Updatedat"},"archived":{"type":"boolean","title":"Archived"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory"},"associations":{"anyOf":[{"additionalProperties":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationCollection"},"type":"object"},{"type":"null"}],"title":"Associations"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid"}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"PaymentListItem","description":"Single payment in list response"},"PipelineInput":{"properties":{"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"The order for displaying this pipeline. If two pipelines have a matching displayOrder, they will be sorted alphabetically by label. Omitted on create defaults to 0; omitted on replace leaves the existing value."},"label":{"type":"string","minLength":1,"title":"Label","description":"A unique label used to organize pipelines in HubSpot's UI"},"stages":{"items":{"$ref":"#/components/schemas/PipelineStageInput"},"type":"array","minItems":1,"title":"Stages","description":"Pipeline stage inputs used to create the new pipeline"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","description":"Whether the pipeline is archived. Omitted defaults to false on create; omitted on replace leaves the existing archived state."}},"type":"object","required":["label","stages"],"title":"PipelineInput","description":"Input schema for creating or replacing a pipeline (POST create, PUT replace)"},"PipelineResponse":{"properties":{"id":{"type":"string","title":"Id","description":"A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline"},"label":{"type":"string","title":"Label","description":"A unique label used to organize pipelines in HubSpot's UI"},"displayOrder":{"type":"integer","title":"Displayorder","description":"The order for displaying this pipeline"},"createdAt":{"type":"string","title":"Createdat","description":"The date the pipeline was created (ISO 8601 format)"},"updatedAt":{"type":"string","title":"Updatedat","description":"The date the pipeline was last updated (ISO 8601 format)"},"archived":{"type":"boolean","title":"Archived","description":"Whether the pipeline is archived","default":false},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"The date the pipeline was archived. Only present if archived (ISO 8601 format)"},"stages":{"items":{"$ref":"#/components/schemas/PipelineStageResponse"},"type":"array","title":"Stages","description":"Array of pipeline stage definitions"}},"type":"object","required":["id","label","displayOrder","createdAt","updatedAt","stages"],"title":"PipelineResponse","description":"Response schema for a pipeline"},"PipelineStageInput":{"properties":{"displayOrder":{"type":"integer","title":"Displayorder","description":"The order for displaying this pipeline stage"},"label":{"type":"string","minLength":1,"title":"Label","description":"A label used to organize pipeline stages in HubSpot's UI"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","title":"Metadata","description":"A JSON object containing properties that are not present on all object pipelines. For deals pipelines, the probability field is required. For tickets pipelines, the ticketState field is optional."},"stageId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Stageid","description":"Optional numeric string used as the stage id (stored as integer). Must be unique within the request and must not already be in use for this object type anywhere in the portal (any pipeline). Omit or use empty string for auto-generated ids."}},"type":"object","required":["displayOrder","label","metadata"],"title":"PipelineStageInput","description":"Input schema for creating a pipeline stage"},"PipelineStagePatchInput":{"properties":{"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","description":"Whether the pipeline stage is archived."},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"The order for displaying this pipeline stage. If two pipeline stages have a matching displayOrder, they will be sorted alphabetically by label."},"label":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Label","description":"A label used to organize pipeline stages in HubSpot's UI. Each pipeline stage's label must be unique within that pipeline."},"metadata":{"anyOf":[{"additionalProperties":{"type":"string"},"type":"object"},{"type":"null"}],"title":"Metadata","description":"A JSON object containing properties that are not present on all object pipelines."}},"type":"object","title":"PipelineStagePatchInput","description":"Input schema for updating a pipeline stage (partial update)"},"PipelineStageResponse":{"properties":{"id":{"type":"string","title":"Id","description":"A unique identifier generated by HubSpot that can be used to retrieve and update the pipeline stage"},"label":{"type":"string","title":"Label","description":"A label used to organize pipeline stages in HubSpot's UI"},"displayOrder":{"type":"integer","title":"Displayorder","description":"The order for displaying this pipeline stage"},"metadata":{"additionalProperties":{"type":"string"},"type":"object","title":"Metadata","description":"A JSON object containing properties that are not present on all object pipelines"},"createdAt":{"type":"string","title":"Createdat","description":"The date the pipeline stage was created (ISO 8601 format)"},"updatedAt":{"type":"string","title":"Updatedat","description":"The date the pipeline stage was last updated (ISO 8601 format)"},"archived":{"type":"boolean","title":"Archived","description":"Whether the pipeline stage is archived","default":false},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"The date the pipeline stage was archived. Only present if archived (ISO 8601 format)"},"writePermissions":{"anyOf":[{"type":"string","enum":["CRM_PERMISSIONS_ENFORCEMENT","READ_ONLY","INTERNAL_ONLY"]},{"type":"null"}],"title":"Writepermissions","description":"Defines the level of write access for the pipeline stage, with possible values being CRM_PERMISSIONS_ENFORCEMENT, READ_ONLY, or INTERNAL_ONLY"}},"type":"object","required":["id","label","displayOrder","metadata","createdAt","updatedAt"],"title":"PipelineStageResponse","description":"Response schema for a pipeline stage"},"PipelineUpdateRequest":{"properties":{"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","description":"Whether the pipeline is archived. This property should only be provided when restoring an archived pipeline. If it's provided in any other call, the request will fail and a 400 Bad Request will be returned."},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"The order for displaying this pipeline (int32). If two pipelines have a matching displayOrder, they will be sorted alphabetically by label."},"label":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Label","description":"A unique label used to organize pipelines in HubSpot's UI"}},"type":"object","title":"PipelineUpdateRequest","description":"Request schema for updating a pipeline (partial update)"},"PostState":{"type":"string","enum":["DRAFT","PUBLISHED","SCHEDULED","PAGE_STUB"],"title":"PostState","description":"Valid state values for CMS posts"},"ProductListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ProductResponse"},"type":"array","title":"Results","description":"List of products"},"paging":{"$ref":"#/components/schemas/app__modules__crm_objects__products__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"ProductListResponse","description":"Products list response schema matching HubSpot format"},"ProductResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Product ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Product properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations (null for update operations)"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"ProductResponse","description":"Single product response schema matching HubSpot format"},"PropertyCreateRequest":{"properties":{"groupName":{"type":"string","title":"Groupname","description":"Property group name (must exist)"},"name":{"type":"string","title":"Name","description":"Internal property name (lowercase, alphanumeric, underscores)"},"label":{"type":"string","title":"Label","description":"Human-readable label for HubSpot UI"},"type":{"$ref":"#/components/schemas/PropertyTypeEnum","description":"Property type: bool, enumeration, date, datetime, string, number, phone_number"},"fieldType":{"$ref":"#/components/schemas/FieldTypeEnum","description":"Field type: booleancheckbox, calculation_equation, checkbox, date, file, html, number, phonenumber, radio, select, text, textarea"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Property description"},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"Display order (-1 for last position)","default":-1},"hidden":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hidden","description":"Whether property is hidden in UI","default":false},"formField":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Formfield","description":"Whether property appears in forms","default":true},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOptionSchema"},"type":"array"},{"type":"null"}],"title":"Options","description":"Options for enumeration/select/checkbox types"},"hasUniqueValue":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hasuniquevalue","description":"Whether property is a unique identifier","default":false},"calculationFormula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculationformula","description":"Formula for calculation_equation fieldType"},"externalOptions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Externaloptions","description":"Whether options come from external source","default":false},"showCurrencySymbol":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showcurrencysymbol","description":"For number properties displaying currency"},"currencyPropertyName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currencypropertyname","description":"The property that stores the currency code for currency-formatted number properties"},"numberDisplayHint":{"anyOf":[{"$ref":"#/components/schemas/NumberDisplayHintEnum"},{"type":"null"}],"description":"Display hint for number fields: currency, duration, formatted, percentage, probability, unformatted"},"referencedObjectType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referencedobjecttype","description":"Should be set to 'OWNER' when 'externalOptions' is true, which causes the property to dynamically pull option values from the current HubSpot users"},"dataSensitivity":{"anyOf":[{"$ref":"#/components/schemas/DataSensitivityEnum"},{"type":"null"}],"description":"Data sensitivity level: non_sensitive, sensitive, highly_sensitive"}},"type":"object","required":["groupName","name","label","type","fieldType"],"title":"PropertyCreateRequest","description":"Request schema for creating a property"},"PropertyGetResponse":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"type":{"$ref":"#/components/schemas/PropertyTypeEnum"},"fieldType":{"$ref":"#/components/schemas/FieldTypeEnum"},"groupName":{"type":"string","title":"Groupname"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"displayOrder":{"type":"integer","title":"Displayorder"},"hidden":{"type":"boolean","title":"Hidden"},"archived":{"type":"boolean","title":"Archived"},"formField":{"type":"boolean","title":"Formfield"},"hasUniqueValue":{"type":"boolean","title":"Hasuniquevalue"},"options":{"anyOf":[{},{"type":"null"}],"title":"Options"},"calculationFormula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculationformula"},"externalOptions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Externaloptions"},"showCurrencySymbol":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showcurrencysymbol"},"currencyPropertyName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currencypropertyname"},"numberDisplayHint":{"anyOf":[{"$ref":"#/components/schemas/NumberDisplayHintEnum"},{"type":"null"}]},"referencedObjectType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referencedobjecttype"},"dataSensitivity":{"$ref":"#/components/schemas/DataSensitivityEnum","default":"non_sensitive"},"hubspotDefined":{"type":"boolean","title":"Hubspotdefined","default":false},"calculated":{"type":"boolean","title":"Calculated","default":false},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdat"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedat"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"createdUserId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createduserid"},"updatedUserId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updateduserid"},"dateDisplayHint":{"$ref":"#/components/schemas/DateDisplayHintEnum","default":"absolute"},"sensitiveDataCategories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sensitivedatacategories"},"modificationMetadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Modificationmetadata"}},"type":"object","required":["name","label","type","fieldType","groupName","displayOrder","hidden","archived","formField","hasUniqueValue"],"title":"PropertyGetResponse","description":"Response schema for getting a single property"},"PropertyGroupCreateRequest":{"properties":{"name":{"type":"string","title":"Name","description":"Internal property group name (lowercase, underscores allowed)"},"label":{"type":"string","title":"Label","description":"Human-readable label for HubSpot UI"},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"Display order (-1 for last, positive integers for ordering)","default":-1}},"type":"object","required":["name","label"],"title":"PropertyGroupCreateRequest","description":"Request schema for creating a property group"},"PropertyGroupEntity":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"displayOrder":{"type":"integer","title":"Displayorder"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","default":false}},"type":"object","required":["name","label","displayOrder"],"title":"PropertyGroupEntity","description":"Entity response for property group operations"},"PropertyGroupGetResponse":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"displayOrder":{"type":"integer","title":"Displayorder"},"archived":{"type":"boolean","title":"Archived"}},"type":"object","required":["name","label","displayOrder","archived"],"title":"PropertyGroupGetResponse","description":"Response schema for getting a single property group"},"PropertyGroupUpdateRequest":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Human-readable label for HubSpot UI"},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"Display order (-1 for last, positive integers for ordering)"}},"type":"object","title":"PropertyGroupUpdateRequest","description":"Request schema for updating a property group (partial update)"},"PropertyGroupUpdateResponse":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"displayOrder":{"type":"integer","title":"Displayorder"},"archived":{"type":"boolean","title":"Archived"}},"type":"object","required":["name","label","displayOrder","archived"],"title":"PropertyGroupUpdateResponse","description":"Response schema for updating a property group"},"PropertyOptionSchema":{"properties":{"label":{"type":"string","title":"Label","description":"Display label for the option"},"value":{"type":"string","title":"Value","description":"Internal value for the option"},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"Display order for the option"},"hidden":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hidden","description":"Whether option is hidden","default":false},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Option description"}},"type":"object","required":["label","value"],"title":"PropertyOptionSchema","description":"Schema for enumeration property options"},"PropertyRulesResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PropertyValidationRule"},"type":"array","title":"Results","description":"List of validation rules for the property"}},"type":"object","required":["results"],"title":"PropertyRulesResponse","description":"Response schema for GET specific property validation rules"},"PropertyTypeEnum":{"type":"string","enum":["bool","enumeration","date","datetime","string","number","phone_number"],"title":"PropertyTypeEnum","description":"Property data types"},"PropertyUpdateRequest":{"properties":{"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"Human-readable label"},"groupName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Groupname","description":"Property group name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description","description":"Property description"},"displayOrder":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Displayorder","description":"Display order"},"hidden":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Hidden","description":"Hidden in UI"},"formField":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Formfield","description":"Can be used in forms"},"options":{"anyOf":[{"items":{"$ref":"#/components/schemas/PropertyOptionSchema"},"type":"array"},{"type":"null"}],"title":"Options","description":"Valid options for enumeration"},"calculationFormula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculationformula","description":"Formula for calculated properties"},"type":{"anyOf":[{"$ref":"#/components/schemas/PropertyTypeEnum"},{"type":"null"}],"description":"Property type"},"fieldType":{"anyOf":[{"$ref":"#/components/schemas/FieldTypeEnum"},{"type":"null"}],"description":"Field type"}},"type":"object","title":"PropertyUpdateRequest","description":"Request schema for updating a property (partial update)"},"PropertyUpdateResponse":{"properties":{"name":{"type":"string","title":"Name"},"label":{"type":"string","title":"Label"},"type":{"$ref":"#/components/schemas/PropertyTypeEnum"},"fieldType":{"$ref":"#/components/schemas/FieldTypeEnum"},"groupName":{"type":"string","title":"Groupname"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"displayOrder":{"type":"integer","title":"Displayorder"},"hidden":{"type":"boolean","title":"Hidden"},"archived":{"type":"boolean","title":"Archived"},"formField":{"type":"boolean","title":"Formfield"},"hasUniqueValue":{"type":"boolean","title":"Hasuniquevalue"},"options":{"anyOf":[{},{"type":"null"}],"title":"Options"},"calculationFormula":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Calculationformula"},"externalOptions":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Externaloptions"},"showCurrencySymbol":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Showcurrencysymbol"},"currencyPropertyName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Currencypropertyname"},"numberDisplayHint":{"anyOf":[{"$ref":"#/components/schemas/NumberDisplayHintEnum"},{"type":"null"}]},"referencedObjectType":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Referencedobjecttype"},"dataSensitivity":{"$ref":"#/components/schemas/DataSensitivityEnum","default":"non_sensitive"},"hubspotDefined":{"type":"boolean","title":"Hubspotdefined","default":false},"calculated":{"type":"boolean","title":"Calculated","default":false},"createdAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdat"},"updatedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedat"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat"},"createdUserId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createduserid"},"updatedUserId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updateduserid"},"dateDisplayHint":{"$ref":"#/components/schemas/DateDisplayHintEnum","default":"absolute"},"sensitiveDataCategories":{"anyOf":[{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Sensitivedatacategories"},"modificationMetadata":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Modificationmetadata","description":"Metadata: archivable, readOnlyDefinition, readOnlyOptions, readOnlyValue"}},"type":"object","required":["name","label","type","fieldType","groupName","displayOrder","hidden","archived","formField","hasUniqueValue"],"title":"PropertyUpdateResponse","description":"Response schema for updating a property"},"PropertyValidationRule":{"properties":{"ruleType":{"$ref":"#/components/schemas/RuleTypeEnum","description":"Validation rule type (e.g., FORMAT)"},"ruleArguments":{"items":{"type":"string"},"type":"array","title":"Rulearguments","description":"Arguments for the validation rule"}},"type":"object","required":["ruleType","ruleArguments"],"title":"PropertyValidationRule","description":"Single validation rule schema"},"PropertyValidationRuleResponse":{"properties":{"ruleType":{"$ref":"#/components/schemas/RuleTypeEnum","description":"Validation rule type (e.g., FORMAT, MAX_LENGTH)"},"ruleArguments":{"items":{"type":"string"},"type":"array","title":"Rulearguments","description":"Arguments for the validation rule"}},"type":"object","required":["ruleType","ruleArguments"],"title":"PropertyValidationRuleResponse","description":"Response schema for single validation rule"},"PropertyValidationsResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/PropertyWithValidations-Output"},"type":"array","title":"Results","description":"List of properties with validation rules"}},"type":"object","required":["results"],"title":"PropertyValidationsResponse","description":"Response schema for GET property validations endpoint (all object validations)"},"PropertyWithValidations-Input":{"properties":{"objectType":{"type":"string","title":"Objecttype","description":"Object type"},"propertyName":{"type":"string","title":"Propertyname","description":"Property name"},"propertyValidationRules":{"items":{"$ref":"#/components/schemas/PropertyValidationRule"},"type":"array","title":"Propertyvalidationrules","description":"List of validation rules for this property"}},"type":"object","required":["objectType","propertyName","propertyValidationRules"],"title":"PropertyWithValidations","description":"Property with its validation rules"},"PropertyWithValidations-Output":{"properties":{"objectType":{"type":"string","title":"Objecttype","description":"Object type"},"propertyName":{"type":"string","title":"Propertyname","description":"Property name"},"propertyValidationRules":{"items":{"$ref":"#/components/schemas/PropertyValidationRule"},"type":"array","title":"Propertyvalidationrules","description":"List of validation rules for this property"}},"type":"object","required":["objectType","propertyName","propertyValidationRules"],"title":"PropertyWithValidations","description":"Property with its validation rules"},"QuoteListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/QuoteResponse"},"type":"array","title":"Results","description":"List of quotes"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__quotes__schema__Paging"},{"type":"null"}],"description":"Pagination information"}},"type":"object","required":["results"],"title":"QuoteListResponse","description":"Quotes list response schema matching HubSpot format"},"QuoteResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Quote ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Quote properties"},"createdAt":{"type":"string","title":"Createdat","description":"Created at timestamp in ISO 8601 format"},"updatedAt":{"type":"string","title":"Updatedat","description":"Updated at timestamp in ISO 8601 format"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp in ISO 8601 format"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"An identifier used for tracing the creation or update request of the object"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"QuoteResponse","description":"Single quote response schema matching HubSpot SimplePublicObjectWithAssociations"},"QuoteUpdateResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Quote ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Quote properties"},"createdAt":{"type":"string","title":"Createdat","description":"Created at timestamp in ISO 8601 format"},"updatedAt":{"type":"string","title":"Updatedat","description":"Updated at timestamp in ISO 8601 format"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp in ISO 8601 format"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"An identifier used for tracing the write request for the object"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"QuoteUpdateResponse","description":"Response schema for updating a quote - excludes associations per HubSpot docs"},"ReadDealResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Deal ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Deal properties"},"createdAt":{"type":"string","title":"Createdat","description":"Created at timestamp in ISO 8601 format"},"updatedAt":{"type":"string","title":"Updatedat","description":"Updated at timestamp in ISO 8601 format"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"ReadDealResponse","description":"Response schema for reading a single deal matching HubSpot format"},"RefreshTokenMetadataResponse":{"properties":{"token":{"type":"string","title":"Token","description":"Refresh token"},"client_id":{"type":"string","title":"Client Id","description":"Client ID"},"portal_id":{"type":"integer","title":"Portal Id","description":"Portal ID (tenant identifier)"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"OAuth scopes"},"token_type":{"type":"string","title":"Token Type","description":"Token type"},"user_id":{"type":"integer","title":"User Id","description":"User ID"},"hub_domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hub Domain","description":"Hub domain"},"user":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User","description":"User email"}},"type":"object","required":["token","client_id","portal_id","scopes","token_type","user_id"],"title":"RefreshTokenMetadataResponse","description":"Refresh token metadata response schema matching HubSpot format"},"RestoreRevisionRequest":{"properties":{"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Properties to restore"},"associations":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Associations","description":"Associations to restore"}},"type":"object","title":"RestoreRevisionRequest","description":"Restore revision request schema"},"RuleTypeEnum":{"type":"string","enum":["FORMAT","ALPHANUMERIC","MAX_LENGTH","MIN_LENGTH","MIN_NUMBER","MAX_NUMBER","START_DATE","END_DATE","SPECIAL_CHARACTERS","WHITESPACE","DECIMAL","BEFORE_DURATION","AFTER_DURATION","DAYS_OF_WEEK","REGEX","START_DATETIME","END_DATETIME","BEFORE_DATETIME_DURATION","AFTER_DATETIME_DURATION","PHONE_NUMBER_WITH_EXPLICIT_COUNTRY_CODE","URL","URL_ALLOWED_DOMAINS","URL_BLOCKED_DOMAINS","EMAIL","EMAIL_ALLOWED_DOMAINS","EMAIL_BLOCKED_DOMAINS","DOMAIN"],"title":"RuleTypeEnum","description":"Enum for all validation rule types from HubSpot API"},"SQLQueryRequest":{"properties":{"query":{"type":"string","minLength":1,"title":"Query","description":"SQL query to execute"}},"type":"object","required":["query"],"title":"SQLQueryRequest","description":"Request model for executing SQL queries"},"ScheduleCmsPostRequest":{"properties":{"id":{"type":"string","title":"Id","description":"The ID of the object to be scheduled"},"publishDate":{"type":"string","format":"date-time","title":"Publishdate","description":"The date the object should transition from scheduled to published"}},"type":"object","required":["id","publishDate"],"title":"ScheduleCmsPostRequest","description":"Schedule CMS post request schema - matches HubSpot API spec"},"ServiceListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/ServiceResponse"},"type":"array","title":"Results","description":"List of services"},"paging":{"$ref":"#/components/schemas/app__modules__crm_objects__services__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"ServiceListResponse","description":"Services list response schema matching HubSpot format"},"ServiceResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Service ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Service properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"ServiceResponse","description":"Single service response schema matching HubSpot format"},"SetCompanyCurrencyRequest":{"properties":{"currencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"Currency code (e.g., USD, EUR)"}},"type":"object","required":["currencyCode"],"title":"SetCompanyCurrencyRequest","description":"Request schema for setting company currency matching HubSpot format"},"SetNewLangPrimaryRequest":{"properties":{"language":{"type":"string","maxLength":10,"minLength":2,"title":"Language","description":"The language code to set as primary"}},"type":"object","required":["language"],"title":"SetNewLangPrimaryRequest","description":"Set new language primary request schema"},"SignedAccessToken":{"properties":{"expiresAt":{"type":"integer","title":"Expiresat","description":"Token expiration timestamp"},"scopes":{"type":"string","title":"Scopes","description":"Base64 encoded scopes"},"portalId":{"type":"integer","title":"Portalid","description":"Portal ID (tenant identifier)"},"userId":{"type":"integer","title":"Userid","description":"User ID"},"appId":{"type":"integer","title":"Appid","description":"Application ID"},"signature":{"type":"string","title":"Signature","description":"Token signature"},"scopeToScopeGroupPks":{"type":"string","title":"Scopetoscopegrouppks","description":"Scope to scope group mapping"},"newSignature":{"type":"string","title":"Newsignature","description":"New signature"},"hublet":{"type":"string","title":"Hublet","description":"Hub region"},"trialScopes":{"type":"string","title":"Trialscopes","description":"Trial scopes"},"trialScopeToScopeGroupPks":{"type":"string","title":"Trialscopetoscopegrouppks","description":"Trial scope mapping"},"isUserLevel":{"type":"boolean","title":"Isuserlevel","description":"Whether token is user level"}},"type":"object","required":["expiresAt","scopes","portalId","userId","appId","signature","scopeToScopeGroupPks","newSignature","hublet","trialScopes","trialScopeToScopeGroupPks","isUserLevel"],"title":"SignedAccessToken","description":"Signed access token metadata"},"StatusEnum":{"type":"string","enum":["PENDING","PROCESSING","CANCELED","COMPLETE"],"title":"StatusEnum","description":"Status enumeration for batch operations"},"TaskListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/TaskResponse"},"type":"array","title":"Results","description":"List of tasks"},"paging":{"$ref":"#/components/schemas/app__modules__engagements__tasks__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"TaskListResponse","description":"Tasks list response schema aligning with HubSpot format"},"TaskResponse":{"properties":{"id":{"type":"string","title":"Id","description":"The unique ID of the object."},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Key-value pairs representing the properties of the object."},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"The timestamp when the object was created, in ISO 8601 format."},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"The timestamp when the object was last updated, in ISO 8601 format."},"archived":{"type":"boolean","title":"Archived","description":"Whether the object is archived."},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"The timestamp when the object was archived, in ISO 8601 format."},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Associated objects by type"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Key-value pairs representing the properties of the object along with their history."},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"An identifier used for tracing the write request for the object."}},"type":"object","required":["id","properties","createdAt","updatedAt","archived"],"title":"TaskResponse","description":"Single task response schema matching HubSpot SimplePublicObject."},"TaxListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/TaxResponse"},"type":"array","title":"Results","description":"List of taxes"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__taxes__schema__Paging"},{"type":"null"}],"description":"Pagination information"}},"type":"object","required":["results"],"title":"TaxListResponse","description":"Taxes list response schema matching HubSpot format"},"TaxResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Tax ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Tax properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"TaxResponse","description":"Single tax response schema matching HubSpot format"},"TaxWriteResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Tax ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Tax properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"TaxWriteResponse","description":"Response schema for create and update operations — no associations field"},"TicketListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/TicketResponse"},"type":"array","title":"Results","description":"List of tickets"},"paging":{"$ref":"#/components/schemas/app__modules__crm_objects__tickets__schema__Paging","description":"Pagination information"}},"type":"object","required":["results","paging"],"title":"TicketListResponse","description":"Tickets list response schema matching HubSpot format"},"TicketResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Ticket ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Ticket properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"TicketResponse","description":"Single ticket response schema matching HubSpot format"},"TokenResponse":{"properties":{"accessToken":{"type":"string","title":"Accesstoken","description":"Access token"},"expiresIn":{"type":"integer","title":"Expiresin","description":"Token expiration time in seconds"},"portalId":{"type":"integer","title":"Portalid","description":"Portal ID (tenant identifier)"},"idToken":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Idtoken","description":"ID token"},"scopes":{"items":{"type":"string"},"type":"array","title":"Scopes","description":"OAuth scopes"},"tokenType":{"type":"string","title":"Tokentype","description":"Token type","default":"bearer"},"userId":{"type":"integer","title":"Userid","description":"User ID"}},"type":"object","required":["accessToken","expiresIn","portalId","scopes","userId"],"title":"TokenResponse","description":"OAuth token response schema matching HubSpot format"},"UpdateBlogTagRequest":{"properties":{"name":{"anyOf":[{"type":"string","minLength":1},{"type":"null"}],"title":"Name","description":"The name of the tag"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The URL slug of the tag"},"language":{"anyOf":[{"$ref":"#/components/schemas/LanguageCode"},{"type":"null"}],"description":"The ISO 639 language code"},"deletedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Deletedat","description":"Deleted at timestamp (ISO 8601)"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created","description":"Created timestamp (ISO 8601)"},"updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated","description":"Updated timestamp (ISO 8601)"},"translatedFromId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Translatedfromid","description":"ID of primary tag this was translated from"}},"type":"object","title":"UpdateBlogTagRequest","description":"Request schema for updating a blog tag - matches HubSpot API v3"},"UpdateCallRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Call properties to update"}},"type":"object","required":["properties"],"title":"UpdateCallRequest","description":"Request schema for updating a call"},"UpdateCampaignBudgetItemRequest":{"properties":{"amount":{"type":"number","exclusiveMinimum":0.0,"title":"Amount","description":"Amount to record for the spend item (must be a number, not boolean)"},"name":{"type":"string","maxLength":256,"minLength":1,"title":"Name","description":"Name of the spend item"},"order":{"type":"integer","minimum":0.0,"title":"Order","description":"Order in which this spend item should appear (must be an integer, not boolean)"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Description","description":"Optional description of the spend item"}},"type":"object","required":["amount","name","order"],"title":"UpdateCampaignBudgetItemRequest","description":"Body schema for PUT /marketing/v3/campaigns/{campaignGuid}/budget/{budgetId}."},"UpdateCampaignPayload":{"properties":{"properties":{"$ref":"#/components/schemas/UpdateCampaignProperties","description":"Campaign properties to update"}},"type":"object","required":["properties"],"title":"UpdateCampaignPayload","description":"Request body for PATCH /marketing/v3/campaigns/{campaignGuid}"},"UpdateCampaignProperties":{"properties":{"hs_start_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Hs Start Date","description":"Start date (YYYY-MM-DD)"},"hs_end_date":{"anyOf":[{"type":"string","format":"date"},{"type":"null"}],"title":"Hs End Date","description":"End date (YYYY-MM-DD)"},"hs_notes":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hs Notes","description":"Campaign notes"},"hs_audience":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hs Audience","description":"Target audience"},"hs_currency_code":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Hs Currency Code","description":"ISO currency code (e.g., USD, EUR)"},"hs_campaign_status":{"anyOf":[{"$ref":"#/components/schemas/CampaignStatus"},{"type":"null"}],"description":"Campaign status"},"hs_utm":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Hs Utm","description":"UTM values"},"hs_name":{"anyOf":[{"type":"string","maxLength":256,"minLength":1},{"type":"null"}],"title":"Hs Name","description":"Campaign name (optional for updates)"}},"additionalProperties":true,"type":"object","title":"UpdateCampaignProperties","description":"Campaign properties for partial updates"},"UpdateCampaignSpendItemRequest":{"properties":{"amount":{"type":"number","exclusiveMinimum":0.0,"title":"Amount","description":"Amount to record for the spend item (must be a number, not boolean)"},"name":{"type":"string","maxLength":256,"minLength":1,"title":"Name","description":"Name of the spend item"},"order":{"type":"integer","minimum":0.0,"title":"Order","description":"Order in which this spend item should appear (must be an integer, not boolean)"},"description":{"anyOf":[{"type":"string","maxLength":512},{"type":"null"}],"title":"Description","description":"Optional description of the spend item"}},"type":"object","required":["amount","name","order"],"title":"UpdateCampaignSpendItemRequest","description":"Body schema for PUT /marketing/v3/campaigns/{campaignGuid}/spend/{spendId}."},"UpdateCartRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Cart property values to set. Accepts any type (strings, numbers, booleans, etc.) as per HubSpot docs. Empty strings clear properties."}},"type":"object","required":["properties"],"title":"UpdateCartRequest","description":"Request schema for updating a cart"},"UpdateCmsPostRequest":{"properties":{"publishDate":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Publishdate","description":"Publish date in ISO 8601 format"},"language":{"anyOf":[{"$ref":"#/components/schemas/LanguageCode"},{"type":"null"}],"description":"Language code (ISO 639-1 with optional country code, e.g., 'en', 'es', 'en-US', 'pt-BR')"},"enableLayoutStylesheets":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enablelayoutstylesheets","description":"Boolean to determine whether or not the styles from the template should be applied"},"metaDescription":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Metadescription","description":"A description that goes in <meta> tag on the page"},"attachedStylesheets":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Attachedstylesheets","description":"List of stylesheets to attach to this blog post"},"password":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Password","description":"Set this to create a password protected page"},"htmlTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Htmltitle","description":"The HTML title of the post"},"publishImmediately":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publishimmediately","description":"Set this to true if you want to be published immediately when the schedule publish endpoint is called"},"translations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Translations","description":"Translations object"},"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"The unique ID of the blog post"},"state":{"anyOf":[{"$ref":"#/components/schemas/PostState"},{"type":"null"}],"description":"An enumeration describing the current publish state of the post"},"slug":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Slug","description":"The URL slug of the blog post"},"createdById":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Createdbyid","description":"The ID of the user that created the post"},"rssBody":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rssbody","description":"The contents of the RSS body for this Blog Post"},"currentlyPublished":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Currentlypublished","description":"Currently published status"},"archivedInDashboard":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archivedindashboard","description":"If True, the post will not show up in your dashboard"},"created":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Created","description":"Created timestamp in ISO 8601 format"},"contentTypeCategory":{"anyOf":[{"$ref":"#/components/schemas/ContentTypeCategory"},{"type":"null"}],"description":"An ENUM describing the type of this object. Should always be BLOG_POST (0)"},"mabExperimentId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Mabexperimentid","description":"MAB experiment ID"},"updatedById":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updatedbyid","description":"The ID of the user that updated the post"},"translatedFromId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Translatedfromid","description":"ID of the primary blog post that this post was translated from"},"folderId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Folderid","description":"Folder ID"},"widgetContainers":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Widgetcontainers","description":"A data structure containing the data for all the modules inside the containers for this post"},"pageExpiryRedirectId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pageexpiryredirectid","description":"Page expiry redirect ID"},"dynamicPageDataSourceType":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Dynamicpagedatasourcetype","description":"Dynamic page data source type"},"featuredImage":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featuredimage","description":"The featuredImage of this Blog Post"},"authorName":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Authorname","description":"The name of the blog author associated with the post"},"domain":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Domain","description":"The domain that the post lives on"},"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name","description":"The internal name of the post"},"dynamicPageHubDbTableId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamicpagehubdbtableid","description":"For dynamic HubDB pages, the ID of the HubDB table this post references"},"campaign":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Campaign","description":"The GUID of the marketing campaign the post is associated with"},"dynamicPageDataSourceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Dynamicpagedatasourceid","description":"Dynamic page data source ID"},"enableDomainStylesheets":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enabledomainstylesheets","description":"Boolean to determine whether or not the styles from the template should be applied"},"includeDefaultCustomCss":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Includedefaultcustomcss","description":"Boolean to determine whether or not the Primary CSS Files should be applied"},"layoutSections":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Layoutsections","description":"Layout sections"},"updated":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Updated","description":"Updated timestamp in ISO 8601 format"},"footerHtml":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Footerhtml","description":"Custom HTML for embed codes, javascript that should be placed before the </body> tag"},"tagIds":{"anyOf":[{"items":{"type":"integer"},"type":"array"},{"type":"null"}],"title":"Tagids","description":"The IDs of the tags associated with this post"},"widgets":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Widgets","description":"A data structure containing the data for all the modules for this page"},"postSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postsummary","description":"The summary of the blog post that will appear on the main listing page"},"headHtml":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Headhtml","description":"Custom HTML for embed codes, javascript, etc. that goes in the <head> tag"},"pageExpiryRedirectUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Pageexpiryredirecturl","description":"Page expiry redirect URL"},"abStatus":{"anyOf":[{"$ref":"#/components/schemas/AbStatus"},{"type":"null"}],"description":"AB status: master, variant, loser_variant, mab_master, mab_variant, automated_master, automated_variant, automated_loser_variant"},"useFeaturedImage":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Usefeaturedimage","description":"Boolean to determine if this post should use a featured image"},"abTestId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Abtestid","description":"AB test ID"},"featuredImageAltText":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Featuredimagealttext","description":"Alt Text of the featuredImage"},"blogAuthorId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Blogauthorid","description":"The ID of the blog author associated with this post"},"contentGroupId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Contentgroupid","description":"The ID of the post's parent blog"},"rssSummary":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rsssummary","description":"The contents of the RSS summary for this Blog Post"},"pageExpiryEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Pageexpiryenabled","description":"Page expiry enabled"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url","description":"A generated field representing the URL of this blog post"},"enableGoogleAmpOutputOverride":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Enablegoogleampoutputoverride","description":"Boolean to allow overriding the AMP settings for the blog"},"publicAccessRules":{"anyOf":[{"items":{"additionalProperties":true,"type":"object"},"type":"array"},{"type":"null"}],"title":"Publicaccessrules","description":"Rules for require member registration to access private content"},"archivedAt":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Archivedat","description":"The timestamp (ISO8601 format) when this Blog Post was deleted"},"postBody":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Postbody","description":"The HTML of the main post body"},"themeSettingsValues":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Themesettingsvalues","description":"Theme settings values"},"pageExpiryDate":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Pageexpirydate","description":"Page expiry date"},"publicAccessRulesEnabled":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Publicaccessrulesenabled","description":"Boolean to determine whether or not to respect publicAccessRules"},"currentState":{"anyOf":[{"$ref":"#/components/schemas/CurrentState"},{"type":"null"}],"description":"A generated ENUM describing the current state of this Blog Post"},"categoryId":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Categoryid","description":"ID of the object type"},"linkRelCanonicalUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Linkrelcanonicalurl","description":"Optional override to set the URL to be used in the rel=canonical link tag on the page"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","description":"Whether to archive or unarchive this blog post"}},"additionalProperties":true,"type":"object","title":"UpdateCmsPostRequest","description":"Update CMS post request schema - matches HubSpot API v3 documentation exactly\n\nAll fields are at the top level per HubSpot API specification.\nAll fields are optional for partial updates (PATCH operation)."},"UpdateDealRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Deal properties to update"}},"type":"object","required":["properties"],"title":"UpdateDealRequest","description":"Request schema for updating a deal"},"UpdateDealResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Deal ID"},"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Deal properties"},"createdAt":{"type":"string","title":"Createdat","description":"Created at timestamp in ISO 8601 format"},"updatedAt":{"type":"string","title":"Updatedat","description":"Updated at timestamp in ISO 8601 format"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":{"items":{"additionalProperties":true,"type":"object"},"type":"array"},"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace identifier"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"UpdateDealResponse","description":"Response schema for updating a deal matching HubSpot format"},"UpdateExchangeRateRequest":{"properties":{"conversionRate":{"type":"number","exclusiveMinimum":0.0,"title":"Conversionrate","description":"Conversion rate as number"},"effectiveAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Effectiveat","description":"Effective date (ISO 8601). If not provided, existing value is preserved. Cannot be None. Must be past or present."}},"type":"object","required":["conversionRate"],"title":"UpdateExchangeRateRequest","description":"Request schema for updating an exchange rate matching HubSpot format"},"UpdateGoalRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Goal properties to update"}},"type":"object","required":["properties"],"title":"UpdateGoalRequest","description":"Request schema for updating a goal target"},"UpdateInvoiceRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Invoice properties to update"}},"type":"object","required":["properties"],"title":"UpdateInvoiceRequest","description":"Request schema for updating an invoice"},"UpdateLanguagesRequest":{"properties":{"languages":{"items":{"type":"string"},"type":"array","minItems":1,"title":"Languages","description":"List of language codes"}},"type":"object","required":["languages"],"title":"UpdateLanguagesRequest","description":"Update languages request schema"},"UpdateLeadRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Lead properties to update"}},"type":"object","required":["properties"],"title":"UpdateLeadRequest","description":"Request schema for updating a lead"},"UpdateLineItemRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Line item properties to update"}},"type":"object","required":["properties"],"title":"UpdateLineItemRequest","description":"Request schema for updating a line item used by the API router."},"UpdateLineItemResponse":{"properties":{"id":{"type":"string","title":"Id","description":"Line item ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"Line item properties"},"createdAt":{"type":"string","format":"date-time","title":"Createdat","description":"Created at timestamp"},"updatedAt":{"type":"string","format":"date-time","title":"Updatedat","description":"Updated at timestamp"},"archived":{"type":"boolean","title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id","createdAt","updatedAt","archived"],"title":"UpdateLineItemResponse","description":"Update line item response schema without associations"},"UpdateNoteRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Note properties to update"}},"type":"object","required":["properties"],"title":"UpdateNoteRequest","description":"Request schema for updating a note"},"UpdateOrderRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Order properties to update"}},"type":"object","required":["properties"],"title":"UpdateOrderRequest","description":"Request schema for updating an order"},"UpdatePaymentRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Payment property values to set. Accepts any type (strings, numbers, booleans, etc.) as per HubSpot docs. Empty strings clear properties."}},"type":"object","required":["properties"],"title":"UpdatePaymentRequest","description":"Request schema for updating a payment"},"UpdateProductRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Product properties to update"}},"type":"object","required":["properties"],"title":"UpdateProductRequest","description":"Request schema for updating a product used by the API router."},"UpdatePropertyValidationRuleRequest":{"properties":{"ruleArguments":{"items":{"type":"string"},"type":"array","title":"Rulearguments","description":"A list of arguments that define the constraints for the validation rule"}},"type":"object","required":["ruleArguments"],"title":"UpdatePropertyValidationRuleRequest","description":"Request schema for updating a validation rule"},"UpdateQuoteRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Quote properties to update"}},"type":"object","required":["properties"],"title":"UpdateQuoteRequest","description":"Request schema for updating a quote used by the API router."},"UpdateTaskRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Task properties to update"}},"type":"object","required":["properties"],"title":"UpdateTaskRequest","description":"Request schema for updating a task"},"UpdateTaxRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Tax properties to update"}},"type":"object","required":["properties"],"title":"UpdateTaxRequest","description":"Request schema for updating a tax used by the API router."},"UpdateTicketRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"Ticket properties to update"}},"type":"object","required":["properties"],"title":"UpdateTicketRequest","description":"Request schema for updating a ticket used by the API router."},"UpdateUserRequest":{"properties":{"properties":{"additionalProperties":true,"type":"object","title":"Properties","description":"User properties to update"}},"type":"object","required":["properties"],"title":"UpdateUserRequest","description":"Request schema for updating a user used by the API router."},"UpdateVisibilityRequest":{"properties":{"fromCurrencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"From currency code"},"toCurrencyCode":{"$ref":"#/components/schemas/app__modules__settings__currencies__constants__CurrencyCode","description":"To currency code (company currency)"},"visibleInUI":{"type":"boolean","title":"Visibleinui","description":"Visible in UI flag"}},"type":"object","required":["fromCurrencyCode","toCurrencyCode","visibleInUI"],"title":"UpdateVisibilityRequest","description":"Request schema for updating currency visibility matching HubSpot format"},"UserListResponse":{"properties":{"results":{"items":{"$ref":"#/components/schemas/UserResponse"},"type":"array","title":"Results","description":"List of users"},"paging":{"anyOf":[{"$ref":"#/components/schemas/app__modules__settings__users__schema__Paging"},{"type":"null"}],"description":"Pagination information; only present when a next page exists"}},"type":"object","required":["results"],"title":"UserListResponse","description":"Users list response schema matching HubSpot format"},"UserResponse":{"properties":{"id":{"type":"string","title":"Id","description":"User ID"},"properties":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Properties","description":"User properties"},"createdAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Createdat","description":"Created at timestamp"},"updatedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updatedat","description":"Updated at timestamp"},"archived":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Archived","description":"Archived status"},"archivedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Archivedat","description":"Archived at timestamp"},"associations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Associations","description":"Object associations"},"propertiesWithHistory":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Propertieswithhistory","description":"Properties with history"},"objectWriteTraceId":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Objectwritetraceid","description":"Object write trace ID"}},"type":"object","required":["id"],"title":"UserResponse","description":"Single user response schema matching HubSpot format"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"app__modules__cms__cms_posts__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__cms__cms_posts__schema__PagingNext"},{"type":"null"}],"description":"Model definition for forward paging"}},"type":"object","title":"Paging","description":"Paging schema matching HubSpot API format\n\nPer official HubSpot API documentation, paging only includes forward cursors."},"app__modules__cms__cms_posts__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"A paging cursor token for retrieving subsequent pages"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"A URL that can be used to retrieve the next page results"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema matching HubSpot API format\n\nPer official HubSpot API documentation:\n- after: A paging cursor token for retrieving subsequent pages (required string, empty string when no next page)\n- link: A URL that can be used to retrieve the next page results (optional string, empty string when no next page)"},"app__modules__cms__cms_tags__schema__BatchStatus":{"type":"string","enum":["CANCELED","COMPLETE","PENDING","PROCESSING"],"title":"BatchStatus","description":"Status of batch operation"},"app__modules__cms__cms_tags__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__cms__cms_tags__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__cms__cms_tags__schema__PagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","title":"PagingNext","description":"Paging next schema"},"app__modules__commerce__carts_schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationTo"},"types":{"items":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationType"},"type":"array","minItems":1,"title":"Types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for cart creation"},"app__modules__commerce__payments_schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationTo"},"types":{"items":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationType"},"type":"array","minItems":1,"title":"Types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for payment creation"},"app__modules__commerce__payments_schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","INTEGRATOR_DEFINED","USER_DEFINED","WORK"],"title":"AssociationCategory","description":"Association category values"},"app__modules__commerce__payments_schema__AssociationCollection":{"properties":{"results":{"items":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationResult"},"type":"array","title":"Results","description":"List of associated objects"}},"type":"object","required":["results"],"title":"AssociationCollection","description":"Collection of associations for a specific type"},"app__modules__commerce__payments_schema__AssociationResult":{"properties":{"id":{"type":"string","title":"Id","description":"The ID for the association type"},"type":{"type":"string","title":"Type","description":"The type of association"}},"type":"object","required":["id","type"],"title":"AssociationResult","description":"Single association result"},"app__modules__commerce__payments_schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target object"},"app__modules__commerce__payments_schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__AssociationCategory"},"associationTypeId":{"type":"integer","title":"Associationtypeid"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__commerce__payments_schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__PagingNext"},{"type":"null"}]},"prev":{"anyOf":[{"$ref":"#/components/schemas/app__modules__commerce__payments_schema__PagingPrev"},{"type":"null"}]}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__commerce__payments_schema__PagingNext":{"properties":{"after":{"type":"string","title":"After"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__commerce__payments_schema__PagingPrev":{"properties":{"before":{"type":"string","title":"Before"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","required":["before"],"title":"PagingPrev","description":"Paging prev schema"},"app__modules__crm_associations__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED"],"title":"AssociationCategory","description":"Association category enum matching HubSpot v4 API."},"app__modules__crm_associations__schema__AssociationResult-Input":{"properties":{"toObjectId":{"type":"string","title":"Toobjectid","description":"The unique identifier for the target object in the association"},"associationTypes":{"items":{"$ref":"#/components/schemas/app__modules__crm_associations__schema__AssociationType"},"type":"array","title":"Associationtypes","description":"Array of association types for this association"}},"type":"object","required":["toObjectId","associationTypes"],"title":"AssociationResult","description":"Individual association result schema."},"app__modules__crm_associations__schema__AssociationResult-Output":{"properties":{"toObjectId":{"type":"string","title":"Toobjectid","description":"The unique identifier for the target object in the association"},"associationTypes":{"items":{"$ref":"#/components/schemas/AssociationType-Output"},"type":"array","title":"Associationtypes","description":"Array of association types for this association"}},"type":"object","required":["toObjectId","associationTypes"],"title":"AssociationResult","description":"Individual association result schema."},"app__modules__crm_associations__schema__AssociationType":{"properties":{"typeId":{"type":"integer","title":"Typeid","description":"The unique identifier for the type of association"},"category":{"type":"string","title":"Category","description":"The category of the association (HUBSPOT_DEFINED, USER_DEFINED, INTEGRATOR_DEFINED)"},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Label","description":"A label describing the association between two objects"}},"type":"object","required":["typeId","category"],"title":"AssociationType","description":"Association type schema matching HubSpot v4 API format."},"app__modules__crm_associations__schema__BatchStatus":{"type":"string","enum":["PENDING","PROCESSING","CANCELED","COMPLETE"],"title":"BatchStatus","description":"Batch processing status enum matching HubSpot v4 API."},"app__modules__crm_associations__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_associations__schema__PagingNext"},{"type":"null"}],"description":"Specifies the paging information needed to retrieve the next set of results"}},"type":"object","title":"Paging","description":"Paging schema — HubSpot uses forward-only cursor pagination."},"app__modules__crm_associations__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"A paging cursor token for retrieving subsequent pages"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"A URL that can be used to retrieve the next page results"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__crm_companies__schemas__companies__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__AssociationTo"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__AssociationType"},"type":"array","minItems":1,"title":"Types"}},"type":"object","required":["to","types"],"title":"Association"},"app__modules__crm_objects__crm_companies__schemas__companies__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED"],"title":"AssociationCategory"},"app__modules__crm_objects__crm_companies__schemas__companies__AssociationCollection-Input":{"properties":{"results":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__AssociationResult"},"type":"array","title":"Results","description":"List of associated objects"},"paging":{"anyOf":[{"$ref":"#/components/schemas/AssociationPaging"},{"type":"null"}]}},"type":"object","required":["results"],"title":"AssociationCollection","description":"Collection of associations for a specific type"},"app__modules__crm_objects__crm_companies__schemas__companies__AssociationCollection-Output":{"properties":{"results":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__AssociationResult"},"type":"array","title":"Results","description":"List of associated objects"},"paging":{"anyOf":[{"$ref":"#/components/schemas/AssociationPaging"},{"type":"null"}]}},"type":"object","required":["results"],"title":"AssociationCollection","description":"Collection of associations for a specific type"},"app__modules__crm_objects__crm_companies__schemas__companies__AssociationResult":{"properties":{"id":{"type":"string","title":"Id","description":"The ID for the association type"},"type":{"type":"string","title":"Type","description":"The type of association"}},"type":"object","required":["id","type"],"title":"AssociationResult","description":"Single association result"},"app__modules__crm_objects__crm_companies__schemas__companies__AssociationTo":{"properties":{"id":{"type":"string","title":"Id"}},"type":"object","required":["id"],"title":"AssociationTo"},"app__modules__crm_objects__crm_companies__schemas__companies__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__AssociationCategory"},"associationTypeId":{"type":"integer","title":"Associationtypeid"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType"},"app__modules__crm_objects__crm_companies__schemas__companies__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__crm_companies__schemas__companies__PagingNext"},{"type":"null"}]}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__crm_companies__schemas__companies__PagingNext":{"properties":{"after":{"type":"string","title":"After"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__crm_contact__schemas__contacts__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_contact__schemas__contacts__AssociationTo"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_contact__schemas__contacts__AssociationType"},"type":"array","minItems":1,"title":"Types"}},"type":"object","required":["to","types"],"title":"Association"},"app__modules__crm_objects__crm_contact__schemas__contacts__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED","WORK"],"title":"AssociationCategory"},"app__modules__crm_objects__crm_contact__schemas__contacts__AssociationTo":{"properties":{"id":{"type":"string","title":"Id"}},"type":"object","required":["id"],"title":"AssociationTo"},"app__modules__crm_objects__crm_contact__schemas__contacts__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__crm_contact__schemas__contacts__AssociationCategory"},"associationTypeId":{"type":"integer","title":"Associationtypeid"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType"},"app__modules__crm_objects__crm_contact__schemas__contacts__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__crm_contact__schemas__contacts__PagingNext"},{"type":"null"}]}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__crm_contact__schemas__contacts__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__deals__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__deals__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__deals__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for deal creation"},"app__modules__crm_objects__deals__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__crm_objects__deals__schema__AssociationType":{"properties":{"associationCategory":{"type":"string","title":"Associationcategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__crm_objects__deals__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__deals__schema__PagingNext"},{"type":"null"}]}},"type":"object","title":"Paging","description":"Paging schema -- HubSpot uses forward-only cursor pagination."},"app__modules__crm_objects__deals__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__goals__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__goals__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__goals__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for goal target creation"},"app__modules__crm_objects__goals__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__crm_objects__goals__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__crm_objects__goals__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__goals__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__crm_objects__goals__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__goals__schema__PagingNext"},{"type":"null"}],"description":"Next page info"},"prev":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__goals__schema__PagingPrev"},{"type":"null"}],"description":"Previous page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__goals__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__goals__schema__PagingPrev":{"properties":{"before":{"type":"string","title":"Before","description":"Previous page cursor"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Previous page link"}},"type":"object","required":["before"],"title":"PagingPrev","description":"Paging previous schema"},"app__modules__crm_objects__invoices__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__invoices__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__invoices__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for invoice creation"},"app__modules__crm_objects__invoices__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__crm_objects__invoices__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__crm_objects__invoices__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__invoices__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__crm_objects__invoices__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__invoices__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__invoices__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__leads__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","INTEGRATOR_DEFINED","USER_DEFINED","WORK"],"title":"AssociationCategory","description":"Supported association categories for lead creation"},"app__modules__crm_objects__leads__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__leads__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__leads__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__line_items__schema__Association":{"properties":{"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__line_items__schema__AssociationType"},"type":"array","title":"Types","description":"Association types"},"to":{"$ref":"#/components/schemas/app__modules__crm_objects__line_items__schema__AssociationTo","description":"Target object"}},"type":"object","required":["types","to"],"title":"Association"},"app__modules__crm_objects__line_items__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo"},"app__modules__crm_objects__line_items__schema__AssociationType":{"properties":{"associationCategory":{"type":"string","title":"Associationcategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType"},"app__modules__crm_objects__line_items__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__line_items__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__line_items__schema__PagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__orders__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED"],"title":"AssociationCategory","description":"Supported association categories for order creation"},"app__modules__crm_objects__orders__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__orders__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__orders__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__products__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__products__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__products__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema"},"app__modules__crm_objects__products__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED","WORK"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__crm_objects__products__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__crm_objects__products__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__products__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__crm_objects__products__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__products__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__products__schema__PagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__quotes__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__quotes__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__quotes__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema"},"app__modules__crm_objects__quotes__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__crm_objects__quotes__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__crm_objects__quotes__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__quotes__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__crm_objects__quotes__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__quotes__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema — HubSpot uses forward-only cursor pagination."},"app__modules__crm_objects__quotes__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__services__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__services__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__services__schema__PagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__taxes__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__taxes__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__taxes__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema"},"app__modules__crm_objects__taxes__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED","WORK"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__crm_objects__taxes__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__crm_objects__taxes__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__taxes__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__crm_objects__taxes__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__taxes__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__taxes__schema__PagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","title":"PagingNext","description":"Paging next schema"},"app__modules__crm_objects__tickets__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__crm_objects__tickets__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__crm_objects__tickets__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema"},"app__modules__crm_objects__tickets__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED","WORK"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__crm_objects__tickets__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__crm_objects__tickets__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__crm_objects__tickets__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__crm_objects__tickets__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__crm_objects__tickets__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__crm_objects__tickets__schema__PagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","title":"PagingNext","description":"Paging next schema"},"app__modules__engagements__calls__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__engagements__calls__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__engagements__calls__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for call creation"},"app__modules__engagements__calls__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED","WORK"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__engagements__calls__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__engagements__calls__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__engagements__calls__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__engagements__calls__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__engagements__calls__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema — top-level paging has only next (no prev per doc)"},"app__modules__engagements__calls__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__engagements__notes__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__engagements__notes__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__engagements__notes__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for note creation"},"app__modules__engagements__notes__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","USER_DEFINED","INTEGRATOR_DEFINED","WORK"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__engagements__notes__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__engagements__notes__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__engagements__notes__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__engagements__notes__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__engagements__notes__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema — HubSpot uses forward-only cursor pagination."},"app__modules__engagements__notes__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__engagements__tasks__schema__Association":{"properties":{"to":{"$ref":"#/components/schemas/app__modules__engagements__tasks__schema__AssociationTo","description":"Target object"},"types":{"items":{"$ref":"#/components/schemas/app__modules__engagements__tasks__schema__AssociationType"},"type":"array","minItems":1,"title":"Types","description":"Association types"}},"type":"object","required":["to","types"],"title":"Association","description":"Association schema for task creation"},"app__modules__engagements__tasks__schema__AssociationCategory":{"type":"string","enum":["HUBSPOT_DEFINED","INTEGRATOR_DEFINED","USER_DEFINED","WORK"],"title":"AssociationCategory","description":"Association category enum matching HubSpot API."},"app__modules__engagements__tasks__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__engagements__tasks__schema__AssociationType":{"properties":{"associationCategory":{"$ref":"#/components/schemas/app__modules__engagements__tasks__schema__AssociationCategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__engagements__tasks__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__engagements__tasks__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__engagements__tasks__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","required":["after"],"title":"PagingNext","description":"Paging next schema"},"app__modules__settings__currencies__constants__CurrencyCode":{"type":"string","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BOV","BRL","BSD","BTN","BWP","BYN","BZD","CAD","CDF","CHE","CHF","CHW","CLF","CLP","CNY","COP","COU","CRC","CUC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRU","MUR","MVR","MWK","MXN","MXV","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","SSP","STN","SVC","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","USN","UYI","UYU","UZS","VEF","VND","VUV","WST","XAF","XAG","XAU","XBA","XBB","XBC","XBD","XCD","XDR","XOF","XPD","XPF","XPT","XSU","XUA","YER","ZAR","ZMW","ZWL"],"title":"CurrencyCode","description":"Supported currency codes for HubSpot"},"app__modules__settings__currencies__schema__CurrencyCode":{"properties":{"currencyCode":{"type":"string","title":"Currencycode","description":"Currency code (e.g., USD, EUR)"},"currencyName":{"type":"string","title":"Currencyname","description":"Human-readable currency name (e.g., US Dollar, Euro)"}},"type":"object","required":["currencyCode","currencyName"],"title":"CurrencyCode","description":"Single currency code response schema matching HubSpot format"},"app__modules__settings__currencies__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__settings__currencies__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__settings__currencies__schema__PagingNext":{"properties":{"after":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"After","description":"Paging cursor token"},"link":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Link","description":"Next page link"}},"type":"object","title":"PagingNext","description":"Paging next schema"},"app__modules__settings__users__schema__Association":{"properties":{"types":{"items":{"$ref":"#/components/schemas/app__modules__settings__users__schema__AssociationType"},"type":"array","title":"Types","description":"Association types"},"to":{"$ref":"#/components/schemas/app__modules__settings__users__schema__AssociationTo","description":"Target object"}},"type":"object","required":["types","to"],"title":"Association","description":"Association schema"},"app__modules__settings__users__schema__AssociationTo":{"properties":{"id":{"type":"string","title":"Id","description":"ID of the object to associate with"}},"type":"object","required":["id"],"title":"AssociationTo","description":"Association target schema"},"app__modules__settings__users__schema__AssociationType":{"properties":{"associationCategory":{"type":"string","title":"Associationcategory","description":"Association category"},"associationTypeId":{"type":"integer","title":"Associationtypeid","description":"Association type ID"}},"type":"object","required":["associationCategory","associationTypeId"],"title":"AssociationType","description":"Association type schema"},"app__modules__settings__users__schema__Paging":{"properties":{"next":{"anyOf":[{"$ref":"#/components/schemas/app__modules__settings__users__schema__PagingNext"},{"type":"null"}],"description":"Next page info"}},"type":"object","title":"Paging","description":"Paging schema"},"app__modules__settings__users__schema__PagingNext":{"properties":{"after":{"type":"string","title":"After","description":"Paging cursor token"},"link":{"type":"string","title":"Link","description":"Next page link"}},"type":"object","required":["after","link"],"title":"PagingNext","description":"Paging next schema"}},"securitySchemes":{"HTTPBearerHubSpot":{"type":"http","scheme":"bearer"}}}}