openapi: 3.0.0 info: title: Sweep API description: This is a publicly available Sweep API. version: '0.1' contact: {} servers: - url: https://api.sweep.io description: Sweep production API — the host this document was harvested from (GET /api-json); /health responds here paths: /health: get: operationId: HealthController_health parameters: [] responses: '200': description: '' tags: - Health /snowflake-orgs: post: operationId: SnowflakeOrgController_create parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSnowflakeOrgDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] summary: Create a new Snowflake org tags: - Snowflake Orgs /snowflake-orgs/databases: post: operationId: SnowflakeOrgController_listDatabasesWithCredentials parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetDatabasesDto' responses: '201': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] summary: List available databases using provided credentials (no org required) tags: - Snowflake Orgs /snowflake-orgs/{orgId}: delete: operationId: SnowflakeOrgController_delete parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] summary: Delete a Snowflake org tags: - Snowflake Orgs /servicenow-orgs: post: operationId: ServiceNowOrgController_create parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateServiceNowOrgDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] summary: Create a new ServiceNow org tags: - ServiceNow Orgs /servicenow-orgs/{orgId}: patch: operationId: ServiceNowOrgController_reconnect parameters: - name: orgId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ServiceNowCredentialsDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: Reconnect a ServiceNow org with updated credentials tags: - ServiceNow Orgs delete: operationId: ServiceNowOrgController_delete parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] summary: Delete a ServiceNow org tags: - ServiceNow Orgs /servicenow-orgs/{orgId}/fetch: post: operationId: ServiceNowOrgController_triggerFetch parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' security: - bearer: [] summary: Manually trigger metadata fetch for a ServiceNow org tags: - ServiceNow Orgs /workato-orgs: post: operationId: WorkatoOrgController_create parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkatoOrgDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Workato Orgs /documentation-platform/snowflake/search: get: operationId: DocumentationPlatformController_searchElements parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string - name: schema required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/snowflake/search-by-metadata: get: operationId: DocumentationPlatformController_findElementByName parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string - name: schema required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/snowflake/{metadataId}/dependencies: get: operationId: DocumentationPlatformController_getElementDependencies parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/snowflake/{metadataId}/dependents: get: operationId: DocumentationPlatformController_getElementDependents parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/snowflake/{metadataId}/summary: get: operationId: DocumentationPlatformController_getElementSummary parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/snowflake/{metadataId}/source: get: operationId: DocumentationPlatformController_getElementSource parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/snowflake/{metadataId}/chat: post: operationId: DocumentationPlatformController_chatWithElement parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentationChatRequestDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/snowflake/{elementType}: get: operationId: DocumentationPlatformController_listElements parameters: - name: elementType required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/search: get: operationId: DocumentationPlatformController_searchData360Elements parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/search-by-metadata: get: operationId: DocumentationPlatformController_findData360ElementByName parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/{metadataId}/dependencies: get: operationId: DocumentationPlatformController_getData360ElementDependencies parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/{metadataId}/dependents: get: operationId: DocumentationPlatformController_getData360ElementDependents parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/{metadataId}/children: get: operationId: DocumentationPlatformController_getData360ElementChildren parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/{metadataId}/summary: get: operationId: DocumentationPlatformController_getData360ElementSummary parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/{metadataId}/source: get: operationId: DocumentationPlatformController_getData360ElementSource parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/{metadataId}/chat: post: operationId: DocumentationPlatformController_chatWithData360Element parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentationChatRequestDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/data360/{elementType}: get: operationId: DocumentationPlatformController_listData360Elements parameters: - name: elementType required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/search: get: operationId: DocumentationPlatformController_searchWorkatoElements parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/search-by-metadata: get: operationId: DocumentationPlatformController_findWorkatoElementByName parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/{metadataId}/dependencies: get: operationId: DocumentationPlatformController_getWorkatoElementDependencies parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/{metadataId}/dependents: get: operationId: DocumentationPlatformController_getWorkatoElementDependents parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/{metadataId}/children: get: operationId: DocumentationPlatformController_getWorkatoElementChildren parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/{metadataId}/source: get: operationId: DocumentationPlatformController_getWorkatoElementSource parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/{metadataId}/summary: get: operationId: DocumentationPlatformController_getWorkatoElementSummary parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/workato/{elementType}: get: operationId: DocumentationPlatformController_listWorkatoElements parameters: - name: elementType required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/search: get: operationId: DocumentationPlatformController_searchHubspotElements parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/search-by-metadata: get: operationId: DocumentationPlatformController_findHubspotElementByName parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/{metadataId}/dependencies: get: operationId: DocumentationPlatformController_getHubspotElementDependencies parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/{metadataId}/dependents: get: operationId: DocumentationPlatformController_getHubspotElementDependents parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/{metadataId}/children: get: operationId: DocumentationPlatformController_getHubspotElementChildren parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/{metadataId}/summary: get: operationId: DocumentationPlatformController_getHubspotElementSummary parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/{metadataId}/source: get: operationId: DocumentationPlatformController_getHubspotElementSource parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/{metadataId}/chat: post: operationId: DocumentationPlatformController_chatWithHubspotElement parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentationChatRequestDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/hubspot/{elementType}: get: operationId: DocumentationPlatformController_listHubspotElements parameters: - name: elementType required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/search: get: operationId: DocumentationPlatformController_searchServiceNowElements parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/search-by-metadata: get: operationId: DocumentationPlatformController_findServiceNowElementByName parameters: - name: orgId required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/tables/{tableName}/fields: get: operationId: DocumentationPlatformController_getServiceNowTableFields parameters: - name: tableName required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/{metadataId}/summary: get: operationId: DocumentationPlatformController_getServiceNowElementSummary parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/{metadataId}/chat: post: operationId: DocumentationPlatformController_chatWithServiceNowElement parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentationChatRequestDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/{metadataId}/source: get: operationId: DocumentationPlatformController_getServiceNowElementSource parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/{metadataId}/choices: get: operationId: DocumentationPlatformController_getServiceNowFieldChoices parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/servicenow/{elementType}: get: operationId: DocumentationPlatformController_listServiceNowElements parameters: - name: elementType required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/salesforce/objects: get: operationId: DocumentationPlatformController_listSalesforceObjects parameters: - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/salesforce/element-types: get: operationId: DocumentationPlatformController_listSalesforceElementTypes parameters: - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/salesforce/objects/{objectName}/elements: get: operationId: DocumentationPlatformController_getSalesforceObjectDetailElements parameters: - name: objectName required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string - name: type required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/salesforce/objects/{objectName}/counters: get: operationId: DocumentationPlatformController_getSalesforceObjectCounters parameters: - name: objectName required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/salesforce/{elementType}: get: operationId: DocumentationPlatformController_listSalesforceElements parameters: - name: elementType required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/salesforce/{metadataId}/dependencies: get: operationId: DocumentationPlatformController_getSalesforceElementDependencies parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /documentation-platform/salesforce/{metadataId}/dependents: get: operationId: DocumentationPlatformController_getSalesforceElementDependents parameters: - name: metadataId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Platform /homepage: get: operationId: HomepageController_loadHomepageStuff parameters: [] responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Homepage /webapp/config/opportunity-stage-options: get: operationId: WebappController_getOpportunityStageOptions parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Webapp /crm-orgs: get: operationId: CrmOrgsController_getOrgs parameters: - name: connectedOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - CRM Orgs /crm-orgs/new: post: operationId: CrmOrgsController_createOrgs parameters: - name: demo required: true in: query schema: type: boolean requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CrmOrgCreateDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/salesforce-oauth: get: operationId: CrmOrgsController_getSFDCOAuthPath parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}: get: operationId: CrmOrgsController_getOrg parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - CRM Orgs patch: operationId: CrmOrgsController_updateOrg parameters: - name: orgId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CrmOrgUpdateDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/emailTemplates: get: operationId: CrmOrgsController_getEmailTemplates parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/object-types/{objectName}/child-relationship-names: get: operationId: CrmOrgsController_getChildRelationshipNames parameters: - name: orgId required: true in: path schema: type: string - name: objectName required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/apex-classes: get: operationId: CrmOrgsController_getApexClasses parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/salesforce-oauth2-code: post: operationId: CrmOrgsController_handleSFDCOAuthAuthorizationCode parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CrmOrgOAuthDto' responses: '201': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/connect-anyway: post: operationId: CrmOrgsController_connectAnyway parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/object-types: get: operationId: CrmOrgsController_getObjectTypes parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: returns the available object types in the specified salto workspace of orgId tags: - CRM Orgs /crm-orgs/org/{orgId}/object-types-2: get: operationId: CrmOrgsController_getObjectTypes2 parameters: - name: orgId required: true in: path schema: type: string - name: triggerableObjectsOnly required: true in: query schema: type: boolean - name: updateableObjectsOnly required: true in: query schema: type: boolean - name: createableObjectsOnly required: true in: query schema: type: boolean - name: queryableObjectsOnly required: true in: query schema: type: boolean - name: applyFiltersToBig5 required: true in: query schema: type: boolean - name: countRecordTypes required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] summary: returns the available object types in the specified salesforce orgId tags: - CRM Orgs /crm-orgs/org/{orgId}/users/member-properties: get: operationId: CrmOrgsController_listUsersWithMemberProperties parameters: - name: orgId required: true in: path schema: type: string - name: includeInactive required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: returns all users in org from the managed package tags: - CRM Orgs /crm-orgs/org/{orgId}/users: get: operationId: CrmOrgsController_listUsers parameters: - name: orgId required: true in: path schema: type: string - name: includeInactive required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: returns all users in org (managed package not required) tags: - CRM Orgs /crm-orgs/org/{orgId}/users/{userId}/timeOff: post: operationId: CrmOrgsController_createUserTimeOff parameters: - name: orgId required: true in: path schema: type: string - name: userId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CrmOrgUserTimeOff' responses: '201': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/users/{userId}/timeOff/{timeOffId}: put: operationId: CrmOrgsController_updateUserTimeOff parameters: - name: orgId required: true in: path schema: type: string - name: userId required: true in: path schema: type: string - name: timeOffId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CrmOrgUserTimeOff' responses: '200': description: '' security: - bearer: [] tags: - CRM Orgs delete: operationId: CrmOrgsController_deleteUserTimeOff parameters: - name: orgId required: true in: path schema: type: string - name: userId required: true in: path schema: type: string - name: timeOffId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/queues: get: operationId: CrmOrgsController_listQueues parameters: - name: orgId required: true in: path schema: type: string - name: objectType required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: returns all queues in org tags: - CRM Orgs /crm-orgs/org/{orgId}/funnels-and-record-types: get: operationId: CrmOrgsController_getAllFunnelsAndRecordTypes parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelsAndRecordTypesDto' security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/objects: get: operationId: CrmOrgsController_getSalesforceObjectTypes parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/objects/{objectName}/funnels-and-record-types: get: operationId: CrmOrgsController_getObjectFunnelsAndRecordTypes parameters: - name: orgId required: true in: path schema: type: string - name: objectName required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/objects/{objectName}/record-types/{recordTypeName}: get: operationId: CrmOrgsController_getLeadingFieldCandidatesForRecordType parameters: - name: orgId required: true in: path schema: type: string - name: objectName required: true in: path schema: type: string - name: recordTypeName required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - CRM Orgs /crm-orgs/org/{orgId}/sweep-permission-set-group-assignment: post: operationId: CrmOrgsController_assignPermissionSetGroup parameters: - name: orgId required: true in: path schema: type: string - name: all required: true in: query schema: type: boolean responses: '201': description: '' security: - bearer: [] tags: - CRM Orgs /orgs: get: operationId: OrgsController_getAllOrgs parameters: - name: connectedOnly required: true in: query schema: type: boolean - name: orgType required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] summary: Returns a unified view of CRM orgs, Snowflake orgs, Data360 orgs, and ServiceNow orgs. tags: - Orgs /orgs/{orgId}: delete: operationId: OrgsController_deleteOrg parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Orgs get: operationId: OrgsController_getOrg parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Orgs patch: operationId: OrgsController_renameOrg parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Orgs /orgs/{orgId}/fetch: post: operationId: OrgsController_fetchWorkspace parameters: - name: orgId required: true in: path schema: type: string - name: factory-reset required: true in: query schema: type: boolean responses: '201': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Orgs /assignment_groups: get: operationId: AssignmentGroupsController_getAssignmentGroups parameters: [] responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Assignment Groups post: operationId: AssignmentGroupsController_insertGroup parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignmentGroupSetterDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AssignmentGroupSetterDto' security: - bearer: [] tags: - Assignment Groups /assignment_groups/credit-queue: get: operationId: AssignmentGroupsController_getCreditQueue parameters: - name: groupApiName required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Assignment Groups post: operationId: AssignmentGroupsController_createCreditQueue parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreditQueueCreateConfigDto' responses: '201': description: '' security: - bearer: [] tags: - Assignment Groups put: operationId: AssignmentGroupsController_updateCreditQueue parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreditQueueUpdateConfigDto' responses: '200': description: '' security: - bearer: [] tags: - Assignment Groups /assignment_groups/{groupId}: get: operationId: AssignmentGroupsController_getAssignmentGroup parameters: - name: groupId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Assignment Groups delete: operationId: AssignmentGroupsController_deleteGroup parameters: - name: groupId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Assignment Groups put: operationId: AssignmentGroupsController_updateGroup parameters: - name: groupId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AssignmentGroupSetterDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AssignmentGroupSetterDto' security: - bearer: [] tags: - Assignment Groups /funnels/funnel-name-availability: get: operationId: FunnelsController_checkFunnelNameAvailability parameters: - name: funnelName required: true in: query schema: type: string - name: objectName required: true in: query schema: type: string - name: funnelId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] summary: Returns all funnels. tags: - Funnels /funnels: post: operationId: FunnelsController_createFunnel parameters: - name: crmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFunnelDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelDto' security: - bearer: [] summary: 'Creates a new funnel. New funnel is created with default version name - V1' tags: - Funnels /funnels/convert-record-type: post: operationId: FunnelsController_convertRecordTypeToFunnel parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConvertRecordTypeToFunnelDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelDto' security: - bearer: [] summary: Creates a new funnel from a record type. tags: - Funnels /funnels/funnel-from-record-type: get: operationId: FunnelsController_getFunnelAndSnapshotIdFromRecordType parameters: - name: recordTypeName required: true in: query schema: type: string - name: objectName required: true in: query schema: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: Given a record type, Returns a funnel id if the funnel exists and its snapshot and deployment id if it's deployed tags: - Funnels /funnels/{funnelId}/snapshots: get: operationId: FunnelsController_getFunnelSnapshots parameters: - name: funnelId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/FunnelSnapshotDto' security: - bearer: [] summary: get all snapshots of a specific funnel tags: - Funnels post: operationId: FunnelsController_createFunnelSnapshot parameters: - name: funnelId required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelSnapshotDto' security: - bearer: [] summary: '@body - either a funnel id or a funnelDto for saving' tags: - Funnels /funnels/{funnelId}/snapshots/{snapshotId}: get: operationId: FunnelsController_getFunnelSnapshot parameters: - name: funnelId required: true in: path schema: type: string - name: snapshotId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: get a snapshot tags: - Funnels patch: operationId: FunnelsController_setSnapshotName parameters: - name: funnelId required: true in: path schema: type: string - name: snapshotId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFunnelSnapshotDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelSnapshotDto' security: - bearer: [] summary: rename a snapshot tags: - Funnels /funnels/{funnelId}: get: operationId: FunnelsController_getFunnel parameters: - name: funnelId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelDto' security: - bearer: [] summary: Returns a single funnel. tags: - Funnels patch: operationId: FunnelsController_updateFunnel parameters: - name: funnelId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFunnelDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] summary: "Will replace Update funnel properties.\nFor example, if we want to create a snapshot of a previous state and restore state form\n\nIf funnelDetails is included in the payload it is overridden. if it's\n\n// TODO crmOrgId is passed as a query string parameter, while its usually needed when writing funnelDetails\n it is odd.\n@updateFunnelRequest - include funnelDetails, name, and possibly additional snapshots to create" tags: - Funnels put: operationId: FunnelsController_restoreSnapshot parameters: - name: funnelId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RestoreFunnelDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelDto' security: - bearer: [] summary: 'For Restoring snapshots. Resets a funnel''s details/state. The override request contains a reference to a past snapshot.' tags: - Funnels delete: operationId: FunnelsController_deleteFunnel parameters: - name: funnelId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] summary: Delete a funnel. tags: - Funnels /funnels/{funnelId}/recordTypes: get: operationId: FunnelsController_getRecordTypes parameters: - name: funnelId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelRecordTypesDto' security: - bearer: [] tags: - Funnels /funnels/{funnelId}/biSettings: put: operationId: FunnelsController_updateBISettings parameters: - name: funnelId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BISettingsDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BISettingsDto' security: - bearer: [] summary: Update BI settings of funnel. tags: - Funnels /deployments/crm-orgs: post: operationId: DeploymentsController_createDeployment parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeploymentRequestDto' responses: '201': description: '' security: - bearer: [] summary: "Deploys a funnel snapshot to a CrmOrg, and creates a deployment record in the database\n\nTODO make this an asynchronous API https://sweep.atlassian.net/browse/SWEEP-210\n\n@body - the snapshot id or funnelId. If a funnelId is passed, we first create a snapshot then deploy the\n snapshot." tags: - Deployments /deployments/crm-orgs/{crmOrgId}: get: operationId: DeploymentsController_getCrmOrgDeployments parameters: - name: crmOrgId required: true in: path schema: type: string - name: funnelId required: true in: query schema: type: string - name: active required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/FunnelDeploymentDto' security: - bearer: [] summary: get deployments representations for in a given crmOrg tags: - Deployments /deployments/{deploymentId}: get: operationId: DeploymentsController_getDeployment parameters: - name: deploymentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelDeploymentDto' security: - bearer: [] tags: - Deployments /deployments: get: operationId: DeploymentsController_getDeployments parameters: - name: crmOrgId required: true in: query schema: type: string - name: funnelId required: true in: query schema: type: string - name: active required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/FunnelDeploymentDto' security: - bearer: [] summary: 'get deployments, for specific funnel, and a possibly time range' tags: - Deployments /templates: get: operationId: TemplatesController_getShortTemplates parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] summary: Returns all short templates. tags: - Templates /templates/{templateId}: get: operationId: TemplatesController_getTemplate parameters: - name: templateId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Templates /templates/{funnelMapId}: post: operationId: TemplatesController_funnelMapToTemplate parameters: - name: funnelMapId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTemplateDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Templates /templates/{templateId}/convert: post: operationId: TemplatesController_convertTemplate parameters: - name: templateId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConvertTemplateDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Templates /stages: get: operationId: StagesController_getLeadingFieldsMetadata parameters: - name: leadingFieldIds required: true in: query schema: type: array items: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] summary: Returns an aggregation of metadata entries for a list of leading fields. tags: - Stages /stages/{fieldId}/metadata/{stageName}: get: operationId: StagesController_getLeadingFieldMetadataForSingleStage parameters: - name: fieldId required: true in: path schema: type: string - name: stageName required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Stages /reporting: get: operationId: ReportingController_getReporting parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/Reporting' security: - bearer: [] tags: - reporting /reporting/activate/is-allowed: get: operationId: ReportingController_isAllowedToActivateReporting parameters: [] responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - reporting /reporting/activate: patch: operationId: ReportingController_activateReporting parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/Reporting' security: - bearer: [] tags: - reporting /reporting/{reportingId}/deactivate: post: operationId: ReportingController_deactivateReporting parameters: - name: reportingId required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/Reporting' security: - bearer: [] tags: - reporting /reporting/reports: get: operationId: ReportingController_getAllSfdcReports parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - reporting /reporting/reports/tabular: get: operationId: ReportingController_getSfdcTabularReports parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - reporting /reporting/reports/{reportId}/columns: get: operationId: ReportingController_getSfdcReportColumns parameters: - name: reportId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - reporting /users: get: operationId: UsersController_getUser parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserDto' security: - bearer: [] summary: Get current logged in user. tags: - Users patch: operationId: UsersController_patchUserDetails parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditUserDto' responses: '200': description: '' security: - bearer: [] summary: Patches user details tags: - Users /users/permissions: get: operationId: UsersController_getPermissions parameters: [] responses: '200': description: '' security: - bearer: [] tags: - Users /users/{userId}: delete: operationId: UsersController_deleteUser parameters: - name: userId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Users /users/account/trial: post: operationId: UsersController_startTrial parameters: [] responses: '201': description: '' security: - bearer: [] tags: - Users /users/account/onboarding: patch: operationId: UsersController_updateOnboardingStatus parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateOnboardingStatusDto' responses: '200': description: '' security: - bearer: [] tags: - Users /users/account/invitations: post: operationId: UsersController_createInvitation parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/InvitationDto' responses: '201': description: '' security: - bearer: [] tags: - Users /users/account/invitations/{email}: delete: operationId: UsersController_removeInvitation parameters: - name: email required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Users /users/account: get: operationId: UsersController_getUsersAndInvitationOfAccount parameters: - name: includeInvitations required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] summary: Get Users and pending invitations of account. tags: - Users /users/ws-code: get: operationId: UsersController_getWSRegistrationCode parameters: [] responses: '200': description: '' content: application/json: schema: type: string security: - bearer: [] summary: 'returns WebSocket Registration code. This is used to connect between the websocket and the user ID. TODO: Deprecate for a more holistic solution that uses the Bearer token in the WebSocket.' tags: - Users /users/preferences: get: operationId: UsersController_getUserPreferences parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/UserPreferencesDto' security: - bearer: [] summary: Returns the user preferences for the current user tags: - Users patch: operationId: UsersController_patchUserPreferences parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UserPreferencesDto' responses: '200': description: '' security: - bearer: [] summary: Patches user preferences tags: - Users put: operationId: UsersController_putUserPreferences parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UserPreferencesDto' responses: '200': description: '' security: - bearer: [] summary: Replaces the preferences tags: - Users /users/{userId}/role: put: operationId: UsersController_updateUserRoleGroup parameters: - name: userId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UserRoleDto' responses: '200': description: '' security: - bearer: [] summary: Change user role tags: - Users /users/image: post: operationId: UsersController_uploadImage parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ImageDataDto' responses: '201': description: '' content: application/json: schema: type: string security: - bearer: [] tags: - Users /users/clearbit-enrichment: get: operationId: UsersController_getClearbitEnrichment parameters: [] responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Users /users/hubspot-enrichment: post: operationId: UsersController_setHubspotEnrichment parameters: [] responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Users /users/{orgId}/mcp-org: post: operationId: UsersController_setMcpOrgForUser parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Users /users/{userSubId}/resend-verification-email: post: operationId: UsersUnauthenticatedController_resendVerificationEmail parameters: - name: userSubId required: true in: path schema: type: string responses: '201': description: '' tags: - Users (unauthenticated) /sweep_fields: get: operationId: SweepFieldsController_getSweepFields parameters: - name: objectType required: true in: query schema: type: array items: type: string - name: fieldIds required: true in: query schema: type: array items: type: string - name: includeSiblings required: true in: query schema: type: boolean - name: detectLeadingCandidates required: true in: query schema: type: boolean - name: includeDescriptionValueSetNameRequired required: true in: query schema: type: boolean - name: typeGroups required: true in: query schema: type: array items: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Sweep Fields post: operationId: SweepFieldsController_createSweepField parameters: - name: crmOrgId required: true in: query schema: type: string - name: draft required: true in: query schema: type: boolean requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SweepFieldBaseDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Sweep Fields /sweep_fields/ids-by-names: get: operationId: SweepFieldsController_getSweepFieldIdsByApiName parameters: - name: fieldNames required: true in: query schema: type: array items: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FieldIdsDto' security: - bearer: [] tags: - Sweep Fields /sweep_fields/{id}: get: operationId: SweepFieldsController_getSweepField parameters: - name: id required: true in: path schema: type: string - name: includeReadOnly required: true in: query schema: type: boolean - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Sweep Fields /sweep_fields/{fieldId}: put: operationId: SweepFieldsController_updateSweepFields parameters: - name: fieldId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FieldUpdateDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Sweep Fields /data-integrations/slack/oauth2-code: post: operationId: DataIntegrationsController_handleSlackAuthAuthorizationCode parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SlackOAuthDto' responses: '201': description: '' tags: - Data Integrations /data-integrations/slack/recipients: get: operationId: DataIntegrationsController_getSlackRecipients parameters: - name: ids required: true in: query schema: type: array items: type: string - name: invalidate-cache required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Data Integrations /data-integrations/slack: get: operationId: DataIntegrationsController_getSlackConnectionDetails parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/SlackConnectionDto' tags: - Data Integrations patch: operationId: DataIntegrationsController_editSlackConnection parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditSlackConnectionDto' responses: '200': description: '' tags: - Data Integrations delete: operationId: DataIntegrationsController_disconnectSlackApp parameters: [] responses: '200': description: '' tags: - Data Integrations /data-integrations/audit: get: operationId: DataIntegrationsController_getAudit parameters: - name: automationId required: true in: query schema: type: string - name: actionType required: true in: query schema: type: array items: type: string - name: status required: true in: query schema: type: array items: type: string - name: crmOrgId required: true in: query schema: type: array items: type: string - name: customIntegrationId required: true in: query schema: type: array items: type: string - name: search required: true in: query schema: type: string - name: startTime required: true in: query schema: type: string - name: endTime required: true in: query schema: type: string - name: nextId required: true in: query schema: type: string responses: '200': description: '' tags: - Data Integrations /data-integrations/custom-integrations: get: operationId: DataIntegrationsController_getCustomIntegrations parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Data Integrations post: operationId: DataIntegrationsController_createCustomIntegrations parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertCustomIntegrationDto' responses: '201': description: '' content: application/json: schema: type: object tags: - Data Integrations /data-integrations/custom-integrations/{integrationId}: put: operationId: DataIntegrationsController_editCustomIntegrations parameters: - name: integrationId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertCustomIntegrationDto' responses: '200': description: '' content: application/json: schema: type: object tags: - Data Integrations delete: operationId: DataIntegrationsController_delete parameters: - name: integrationId required: true in: path schema: type: string - name: dry-run required: true in: query schema: type: boolean responses: '200': description: '' tags: - Data Integrations /data-integrations/custom-integrations/{integrationId}/reveal-password: get: operationId: DataIntegrationsController_getCustomIntegrationPassword parameters: - name: integrationId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: string tags: - Data Integrations /data-integrations/teams/oauth2-callback: post: operationId: DataIntegrationsController_oauth2Callback parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/TeamsOAuthDto' responses: '201': description: '' content: application/json: schema: type: string tags: - Data Integrations /data-integrations/teams/recipients: get: operationId: DataIntegrationsController_getTeamsRecipients parameters: - name: type required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsRecipientInfo' tags: - Data Integrations /data-integrations/teams/channels/{teamId}: get: operationId: DataIntegrationsController_getChannelsByTeam parameters: - name: teamId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsRecipientInfo' tags: - Data Integrations /data-integrations/webhook/test: post: operationId: DataIntegrationsController_testWebhook parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WebhookTestDto' responses: '201': description: '' content: application/json: schema: type: object tags: - Data Integrations /data-integrations/teams/connection-status: get: operationId: DataIntegrationsController_getTeamsConnectionDetails parameters: [] responses: '200': description: '' tags: - Data Integrations /data-integrations/teams/recipients-by-id: get: operationId: DataIntegrationsController_resolveReceipientNames parameters: - name: ids required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsRecipientInfo' tags: - Data Integrations /data-integrations/teams: delete: operationId: DataIntegrationsController_disconnectTeamsApp parameters: [] responses: '200': description: '' tags: - Data Integrations /data-integrations/teams/recipients/search: get: operationId: DataIntegrationsController_searchTeamsUsers parameters: - name: query required: true in: query schema: type: string - name: top required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsRecipientInfo' tags: - Data Integrations /data-integrations/teams/users/count: get: operationId: DataIntegrationsController_getTeamsUsersCount parameters: [] responses: '200': description: '' content: application/json: schema: type: number tags: - Data Integrations /data-integrations/teams/users-by-team/{teamId}: get: operationId: DataIntegrationsController_getTeamMembers parameters: - name: teamId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsRecipientInfo' tags: - Data Integrations /data-integrations/teams/all: get: operationId: DataIntegrationsController_getAllTeams parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsWithInstallationStatus' tags: - Data Integrations /data-integrations/teams/install: post: operationId: DataIntegrationsController_installSweepOnTeams parameters: [] responses: '201': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsWithInstallationStatus' tags: - Data Integrations /data-integrations/teams/uninstall: post: operationId: DataIntegrationsController_uninstallSweepOnTeams parameters: [] responses: '201': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/TeamsWithInstallationStatus' tags: - Data Integrations /comments/{funnelMapId}: get: operationId: CommentsController_fetchCommentThreadsByFunnelMapId parameters: - name: funnelMapId required: true in: path schema: type: string - name: excludeResolved required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] tags: - Comments post: operationId: CommentsController_createCommentThread parameters: - name: funnelMapId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCommentThreadDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CommentThreadDto' security: - bearer: [] tags: - Comments /comments/{funnelMapId}/{commentThreadId}/resolved: patch: operationId: CommentsController_updateCommentThreadResolved parameters: - name: funnelMapId required: true in: path schema: type: string - name: commentThreadId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CommentThreadDto' security: - bearer: [] tags: - Comments /comments/{funnelMapId}/{commentThreadId}/position: patch: operationId: CommentsController_updateCommentThreadPosition parameters: - name: funnelMapId required: true in: path schema: type: string - name: commentThreadId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCommentThreadPositionDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CommentThreadDto' security: - bearer: [] tags: - Comments /comments/{funnelMapId}/{commentThreadId}/read: patch: operationId: CommentsController_updateCommentThreadReadBy parameters: - name: funnelMapId required: true in: path schema: type: string - name: commentThreadId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CommentThreadDto' security: - bearer: [] tags: - Comments /comments/{funnelMapId}/{commentThreadId}/commentReplies: post: operationId: CommentsController_createCommentReply parameters: - name: funnelMapId required: true in: path schema: type: string - name: commentThreadId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateCommentReplyDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CommentReplyDto' security: - bearer: [] tags: - Comments /comments/{funnelMapId}/{commentThreadId}: delete: operationId: CommentsController_deleteCommentThread parameters: - name: funnelMapId required: true in: path schema: type: string - name: commentThreadId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Comments /comments/{funnelMapId}/{commentThreadId}/commentReplies/{commentReplyId}: delete: operationId: CommentsController_deleteCommentReply parameters: - name: funnelMapId required: true in: path schema: type: string - name: commentThreadId required: true in: path schema: type: string - name: commentReplyId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Comments patch: operationId: CommentsController_updateCommentReply parameters: - name: funnelMapId required: true in: path schema: type: string - name: commentThreadId required: true in: path schema: type: string - name: commentReplyId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCommentReplyDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/CommentReplyDto' security: - bearer: [] tags: - Comments /data-integrations/slack/redirect-to-oauth: get: operationId: DataIntegrationsUnauthenticatedController_redirectToSlackAuthPath parameters: - name: state required: true in: query schema: type: string responses: '200': description: '' tags: - Data Integrations (Unauthenticated) /data-integrations/slack/incoming-events: post: operationId: DataIntegrationsUnauthenticatedController_SlackIncomingEvents parameters: - name: X-Slack-Request-Timestamp required: true in: header schema: type: string - name: X-Slack-Signature required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Buffer' responses: '200': description: '' tags: - Data Integrations (Unauthenticated) /data-integrations/slack/interactive-components-events: post: operationId: DataIntegrationsUnauthenticatedController_SlackInteractiveEvents parameters: - name: X-Slack-Request-Timestamp required: true in: header schema: type: string - name: X-Slack-Signature required: true in: header schema: type: string responses: '200': description: '' tags: - Data Integrations (Unauthenticated) /data-integrations/slack/external-select: post: operationId: DataIntegrationsUnauthenticatedController_SlackExternalSelect parameters: - name: X-Slack-Request-Timestamp required: true in: header schema: type: string - name: X-Slack-Signature required: true in: header schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Buffer' responses: '200': description: '' tags: - Data Integrations (Unauthenticated) /data-integrations/teams/redirect-to-oauth: get: operationId: DataIntegrationsUnauthenticatedController_redirectToMsTeamsOAuthPath parameters: - name: data required: true in: query schema: type: string responses: '200': description: '' tags: - Data Integrations (Unauthenticated) /request-changes: get: operationId: RequestChangesController_listRequestChanges parameters: - name: funnelIds required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/RequestChange' security: - bearer: [] tags: - RequestChanges post: operationId: RequestChangesController_createRequestChange parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRequestChangesDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - RequestChanges /request-changes/actions/approve: post: operationId: RequestChangesController_approveRequestChange parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestChangesActionDto' responses: '201': description: '' security: - bearer: [] tags: - RequestChanges /request-changes/actions/reject: post: operationId: RequestChangesController_rejectRequestChange parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RequestChangesActionDto' responses: '201': description: '' security: - bearer: [] tags: - RequestChanges /territories: get: operationId: TerritoriesController_getTerritories parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/ReadTerritoryDto' security: - bearer: [] tags: - Territories post: operationId: TerritoriesController_createTerritory parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertTerritoryDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/Territory' security: - bearer: [] tags: - Territories /territories/{territoryId}: put: operationId: TerritoriesController_updateTerritory parameters: - name: territoryId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertTerritoryDto' responses: '200': description: '' security: - bearer: [] tags: - Territories delete: operationId: TerritoriesController_deleteTerritory parameters: - name: territoryId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Territories /diff/snapshots/{snapshotId}: get: operationId: DiffController_diffBySnapshotId parameters: - name: snapshotId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Diff /diff/funnels/{funnelId}: get: operationId: DiffController_diffByFunnelId parameters: - name: funnelId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Diff /sf-change-feed: get: operationId: SalesforceChangeFeedController_getChangeFeed parameters: - name: sortBy required: true in: query schema: type: string - name: sortKey required: true in: query schema: type: string - name: crmOrgs required: true in: query schema: type: array items: type: string - name: sfUserNames required: true in: query schema: type: array items: type: string - name: sections required: true in: query schema: type: array items: type: string - name: startTime required: true in: query schema: format: date-time type: string - name: endTime required: true in: query schema: format: date-time type: string - name: actionText required: true in: query schema: type: string - name: withFilters required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/SalesforceChangeFeedDto' tags: - Salesforce change feed /sf-change-feed/notifications: post: operationId: SalesforceChangeFeedController_addNotification parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSalesforceChangeFeedNotificationDto' responses: '201': description: '' tags: - Salesforce change feed get: operationId: SalesforceChangeFeedController_getNotifications parameters: [] responses: '200': description: '' tags: - Salesforce change feed /sf-change-feed/notifications/{id}: put: operationId: SalesforceChangeFeedController_editNotification parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSalesforceChangeFeedNotificationDto' responses: '200': description: '' tags: - Salesforce change feed delete: operationId: SalesforceChangeFeedController_deleteNotification parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' tags: - Salesforce change feed /notifications: get: operationId: NotificationsController_getNotifications parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/GetNotificationsResponseDto' security: - bearer: [] tags: - Notifications /notifications/events/read: post: operationId: NotificationsController_eventReadNotifications parameters: [] responses: '201': description: '' security: - bearer: [] tags: - Notifications /notifications/events/read-all: post: operationId: NotificationsController_eventReadAllNotifications parameters: [] responses: '201': description: '' security: - bearer: [] tags: - Notifications /non-admin-sfdc-connector/salesforce-redirect-to-oauth: get: operationId: NonAdminSalesforceConnectorUnauthenticatedController_redirectToSFDCOAuthPath parameters: - name: data required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Non Admin Salesforce Connector (unauthenticated) /non-admin-sfdc-connector/oauth2-callback: get: operationId: NonAdminSalesforceConnectorUnauthenticatedController_oauth2Callback parameters: - name: code required: true in: query schema: type: string - name: state required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Non Admin Salesforce Connector (unauthenticated) /funnel-analytics: post: operationId: FunnelsAnalyticsController_getFunnelAnalytics parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetFunnelAnalyticsRequestDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - FunnelsAnalytics /backoffice/accounts: get: operationId: BackofficeController_getAllAccounts parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice post: operationId: BackofficeController_updateAccountsMany parameters: [] responses: '201': description: '' tags: - Backoffice /backoffice/users: get: operationId: BackofficeController_getAllUsers parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice /backoffice/accounts/installed-packages: get: operationId: BackofficeController_getInstalledPackagesForFreeAccounts parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice /backoffice/accounts/{accountId}: post: operationId: BackofficeController_releaseAccount parameters: - name: accountId required: true in: path schema: type: string - name: completeOnboarding required: true in: query schema: type: boolean responses: '201': description: '' tags: - Backoffice /backoffice/crm_orgs/{crmOrgId}/sweep_transactions_log: get: operationId: BackofficeController_getSweepTransactionsLog parameters: - name: crmOrgId required: true in: path schema: type: string - name: startDate required: true in: query schema: type: number - name: endDate required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice /backoffice/crm_orgs/{crmOrgId}/fetch: get: operationId: BackofficeController_fetch parameters: - name: crmOrgId required: true in: path schema: type: string - name: operation required: true in: query schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/crm_orgs/{orgId}/force-refresh-token: post: operationId: BackofficeController_forceRefreshToken parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/crm_orgs/{orgId}/force-refresh-user-token: post: operationId: BackofficeController_forceRefreshUserToken parameters: - name: orgId required: true in: path schema: type: string - name: userId required: true in: query schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/crm_orgs/all/get_soql: get: operationId: BackofficeController_getAnySoqlQueryAllOrgs parameters: - name: query required: true in: query schema: type: string - name: useToolingApi required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/ai_agents/{agentId}/trigger_scan: get: operationId: BackofficeController_triggerScan parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/crm_orgs/{crmOrgId}/get_soql: get: operationId: BackofficeController_getAnySoqlQuery parameters: - name: crmOrgId required: true in: path schema: type: string - name: query required: true in: query schema: type: string - name: useToolingApi required: true in: query schema: type: boolean - name: maxFetch required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice /backoffice/accounts/{accountId}/crm_orgs: get: operationId: BackofficeController_getAllCrmOrgs parameters: - name: accountId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/CrmOrg' tags: - Backoffice /backoffice/accounts/{accountId}/orgs: get: operationId: BackofficeController_getAllOrgs parameters: - name: accountId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/orgs/{orgId}/fetch: post: operationId: BackofficeController_fetchAnyOrg parameters: - name: orgId required: true in: path schema: type: string - name: factoryReset required: true in: query schema: type: boolean responses: '201': description: '' tags: - Backoffice /backoffice/orgs/{orgId}/metadata-search: get: operationId: BackofficeController_searchOrgMetadata parameters: - name: orgId required: true in: path schema: type: string - name: searchTerm required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice /backoffice/orgs/{orgId}: get: operationId: BackofficeController_getOrgById parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/snowflake-orgs/{orgId}/query: post: operationId: BackofficeController_runSnowflakeQuery parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/crm-orgs/{crmOrgId}: get: operationId: BackofficeController_getCrmOrgById parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/crm_orgs/{crmOrgId}/salesforce-event-monitoring-log-export: post: operationId: BackofficeController_exportSalesforceEventMonitoringLogs parameters: - name: crmOrgId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SalesforceEventMonitoringLogExportDto' responses: '201': description: '' tags: - Backoffice /backoffice/crm-orgs/{crmOrgId}/tier: put: operationId: BackofficeController_updateCrmOrgTier parameters: - name: crmOrgId required: true in: path schema: type: string - name: tier required: true in: query schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/parse-all: post: operationId: BackofficeController_parseAllOrgs parameters: [] responses: '201': description: '' tags: - Backoffice /backoffice/housekeeping/purge-salto-workspaces: post: operationId: BackofficeController_archiveAllSaltoWorkspaces parameters: [] responses: '201': description: '' tags: - Backoffice /backoffice/recovery/init-missing-bare-repos: post: operationId: BackofficeController_recoverMissingBareRepos parameters: [] responses: '201': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/ai-projects/backfill-origin-template-ids: post: operationId: BackofficeController_backfillPlaybookOriginTemplateIds parameters: [] responses: '201': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/accounts/{accountId}/invite: post: operationId: BackofficeController_inviteUserToAccount parameters: - name: accountId required: true in: path schema: type: string - name: email required: true in: query schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/accounts/{accountId}/users: get: operationId: BackofficeController_getUsersByAccount parameters: - name: accountId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/accounts/{accountId}/roles: get: operationId: BackofficeController_getRoleGroupsForAccount parameters: - name: accountId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/users/{userId}/role: put: operationId: BackofficeController_updateUserRole parameters: - name: userId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/users/{userId}: delete: operationId: BackofficeController_removeUser parameters: - name: userId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/accounts/{accountId}/move-user: post: operationId: BackofficeController_moveUserToAccount parameters: - name: accountId required: true in: path schema: type: string - name: email required: true in: query schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/crm-orgs/{crmOrgId}/automations: get: operationId: BackofficeController_getAutomationsMetadata parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice /backoffice/accounts/{accountId}/trial: put: operationId: BackofficeController_setTrialEnd parameters: - name: accountId required: true in: path schema: type: string - name: daysCount required: true in: query schema: type: number responses: '200': description: '' tags: - Backoffice /backoffice/accounts/{orgId}/named-credential: post: operationId: BackofficeController_createNamedCredential parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice delete: operationId: BackofficeController_deleteNamedCredential parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/mp-version: post: operationId: BackofficeController_updateMPVersionFile parameters: [] responses: '201': description: '' summary: Update a file in s3 folder tags: - Backoffice /backoffice/cache: get: operationId: BackofficeController_getValueFromCache parameters: - name: key required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Backoffice delete: operationId: BackofficeController_deleteValueFromCache parameters: - name: key required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/crm_orgs/{orgId}/analyse/{objectName}: get: operationId: BackofficeController_createOrgAnalysisJob parameters: - name: orgId required: true in: path schema: type: string - name: objectName required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/crm_orgs/{orgId}/unused-apex-classes: get: operationId: BackofficeController_analyzeUnusedApexClasses parameters: - name: orgId required: true in: path schema: type: string - name: includeNonDefaultNamespaces required: true in: query schema: type: boolean responses: '200': description: '' tags: - Backoffice /backoffice/job-execution/failed: get: operationId: BackofficeController_getFailedJobExecutions parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/JobExecution' tags: - Backoffice /backoffice/auto-fetch/org/{orgId}: get: operationId: BackofficeController_getAutoFetchByOrgId parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice put: operationId: BackofficeController_updateAutoFetchByOrgId parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/crm_orgs/{orgId}/opt-monitoring: post: operationId: BackofficeController_changeOrgOptMonitoring parameters: - name: orgId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: type: boolean responses: '201': description: '' tags: - Backoffice /backoffice/lock/{lockKey}: get: operationId: BackofficeController_isLocked parameters: - name: lockKey required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean tags: - Backoffice /backoffice/lock/{lockKey}/{ownerId}: delete: operationId: BackofficeController_releaseLock parameters: - name: lockKey required: true in: path schema: type: string - name: ownerId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean tags: - Backoffice get: operationId: BackofficeController_getLock parameters: - name: lockKey required: true in: path schema: type: string - name: ownerId required: true in: path schema: type: string - name: expiresInMs required: true in: query schema: type: number - name: timeoutMs required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: boolean tags: - Backoffice /backoffice/product-plan/available-product-policies: get: operationId: BackofficeController_getAvailablePlan parameters: [] responses: '200': description: '' tags: - Backoffice /backoffice/product-plan/available-features: get: operationId: BackofficeController_getAvailableFeatures parameters: [] responses: '200': description: '' tags: - Backoffice /backoffice/product-plan/{accountId}: get: operationId: BackofficeController_getPlan parameters: - name: accountId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice patch: operationId: BackofficeController_updatePolicy parameters: - name: accountId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePlanDto' responses: '200': description: '' tags: - Backoffice /backoffice/product-plan/{accountId}/features: put: operationId: BackofficeController_updateFeaturesForSelectedFeatureProductPolicy parameters: - name: accountId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFeaturePlanDto' responses: '200': description: '' tags: - Backoffice get: operationId: BackofficeController_getAllowedFeaturePlanForAccount parameters: - name: accountId required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/dump-automations/{folderName}: get: operationId: BackofficeController_dumpAutomations parameters: - name: folderName required: true in: path schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/restart-python-agent: post: operationId: BackofficeController_restartPythonAgent parameters: [] responses: '201': description: '' tags: - Backoffice /backoffice/crm_orgs/{orgId}/ai-process-mining: post: operationId: BackofficeController_createAiProcessMiningFunnels parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/opensearch/reset-index/{orgId}: post: operationId: BackofficeController_reindexOpenSearch parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/opensearch/migrate-index/{orgId}: post: operationId: BackofficeController_migrateOpenSearchIndex parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/opensearch/purge-inactive-index/{orgId}: post: operationId: BackofficeController_purgeInactiveOpenSearchIndex parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/opensearch/search-by-content/{orgId}: post: operationId: BackofficeController_searchByContent parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: type: array items: type: object tags: - Backoffice /backoffice/opensearch/search-by-filename/{orgId}: post: operationId: BackofficeController_searchByFilename parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/opensearch/raw-search/{orgId}: post: operationId: BackofficeController_rawSearch parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/opensearch/scope/{orgId}: get: operationId: BackofficeController_getOpenSearchScope parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OpenSearchScope' tags: - Backoffice put: operationId: BackofficeController_updateOpenSearchScope parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/OpenSearchScope' tags: - Backoffice /backoffice/agent-files/{fileId}/generate-summary: post: operationId: BackofficeController_generateAgentFileSummary parameters: - name: fileId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/agent-files/regenerate-all-summaries: post: operationId: BackofficeController_regenerateAllAgentFileSummaries parameters: [] responses: '201': description: '' tags: - Backoffice /backoffice/accounts/{accountId}/copy-prompt-group/{promptGroupId}: post: operationId: BackofficeController_copyPromptGroupToAccounts parameters: - name: accountId required: true in: path schema: type: string - name: promptGroupId required: true in: path schema: type: string responses: '201': description: '' tags: - Backoffice /backoffice/agent-summaries: get: operationId: BackofficeController_getAgentSummaries parameters: - name: accountId required: true in: query schema: type: string - name: userEmail required: true in: query schema: type: string - name: agentName required: true in: query schema: type: string - name: mode required: true in: query schema: type: string - name: scoreMin required: true in: query schema: type: number - name: scoreMax required: true in: query schema: type: number - name: dateFrom required: true in: query schema: type: string - name: dateTo required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string - name: limit required: true in: query schema: type: number - name: offset required: true in: query schema: type: number - name: sortBy required: true in: query schema: type: string - name: sortOrder required: true in: query schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/agent-summaries/stats: get: operationId: BackofficeController_getAgentSummariesStats parameters: - name: accountId required: true in: query schema: type: string - name: userEmail required: true in: query schema: type: string - name: agentName required: true in: query schema: type: string - name: mode required: true in: query schema: type: string - name: scoreMin required: true in: query schema: type: number - name: scoreMax required: true in: query schema: type: number - name: dateFrom required: true in: query schema: type: string - name: dateTo required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - Backoffice /backoffice/agent-summaries/accounts: get: operationId: BackofficeController_getAccountGroupedSummaries parameters: - name: accountId required: true in: query schema: type: string - name: userEmail required: true in: query schema: type: string - name: agentName required: true in: query schema: type: string - name: mode required: true in: query schema: type: string - name: scoreMin required: true in: query schema: type: number - name: scoreMax required: true in: query schema: type: number - name: dateFrom required: true in: query schema: type: string - name: dateTo required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/agent-summaries/users: get: operationId: BackofficeController_getUserGroupedSummaries parameters: - name: accountId required: true in: query schema: type: string - name: userEmail required: true in: query schema: type: string - name: agentName required: true in: query schema: type: string - name: mode required: true in: query schema: type: string - name: scoreMin required: true in: query schema: type: number - name: scoreMax required: true in: query schema: type: number - name: dateFrom required: true in: query schema: type: string - name: dateTo required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/agent-summaries/agents: get: operationId: BackofficeController_getAgentGroupedSummaries parameters: - name: accountId required: true in: query schema: type: string - name: userEmail required: true in: query schema: type: string - name: agentName required: true in: query schema: type: string - name: mode required: true in: query schema: type: string - name: scoreMin required: true in: query schema: type: number - name: scoreMax required: true in: query schema: type: number - name: dateFrom required: true in: query schema: type: string - name: dateTo required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/agent-summaries/modes: get: operationId: BackofficeController_getModeGroupedSummaries parameters: - name: accountId required: true in: query schema: type: string - name: userEmail required: true in: query schema: type: string - name: agentName required: true in: query schema: type: string - name: scoreMin required: true in: query schema: type: number - name: scoreMax required: true in: query schema: type: number - name: dateFrom required: true in: query schema: type: string - name: dateTo required: true in: query schema: type: string - name: searchTerm required: true in: query schema: type: string responses: '200': description: '' tags: - Backoffice /backoffice/ai-artifacts/{versionId}: get: operationId: BackofficeController_getAiArtifactByVersionId parameters: - name: versionId required: true in: path schema: type: string responses: '200': description: '' summary: 'Fetch a single AI artifact by its version id (primary key of AiArtifact). `versionId` matches the naming used in the dashboard''s artifact API and in the `[Artifact: (ID: <artifactId>, Version: <versionId>)]` markers embedded in AgentSummary.answer. Used by the backoffice Agent Summaries UI to preview the artifact referenced by a summary on-demand.' tags: - Backoffice /backoffice/sync-graph-db-batch: post: operationId: BackofficeController_syncGraphDbBatch parameters: [] responses: '201': description: '' tags: - Backoffice /hubspot: get: operationId: HubSpotController_getOrgs parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - hubspot /hubspot/org/{orgId}: get: operationId: HubSpotController_getOrg parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - hubspot /hubspot/oauth2-callback: get: operationId: HubSpotController_oauth2Callback parameters: [] responses: '200': description: '' content: application/json: schema: type: string security: - bearer: [] tags: - hubspot /hubspot/new: post: operationId: HubSpotController_createOrgs parameters: - name: demo required: true in: query schema: type: boolean requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/HubspotCrmOrgCreateDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - hubspot /hubspot/fields/{orgId}/{objectName}: get: operationId: HubSpotController_getFields parameters: - name: orgId required: true in: path schema: type: string - name: objectName required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - hubspot /hubspot/{orgId}: delete: operationId: HubSpotController_deleteOrg parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - hubspot /hubspot/workflow/{workflowId}: get: operationId: HubSpotController_getWorkflowFromHubpsot parameters: - name: workflowId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - hubspot /hubspot/event-components: get: operationId: HubSpotController_getOrgByType parameters: - name: type required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - hubspot /hubspot/membership-lists: get: operationId: HubSpotController_getMembershipLists parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - hubspot /hubspot-connector/redirect-to-oauth: get: operationId: HubSpotConnectorController_redirectToHubspotOAuthPath parameters: [] responses: '200': description: '' tags: - hubspot connector (unauthenticated) /automations: get: operationId: AutomationController_getAutomations parameters: - name: orgId required: true in: query schema: type: string - name: all required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations post: operationId: AutomationController_createAutomation parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAutomationDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/{automationId}: get: operationId: AutomationController_getAutomationById parameters: - name: automationId required: true in: path schema: type: string - name: orgId required: true in: query schema: type: string - name: includeReadOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Automations delete: operationId: AutomationController_deleteAutomation parameters: - name: automationId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/{automationId}/history: get: operationId: AutomationController_getVersionHistory parameters: - name: automationId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Automations /automations/read-only: post: operationId: AutomationController_createReadOnlyAutomation parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AutomationDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Automations /automations/alerts: post: operationId: AutomationController_createAlert parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAutomationDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/marketing-attributions: post: operationId: AutomationController_createMarketingAttribution parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAutomationDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/marketing-attributions/templates: post: operationId: AutomationController_createMarketingAttributionTemplates parameters: [] requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/assignments: post: operationId: AutomationController_createAssignment parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAutomationDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/dedupe-matching: post: operationId: AutomationController_createDedupeOrMatching parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAutomationDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/ai-create: post: operationId: AutomationController_createAutomationWithAi parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAutomationWithAiDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AutoTemplatesStructDto' security: - bearer: [] tags: - Automations /automations/{automationId}/{versionId}: put: operationId: AutomationController_editAutomation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAutomationDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/alerts/{automationId}/{versionId}: put: operationId: AutomationController_editAlert parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAutomationDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/marketing-attributions/{automationId}/{versionId}: put: operationId: AutomationController_editMarketingAttribution parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAutomationDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/assignments/{automationId}/{versionId}: put: operationId: AutomationController_editAssignment parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAutomationDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/dedupe-matching/{automationId}/{versionId}: put: operationId: AutomationController_editDedupeOrMatching parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAutomationDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/deployment/{automationId}/{versionId}: post: operationId: AutomationController_deployAutomation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployAutomationDto' responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/alerts/deployment/{automationId}/{versionId}: post: operationId: AutomationController_deployAlert parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployAutomationDto' responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/marketing-attributions/deployment/{automationId}/{versionId}: post: operationId: AutomationController_deployMarketingAttribution parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployAutomationDto' responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/assignments/deployment/{automationId}/{versionId}: post: operationId: AutomationController_deployAssignment parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployAutomationDto' responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/dedupe-matching/deployment/{automationId}/{versionId}: post: operationId: AutomationController_deployDedupeOrMatching parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployAutomationDto' responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/ai-impact-analysis-chat: post: operationId: AutomationController_createAutomationAiImpactAnalysisChat parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiChatDto' responses: '201': description: '' content: application/json: schema: type: string security: - bearer: [] tags: - Automations /automations/assignments/ai-impact-analysis-chat: post: operationId: AutomationController_createAssignmentAiImpactAnalysisChat parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiChatDto' responses: '201': description: '' content: application/json: schema: type: string security: - bearer: [] tags: - Automations /automations/activation/{automationId}/{versionId}: patch: operationId: AutomationController_toggleActivation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AutomationActivationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/alerts/activation/{automationId}/{versionId}: patch: operationId: AutomationController_toggleAlertActivation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AutomationActivationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/assignments/activation/{automationId}/{versionId}: patch: operationId: AutomationController_toggleAssignmentActivation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AutomationActivationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/dedupe-matching/activation/{automationId}/{versionId}: patch: operationId: AutomationController_toggleDedupeOrMatchingActivation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AutomationActivationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/admin-notification/{automationId}/{versionId}: patch: operationId: AutomationController_notifyAdminOnAutomation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdminNotificationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/alerts/admin-notification/{automationId}/{versionId}: patch: operationId: AutomationController_notifyAdminOnAlert parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdminNotificationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/assignments/admin-notification/{automationId}/{versionId}: patch: operationId: AutomationController_notifyAdminOnAssignment parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdminNotificationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/dedupe-matching/admin-notification/{automationId}/{versionId}: patch: operationId: AutomationController_notifyAdminOnDedupeOrMatching parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdminNotificationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/alerts/{automationId}: delete: operationId: AutomationController_deleteAlert parameters: - name: automationId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/assignments/{automationId}: delete: operationId: AutomationController_deleteAssignment parameters: - name: automationId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/marketing-attributions/{automationId}: delete: operationId: AutomationController_deleteMarketingAttribution parameters: - name: automationId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/dedupe-matching/{automationId}: delete: operationId: AutomationController_deleteDedupeOrMatching parameters: - name: automationId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/booking: post: operationId: AutomationController_createBooking parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAutomationDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/booking/{automationId}/{versionId}: put: operationId: AutomationController_editBooking parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAutomationDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AutomationDto' security: - bearer: [] tags: - Automations /automations/booking/deployment/{automationId}/{versionId}: post: operationId: AutomationController_deployBooking parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployAutomationDto' responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/booking/activation/{automationId}/{versionId}: patch: operationId: AutomationController_toggleBookingActivation parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AutomationActivationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/booking/{automationId}: delete: operationId: AutomationController_deleteBooking parameters: - name: automationId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/booking/admin-notification/{automationId}/{versionId}: patch: operationId: AutomationController_notifyAdminOnBooking parameters: - name: automationId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdminNotificationDto' responses: '200': description: '' security: - bearer: [] tags: - Automations /automations/order/Default: get: operationId: AutomationController_listAutomationsExecutionOrder parameters: - name: triggerType required: true in: query schema: type: string - name: objectType required: true in: query schema: type: string - name: enterStep required: true in: query schema: type: string - name: exitStep required: true in: query schema: type: string - name: inStep required: true in: query schema: type: string - name: funnelId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Automations post: operationId: AutomationController_deployAutomationsExecutionOrder parameters: [] requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/order/Alert: get: operationId: AutomationController_listAlertsExecutionOrder parameters: - name: triggerType required: true in: query schema: type: string - name: objectType required: true in: query schema: type: string - name: enterStep required: true in: query schema: type: string - name: exitStep required: true in: query schema: type: string - name: inStep required: true in: query schema: type: string - name: funnelId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Automations post: operationId: AutomationController_deployAlertsExecutionOrder parameters: [] requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: '' security: - bearer: [] tags: - Automations /automations/order/Assignment: get: operationId: AutomationController_listAssignmentsExecutionOrder parameters: - name: triggerType required: true in: query schema: type: string - name: objectType required: true in: query schema: type: string - name: enterStep required: true in: query schema: type: string - name: exitStep required: true in: query schema: type: string - name: inStep required: true in: query schema: type: string - name: funnelId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Automations post: operationId: AutomationController_deployAssignmentsExecutionOrder parameters: [] requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: '' security: - bearer: [] tags: - Automations /devops-center: get: operationId: DevopsCenterController_getAllElementsInEnv parameters: - name: sourceCrmOrgId required: true in: query schema: type: string - name: targetCrmOrgId required: true in: query schema: type: string - name: elementTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - DevopsCenter post: operationId: DevopsCenterController_deployElementsInEnv parameters: - name: targetCrmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: '' tags: - DevopsCenter /global/{orgId}: get: operationId: GlobalController_getAll parameters: - name: orgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Global /rollups: get: operationId: RollupController_getRollups parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/RollupDto' security: - bearer: [] tags: - Rollups post: operationId: RollupController_createRollup parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateRollupDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/RollupDto' security: - bearer: [] tags: - Rollups /rollups/{rollupId}: get: operationId: RollupController_getRollupById parameters: - name: rollupId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string - name: includeReadOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Rollups delete: operationId: RollupController_deleteRollup parameters: - name: rollupId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Rollups /rollups/read-only: post: operationId: RollupController_createReadOnlyRollup parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRollupDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Rollups /rollups/{rollupId}/{versionId}: put: operationId: RollupController_editRollup parameters: - name: rollupId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateRollupDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/RollupDto' security: - bearer: [] tags: - Rollups post: operationId: RollupController_deployRollup parameters: - name: rollupId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployRollupDto' responses: '201': description: '' security: - bearer: [] tags: - Rollups /rollups/admin-notification/{rollupId}/{versionId}: patch: operationId: RollupController_notifyAdminOnRollup parameters: - name: rollupId required: true in: path schema: type: string - name: versionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AdminNotificationDto' responses: '200': description: '' security: - bearer: [] tags: - Rollups /dashboard: get: operationId: DashboardController_getAccountStatus parameters: [] responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Dashboard /dashboard/accountDetails: put: operationId: DashboardController_updateUserAndAccountName parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateUserAndAccountDetails' responses: '200': description: '' security: - bearer: [] tags: - Dashboard /sfdc-callout/ai-support/chats: post: operationId: SfdcCalloutController_createSupportChat parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateSupportChatDto' responses: '201': description: '' content: application/json: schema: type: object tags: - SFDC Callout get: operationId: SfdcCalloutController_listSupportChats parameters: - name: userId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - SFDC Callout /sfdc-callout/ai-support/chats/{chatId}: patch: operationId: SfdcCalloutController_sendSupportMessage parameters: - name: chatId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SendSupportMessageDto' responses: '200': description: '' content: application/json: schema: type: object tags: - SFDC Callout get: operationId: SfdcCalloutController_getSupportChat parameters: - name: chatId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - SFDC Callout /sfdc-callout/external-messages: post: operationId: SfdcCalloutController_externalMessage parameters: [] requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: '' tags: - SFDC Callout /sfdc-callout/create-channels: post: operationId: SfdcCalloutController_createChannels parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SfdcCreateChannelsRequestDto' responses: '201': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/SfdcCreateChannelResponse' tags: - SFDC Callout /sfdc-callout/job-execution: post: operationId: SfdcCalloutController_createJobs parameters: [] requestBody: required: true content: application/json: schema: type: array items: type: string responses: '201': description: '' tags: - SFDC Callout /sfdc-callout/job-executions: post: operationId: SfdcCalloutController_createJobExecutions parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateJobExecutionsDto' responses: '201': description: '' content: application/json: schema: type: array items: type: object tags: - SFDC Callout /sfdc-callout/job-executions/results: post: operationId: SfdcCalloutController_getJobExecutionResults parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobExecutionResultDto' responses: '201': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/JobExecutionResult' tags: - SFDC Callout /sfdc-callout/job-execution/results: post: operationId: SfdcCalloutController_getJobResults parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GetJobExecutionResultDto' responses: '201': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/JobExecutionResult' tags: - SFDC Callout /sfdc-callout/field-utilization: post: operationId: SfdcCalloutController_receiveFieldUtilization parameters: [] responses: '201': description: '' tags: - SFDC Callout /sfdc-callout/scheduling/rep/availability-settings: get: operationId: SfdcCalloutSchedulingController_getAvailabilitySettings parameters: - name: sfUserId required: true in: query schema: type: string responses: '200': description: '' tags: - SFDC Callout — Scheduling put: operationId: SfdcCalloutSchedulingController_updateAvailabilitySettings parameters: [] responses: '200': description: '' tags: - SFDC Callout — Scheduling /sfdc-callout/scheduling/rep/connection-status: get: operationId: SfdcCalloutSchedulingController_getConnectionStatus parameters: - name: sfUserId required: true in: query schema: type: string responses: '200': description: '' tags: - SFDC Callout — Scheduling /sfdc-callout/scheduling/rep/oauth-url/google: get: operationId: SfdcCalloutSchedulingController_getGoogleOAuthUrl parameters: - name: sfUserId required: true in: query schema: type: string responses: '200': description: '' tags: - SFDC Callout — Scheduling /sfdc-callout/scheduling/rep/oauth-url/zoom: get: operationId: SfdcCalloutSchedulingController_getZoomOAuthUrl parameters: - name: sfUserId required: true in: query schema: type: string responses: '200': description: '' tags: - SFDC Callout — Scheduling /sfdc-callout/scheduling/rep/disconnect/google: post: operationId: SfdcCalloutSchedulingController_disconnectGoogle parameters: [] responses: '201': description: '' tags: - SFDC Callout — Scheduling /sfdc-callout/scheduling/rep/disconnect/zoom: post: operationId: SfdcCalloutSchedulingController_disconnectZoom parameters: [] responses: '201': description: '' tags: - SFDC Callout — Scheduling /campaigns: get: operationId: CampaignsController_getCampaigns parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Campaigns post: operationId: CampaignsController_writeCampaign parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WriteCampaignDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CampaignDto' security: - bearer: [] tags: - Campaigns /campaigns/campaign-member-status/{campaignId}: get: operationId: CampaignsController_getCampaignMemberStatusOfCampaign parameters: - name: campaignId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/CampaignMemberStatus' security: - bearer: [] tags: - Campaigns delete: operationId: CampaignsController_deleteCampaignMemberStatus parameters: - name: campaignId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReplaceStatusDto' responses: '200': description: '' security: - bearer: [] tags: - Campaigns /campaigns/campaign/{campaignId}: patch: operationId: CampaignsController_upsertCampaign parameters: - name: campaignId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WriteCampaignDto' responses: '200': description: '' security: - bearer: [] tags: - Campaigns delete: operationId: CampaignsController_deleteCampaign parameters: - name: campaignId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Campaigns /campaigns/all-campaign-member-status: get: operationId: CampaignsController_getAllCampaignMemberStatus parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: string security: - bearer: [] tags: - Campaigns /campaigns/campaign-member-status: post: operationId: CampaignsController_addCampaignMemberStatusToCampaign parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WriteCampaignMemberStatusDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/CampaignMemberStatus' security: - bearer: [] tags: - Campaigns /campaigns/campaign-member-status/{campaignMemberStatusId}: patch: operationId: CampaignsController_updateCampaignMemberStatus parameters: - name: campaignMemberStatusId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateCampaignMemberStatusDto' responses: '200': description: '' security: - bearer: [] tags: - Campaigns /campaigns/fields: get: operationId: CampaignsController_getFieldNamesForCampaigns parameters: [] responses: '200': description: '' security: - bearer: [] tags: - Campaigns /workflows: get: operationId: WorkflowController_getWorkflows parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/WorkflowDto' security: - bearer: [] tags: - workflows post: operationId: WorkflowController_createWorkflow parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateWorkflowDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/WorkflowDto' security: - bearer: [] tags: - workflows put: operationId: WorkflowController_updateWorkflow parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateWorkflowDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/WorkflowDto' security: - bearer: [] tags: - workflows /workflows/{workflowId}: delete: operationId: WorkflowController_deleteWorkflow parameters: - name: workflowId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - workflows /python: get: operationId: PythonController_checkPython parameters: [] responses: '200': description: '' content: application/json: schema: type: object tags: - Python /utility-bar: post: operationId: UtilityBarController_toggleAiSupportForApps parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ToggleUtilityBarDto' responses: '201': description: '' security: - bearer: [] tags: - Utility-bar /utility-bar/apps: get: operationId: UtilityBarController_getApps parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/SalesforceAppDto' security: - bearer: [] tags: - Utility-bar /ai-session: get: operationId: AiSessionController_getSessions parameters: [] responses: '200': description: '' security: - bearer: [] tags: - ai-session /ai-session/{sessionId}: put: operationId: AiSessionController_updateSessionStatus parameters: - name: sessionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSessionStatusDto' responses: '200': description: '' security: - bearer: [] tags: - ai-session /roles/groups: get: operationId: RolesController_getRoleGroups parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - roles /roles/group: post: operationId: RolesController_createRoleGroup parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertRoleGroupDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - roles /roles/group/{id}: put: operationId: RolesController_updateRoleGroup parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertRoleGroupDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - roles delete: operationId: RolesController_deleteRoleGroup parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - roles /logo-dev/search: get: operationId: LogoDevController_searchLogo parameters: - name: q required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Logo Dev /third-party-funnels: get: operationId: ThirdPartyFunnelsController_getAllFunnels parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/ThirdPartyFunnelDto' security: - bearer: [] tags: - ThirdPartyFunnels post: operationId: ThirdPartyFunnelsController_createFunnel parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertThirdPartyFunnelDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/ThirdPartyFunnelDto' security: - bearer: [] tags: - ThirdPartyFunnels /third-party-funnels/{thirdPartyFunnelId}: put: operationId: ThirdPartyFunnelsController_updateThirdPartyFunnel parameters: - name: thirdPartyFunnelId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertThirdPartyFunnelDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/ThirdPartyFunnelDto' security: - bearer: [] tags: - ThirdPartyFunnels delete: operationId: ThirdPartyFunnelsController_deleteThirdPartyFunnel parameters: - name: thirdPartyFunnelId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - ThirdPartyFunnels /ai-agents: get: operationId: AiAgentsController_getAgents parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents post: operationId: AiAgentsController_createAgent parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAgentDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AiAgent' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/name: patch: operationId: AiAgentsController_renameAgent parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditAgentNameDto' responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/user-instructions: patch: operationId: AiAgentsController_editAgentUserInstructions parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditAgentUserInstructionsDto' responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/system-instructions: patch: operationId: AiAgentsController_editAgentSystemInstructions parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditAgentSystemInstructionsDto' responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/configurations: patch: operationId: AiAgentsController_patchAgentConfigurations parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/PatchAgentConfigurationsDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiAgent' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}: delete: operationId: AiAgentsController_deleteAgent parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/files/upload-url: post: operationId: AiAgentsController_generateFileUploadUrl parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/GenerateFileUploadUrlDto' responses: '201': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/files/confirm-upload: post: operationId: AiAgentsController_confirmFileUpload parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConfirmFileUploadDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/files/{fileId}: delete: operationId: AiAgentsController_deleteAgentFile parameters: - name: agentId required: true in: path schema: type: string - name: fileId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/files/{fileId}/download-url: get: operationId: AiAgentsController_generateFileDownloadUrl parameters: - name: agentId required: true in: path schema: type: string - name: fileId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/files/{fileId}/preview: get: operationId: AiAgentsController_generateFilePreview parameters: - name: agentId required: true in: path schema: type: string - name: fileId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/chats/{chatId}/add-to-agent: post: operationId: AiAgentsController_addChatToAgentFiles parameters: - name: agentId required: true in: path schema: type: string - name: chatId required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/chats: post: operationId: AiAgentsController_createChat parameters: - name: agentId required: true in: path schema: type: string - name: pythonExperimental required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChatMessageDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents get: operationId: AiAgentsController_getAiChats parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/chats/{chatId}: patch: operationId: AiAgentsController_sendMessage parameters: - name: chatId required: true in: path schema: type: string - name: pythonExperimental required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChatMessageDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents get: operationId: AiAgentsController_getChat parameters: - name: chatId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents delete: operationId: AiAgentsController_deleteChat parameters: - name: chatId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Ai Agents /ai-agents/stream/{id}: delete: operationId: AiAgentsController_cancelStream parameters: - name: id required: true in: path schema: type: string - name: useRedis required: true in: query schema: type: string - name: chatId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Ai Agents get: operationId: AiAgentsController_streamChatResponse parameters: - name: id required: true in: path schema: type: string - name: useRedis required: true in: query schema: type: string - name: chatId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/chats/{chatId}/mcp-tool-approval: post: operationId: AiAgentsController_handleMcpToolApproval parameters: - name: agentId required: true in: path schema: type: string - name: chatId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/McpToolApprovalDto' responses: '201': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/chats/{chatId}/name: patch: operationId: AiAgentsController_rename parameters: - name: chatId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Ai Agents /ai-agents/chats/{chatId}/favorite: patch: operationId: AiAgentsController_setIsFavorite parameters: - name: chatId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Ai Agents /ai-agents/monitoring/{agentId}/metadata-elements: get: operationId: AiAgentsController_getMonitoringMetadataElements parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/monitoring/{agentId}/issues: get: operationId: AiAgentsController_getMonitoringV2PotentialIssues parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/monitoring/{agentId}/issues/{issueId}: patch: operationId: AiAgentsController_setMonitoringIssueStatus parameters: - name: agentId required: true in: path schema: type: string - name: issueId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateIssueDto' responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/folders: post: operationId: AiAgentsController_createFolder parameters: - name: agentId required: true in: path schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Ai Agents get: operationId: AiAgentsController_getFolders parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/folders/{folderId}/name: patch: operationId: AiAgentsController_renameFolder parameters: - name: agentId required: true in: path schema: type: string - name: folderId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/folders/{folderId}: delete: operationId: AiAgentsController_deleteFolder parameters: - name: agentId required: true in: path schema: type: string - name: folderId required: true in: path schema: type: string - name: deleteChats required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/chats/{chatId}/folder: patch: operationId: AiAgentsController_setChatFolder parameters: - name: agentId required: true in: path schema: type: string - name: chatId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: boolean security: - bearer: [] tags: - Ai Agents /ai-agents/chats: get: operationId: AiAgentsController_getAiChatsDeprecated parameters: - name: agentId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/chats/sfdc: get: operationId: AiAgentsController_getSupportSalesforceChats parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/chats/search: get: operationId: AiAgentsController_searchDeprecated parameters: - name: term required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/AiChat' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/chats/search: get: operationId: AiAgentsController_search parameters: - name: term required: true in: query schema: type: string - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/AiChat' security: - bearer: [] tags: - Ai Agents /ai-agents/chats/{chatId}/messages/{messageIndex}: delete: operationId: AiAgentsController_deleteChatMessagePair parameters: - name: chatId required: true in: path schema: type: string - name: messageIndex required: true in: path schema: type: number requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeleteAiChatMessagePairDto' responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/chats/{chatId}/feedback/{runId}: post: operationId: AiAgentsController_submitFeedback parameters: - name: chatId required: true in: path schema: type: string - name: runId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SubmitFeedbackDto' responses: '201': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/best-practices: post: operationId: AiAgentsController_addBestPracticesToAgent parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ManageBestPracticesDto' responses: '201': description: '' security: - bearer: [] tags: - Ai Agents delete: operationId: AiAgentsController_removeBestPracticesFromAgent parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ManageBestPracticesDto' responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/{agentId}/artifacts: get: operationId: AiAgentsController_getArtifacts parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/artifacts/by-artifact-id/{artifactId}/versions: get: operationId: AiAgentsController_getArtifactVersionsSummaries parameters: - name: artifactId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Ai Agents /ai-agents/artifacts/shared/{id}: get: operationId: AiAgentsController_getSharedArtifact parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiArtifact' security: - bearer: [] summary: 'Resolve a company-share link. `:id` may be a logical artifactId (stable) or a legacy version UUID. Returns the currently shared version for that family, or the latest version when nothing is shared and the caller is the creator.' tags: - Ai Agents /ai-agents/artifacts/{versionId}: get: operationId: AiAgentsController_getArtifact parameters: - name: versionId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiArtifact' security: - bearer: [] tags: - Ai Agents /ai-agents/artifacts/{id}/share: patch: operationId: AiAgentsController_shareArtifact parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/artifacts/{id}/public: patch: operationId: AiAgentsController_setArtifactPublic parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/artifacts/{id}/public-url-token: get: operationId: AiAgentsController_getArtifactPublicToken parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Ai Agents /ai-agents/table-artifacts/{tableId}: get: operationId: AiAgentsController_getTableArtifact parameters: - name: tableId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiTableArtifact' security: - bearer: [] tags: - Ai Agents /ai-agents/build-definitions/{buildDefinitionId}: get: operationId: AiAgentsController_getBuildDefinition parameters: - name: buildDefinitionId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiBuildDefinition' security: - bearer: [] tags: - Ai Agents /ai-agents/process-mining/{funnelMapId}: post: operationId: AiAgentsController_processMiningSingleRequest parameters: - name: funnelMapId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ProcessMiningAgentDto' responses: '201': description: '' security: - bearer: [] tags: - Ai Agents /ai-attachments/parse: post: operationId: AiAttachmentsController_parse parameters: [] responses: '201': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - ai-attachments /ai-attachments/{id}/download-url: get: operationId: AiAttachmentsController_getDownloadUrl parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - ai-attachments /ai-attachments/{id}/preview: get: operationId: AiAttachmentsController_getPreview parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - ai-attachments /ai-attachments/chats/{chatId}/upload-urls: post: operationId: AiAttachmentsController_getUploadUrls parameters: - name: chatId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ChatAttachmentsUploadUrlsDto' responses: '201': description: '' security: - bearer: [] tags: - ai-attachments /ai-retrievers/whoami: get: operationId: AiRetrieversController_getMe parameters: [] responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/parse/{objectName}: get: operationId: AiRetrieversController_getObjectParsedData parameters: - name: objectName required: true in: path schema: type: string - name: activeOnly required: true in: query schema: type: boolean - name: withFieldsUtilization required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/objects/{objectName}/sweep-automations: get: operationId: AiRetrieversController_getObjectSweepAutomations parameters: - name: objectName required: true in: path schema: type: string - name: activeOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/field-consumers/sfdc: get: operationId: AiRetrieversController_getFieldConsumers parameters: - name: objectName required: true in: query schema: type: string - name: fieldName required: true in: query schema: type: string - name: activeOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/field-consumers/sweep: get: operationId: AiRetrieversController_getFieldSweepConsumers parameters: - name: objectName required: true in: query schema: type: string - name: fieldName required: true in: query schema: type: string - name: activeOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/configuration/{configurationName}: get: operationId: AiRetrieversController_getConfigurationByName parameters: - name: configurationName required: true in: path schema: type: string - name: metadataType required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/configuration/{configurationName}/nacl: get: operationId: AiRetrieversController_getConfigurationNacl parameters: - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/objects/{objectName}/nacl: get: operationId: AiRetrieversController_getObjectNacl parameters: - name: objectName required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/sweep-automation/{automationName}/matches: get: operationId: AiRetrieversController_getAutomationMatches parameters: - name: automationName required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/sweep-automation/{automationName}: get: operationId: AiRetrieversController_getAutomationByName parameters: - name: automationName required: true in: path schema: type: string - name: objectName required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: string security: - bearer: [] tags: - AI Retrievers /ai-retrievers/best-practices: get: operationId: AiRetrieversController_getBestPractices parameters: - name: bestPracticeId required: true in: query schema: type: string - name: keyword required: true in: query schema: type: string - name: name required: true in: query schema: type: string - name: applicableResourceType required: true in: query schema: type: string - name: severity required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/issues/{agentId}/map: get: operationId: AiRetrieversController_getIssueMap parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/issues/{agentId}: get: operationId: AiRetrieversController_searchIssues parameters: - name: agentId required: true in: path schema: type: string - name: issueId required: true in: query schema: type: string - name: keyword required: true in: query schema: type: string - name: resourceType required: true in: query schema: type: string - name: resourceName required: true in: query schema: type: string - name: severity required: true in: query schema: type: string - name: status required: true in: query schema: type: string - name: resolvedInSalesforce required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/issues/{agentId}/history: get: operationId: AiRetrieversController_getIssuesHistory parameters: - name: agentId required: true in: path schema: type: string - name: configurationName required: true in: query schema: type: string - name: configurationType required: true in: query schema: type: string - name: bestPracticeName required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/configuration/{configurationName}/dependencies: get: operationId: AiRetrieversController_getConfigurationDependencies parameters: - name: activeOnly required: true in: query schema: type: boolean - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/configuration/{configurationName}/consumers: get: operationId: AiRetrieversController_getConfigurationConsumers parameters: - name: activeOnly required: true in: query schema: type: boolean - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/sweep-automation/{automationName}/dependencies: get: operationId: AiRetrieversController_getSweepAutomationDependencies parameters: - name: automationName required: true in: path schema: type: string - name: objectName required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/configuration/{configurationName}/cpq-relationships: get: operationId: AiRetrieversController_getCpqRelationships parameters: - name: metadataId required: true in: query schema: type: string - name: activeOnly required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/configuration/{configurationName}/cpq-relationships/implementations: get: operationId: AiRetrieversController_getCpqRelationshipsImplementations parameters: - name: metadataId required: true in: query schema: type: string - name: activeOnly required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/sweep-territories: get: operationId: AiRetrieversController_getSweepTerritories parameters: - name: id required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/users/{userId}: get: operationId: AiRetrieversController_getUser parameters: - name: userId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/sweep-time-off: get: operationId: AiRetrieversController_getSweepTimeOff parameters: - name: userIds required: true in: query schema: type: array items: type: string - name: includeInactive required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/records/{recordId}: get: operationId: AiRetrieversController_getRecordData parameters: - name: recordId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/run-soql: post: operationId: AiRetrieversController_getAnySoqlQuery parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SfdcRunSoqlQueryDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/run-soql-next: post: operationId: AiRetrieversController_getAnySoqlQueryMore parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SfdcRunSoqlNextQueryDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/event-monitoring/list-events: post: operationId: AiRetrieversController_listEventMonitoringEvents parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EventMonitoringListEventsDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/event-monitoring/aggregate: post: operationId: AiRetrieversController_aggregateEventMonitoringEvents parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EventMonitoringAggregateDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/run-aggregate-soql: post: operationId: AiRetrieversController_runAggregateSoqlQuery parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SfdcRunSoqlQueryDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/run-detailed-soql: post: operationId: AiRetrieversController_runDetailedSoqlQuery parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SfdcRunSoqlQueryDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/salesforce-limits: get: operationId: AiRetrieversController_getOrgLimits parameters: [] responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/sobject-describe/{objectName}: get: operationId: AiRetrieversController_getSObjectDescribe parameters: - name: objectName required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/sweep-assignment-groups: get: operationId: AiRetrieversController_getSweepAssignmentGroups parameters: - name: groupId required: true in: query schema: type: string - name: nameContains required: true in: query schema: type: string - name: memberNameContains required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/report-type-fields: get: operationId: AiRetrieversController_getReportTypeFields parameters: - name: reportType required: true in: query schema: type: string - name: isCustomType required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/report-types: get: operationId: AiRetrieversController_getReportTypes parameters: [] responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/deploy-metadata-xml: post: operationId: AiRetrieversController_deployMetadataXml parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeployMetadataDto' responses: '201': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/deploy-salesforce-records: post: operationId: AiRetrieversController_deploySalesforceRecords parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DeploySalesforceRecordsDto' responses: '201': description: '' security: - bearer: [] summary: 'Deploy (CREATE or UPDATE) Salesforce records via the REST Data API. NOTE: Salesforce REST API limits writes to 200 records per call. The Python client enforces this cap; we do not re-validate here. TODO: Gate with a dedicated @Permissions(''access:deploy-salesforce-records'') claim once defined. Currently access is controlled by ApiKeyAuthGuard + isBuildModeEnabled on the account.' tags: - AI Retrievers /ai-retrievers/retrieve-metadata-xml: get: operationId: AiRetrieversController_retrieveMetadataXml parameters: - name: metadataType required: true in: query schema: type: string - name: metadataXmlName required: true in: query schema: type: string - name: objectName required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/configurations-ai-summaries: post: operationId: AiRetrieversController_getConfigurationsAiSummaries parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ConfigurationsSummariesDto' responses: '201': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/permission-set-definition: get: operationId: AiRetrieversController_getPermissionSetDefinition parameters: - name: id required: true in: query schema: type: string - name: sections required: true in: query schema: type: array items: type: string - name: objects required: true in: query schema: type: array items: type: string - name: countOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/profile-definition: get: operationId: AiRetrieversController_getProfileDefinition parameters: - name: id required: true in: query schema: type: string - name: sections required: true in: query schema: type: array items: type: string - name: objects required: true in: query schema: type: array items: type: string - name: countOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/records/{recordId}/documents: get: operationId: AiRetrieversController_getRecordDocuments parameters: - name: recordId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/metadata-types/{metadataTypeName}: get: operationId: AiRetrieversController_listMetadata parameters: - name: metadataTypeName required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/metadata-types/settings/{settingsType}: get: operationId: AiRetrieversController_getSettingsNaclOrTypes parameters: - name: settingsType required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/funnel-map/{funnelMapId}: put: operationId: AiRetrieversController_updateFunnelMapWithMetadata parameters: - name: funnelMapId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/FunnelMapUpdateFunnelMapDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/FunnelMap' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/search-metadata: post: operationId: AiRetrieversController_searchMetadataPost parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SearchMetadataDto' responses: '201': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/recordtypes-with-potential-leading-fields: get: operationId: AiRetrieversController_getRecordTypesWithPotentialLeadingFields parameters: - name: objectName required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/objects/counters: get: operationId: AiRetrieversController_queryDocumentationObjectCounters parameters: - name: objectNames required: true in: query schema: type: array items: type: string - name: topN required: true in: query schema: type: number - name: sortBy required: true in: query schema: type: string - name: sortOrder required: true in: query schema: type: string - name: includeManaged required: true in: query schema: type: boolean - name: includeStandard required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/DocumentationObjectCounters' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/audit-trail: get: operationId: AiRetrieversController_queryAuditTrail parameters: - name: date_from required: true in: query schema: format: date-time type: string - name: date_to required: true in: query schema: format: date-time type: string - name: limit required: true in: query schema: type: number - name: search_text required: true in: query schema: type: string - name: created_by_name required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/mcp-connections: get: operationId: AiRetrieversController_getMcpConnections parameters: - name: connectionIds required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/search-snowflake-elements: get: operationId: AiRetrieversController_searchSnowflakeElements parameters: - name: searchTerm required: true in: query schema: type: string - name: elementTypes required: true in: query schema: type: array items: type: string - name: schema required: true in: query schema: type: string - name: pageSize required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/snowflake-element-by-name/{name}: get: operationId: AiRetrieversController_getSnowflakeElementByName parameters: - name: name required: true in: path schema: type: string - name: elementType required: true in: query schema: type: string - name: schema required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/snowflake-element/{metadataId}/implementation: get: operationId: AiRetrieversController_getSnowflakeElementImplementation parameters: - name: metadataId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/snowflake-element/{metadataId}/relationships: get: operationId: AiRetrieversController_getSnowflakeElementRelationships parameters: - name: metadataId required: true in: path schema: type: string - name: direction required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/snowflake-elements/{elementType}: get: operationId: AiRetrieversController_listSnowflakeElements parameters: - name: elementType required: true in: path schema: type: string - name: schema required: true in: query schema: type: string - name: limit required: true in: query schema: type: number - name: offset required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/snowflake-element-summaries: post: operationId: AiRetrieversController_getSnowflakeElementSummaries parameters: [] responses: '201': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/snowflake-element-distribution: get: operationId: AiRetrieversController_getSnowflakeElementDistribution parameters: - name: nodeType required: true in: query schema: type: string - name: groupProperty required: true in: query schema: type: string - name: groupType required: true in: query schema: type: string - name: relationship required: true in: query schema: type: string - name: direction required: true in: query schema: type: string - name: limit required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/servicenow-table/{tableName}/fields: get: operationId: AiRetrieversController_getServiceNowTableFields parameters: - name: tableName required: true in: path schema: type: string - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/search-servicenow-elements: get: operationId: AiRetrieversController_searchServiceNowElements parameters: - name: searchTerm required: true in: query schema: type: string - name: elementTypes required: true in: query schema: type: array items: type: string - name: pageSize required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/servicenow-element-by-name/{name}: get: operationId: AiRetrieversController_getServiceNowElementByName parameters: - name: name required: true in: path schema: type: string - name: elementType required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/servicenow-element/{metadataId}/implementation: get: operationId: AiRetrieversController_getServiceNowElementImplementation parameters: - name: metadataId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/servicenow-element/{metadataId}/relationships: get: operationId: AiRetrieversController_getServiceNowElementRelationships parameters: - name: metadataId required: true in: path schema: type: string - name: direction required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/servicenow-elements/{elementType}: get: operationId: AiRetrieversController_listServiceNowElements parameters: - name: elementType required: true in: path schema: type: string - name: limit required: true in: query schema: type: number - name: offset required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/servicenow-element-summaries: post: operationId: AiRetrieversController_getServiceNowElementSummaries parameters: [] responses: '201': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/servicenow-element-distribution: get: operationId: AiRetrieversController_getServiceNowElementDistribution parameters: - name: nodeType required: true in: query schema: type: string - name: groupProperty required: true in: query schema: type: string - name: groupType required: true in: query schema: type: string - name: relationship required: true in: query schema: type: string - name: direction required: true in: query schema: type: string - name: limit required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/search-data360-elements: get: operationId: AiRetrieversController_searchData360Elements parameters: - name: searchTerm required: true in: query schema: type: string - name: elementTypes required: true in: query schema: type: array items: type: string - name: pageSize required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/data360-element-by-name/{name}: get: operationId: AiRetrieversController_getData360ElementByName parameters: - name: name required: true in: path schema: type: string - name: elementType required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/data360-element/{metadataId}/implementation: get: operationId: AiRetrieversController_getData360ElementImplementation parameters: - name: metadataId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/data360-element/{metadataId}/relationships: get: operationId: AiRetrieversController_getData360ElementRelationships parameters: - name: metadataId required: true in: path schema: type: string - name: direction required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/data360-element/{metadataId}/child-count: get: operationId: AiRetrieversController_getData360ElementChildCount parameters: - name: metadataId required: true in: path schema: type: string - name: elementType required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/data360-element-distribution: get: operationId: AiRetrieversController_getData360ElementDistribution parameters: - name: nodeType required: true in: query schema: type: string - name: groupProperty required: true in: query schema: type: string - name: groupType required: true in: query schema: type: string - name: relationship required: true in: query schema: type: string - name: direction required: true in: query schema: type: string - name: limit required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/data360-elements/{elementType}: get: operationId: AiRetrieversController_listData360Elements parameters: - name: elementType required: true in: path schema: type: string - name: limit required: true in: query schema: type: number - name: offset required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/data360-element-summaries: post: operationId: AiRetrieversController_getData360ElementSummaries parameters: [] responses: '201': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/search-workato-elements: get: operationId: AiRetrieversController_searchWorkatoElements parameters: - name: searchTerm required: true in: query schema: type: string - name: elementTypes required: true in: query schema: type: array items: type: string - name: pageSize required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-element-by-name/{name}: get: operationId: AiRetrieversController_getWorkatoElementByName parameters: - name: name required: true in: path schema: type: string - name: elementType required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-element/{metadataId}/implementation: get: operationId: AiRetrieversController_getWorkatoElementImplementation parameters: - name: metadataId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-element/{metadataId}/relationships: get: operationId: AiRetrieversController_getWorkatoElementRelationships parameters: - name: metadataId required: true in: path schema: type: string - name: direction required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-element/{metadataId}/child-count: get: operationId: AiRetrieversController_getWorkatoElementChildCount parameters: - name: metadataId required: true in: path schema: type: string - name: elementType required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-element-distribution: get: operationId: AiRetrieversController_getWorkatoElementDistribution parameters: - name: nodeType required: true in: query schema: type: string - name: groupProperty required: true in: query schema: type: string - name: groupType required: true in: query schema: type: string - name: relationship required: true in: query schema: type: string - name: direction required: true in: query schema: type: string - name: limit required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-elements/{elementType}: post: operationId: AiRetrieversController_listWorkatoElements parameters: - name: elementType required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/WorkatoListElementsDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-recipes-referencing-field: get: operationId: AiRetrieversController_listWorkatoRecipesReferencingField parameters: - name: fieldPrefix required: true in: query schema: type: string - name: limit required: true in: query schema: type: number - name: offset required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/workato-element-summaries: post: operationId: AiRetrieversController_getWorkatoElementSummaries parameters: [] responses: '201': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/retrieve-metadata-types: post: operationId: AiRetrieversController_retrieveMetadataTypes parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RetrieveMetadataTypesDto' responses: '201': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/agent-files: post: operationId: AiRetrieversController_createAgentFile parameters: [] responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AiAgentFile' security: - bearer: [] tags: - AI Retrievers put: operationId: AiRetrieversController_updateAgentFile parameters: [] responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiAgentFile' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/artifacts/latest: get: operationId: AiRetrieversController_getLatestArtifact parameters: - name: artifactId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-stream/{streamId}: post: operationId: AiStreamController_handleStreamCompletion parameters: - name: streamId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/StreamCompletionDto' responses: '201': description: '' tags: - ai-stream /documentation-salesforce/{crmOrgId}: get: operationId: DocumentationSalesforceController_getDocumentationData parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/objects: get: operationId: DocumentationSalesforceController_getObjectTypes parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/objects/{objectName}: post: operationId: DocumentationSalesforceController_createObjectDocumentation parameters: - name: crmOrgId required: true in: path schema: type: string - name: objectName required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentationObjectDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce patch: operationId: DocumentationSalesforceController_toggleObjectFavorite parameters: - name: crmOrgId required: true in: path schema: type: string - name: objectName required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DocumentationObjectDto' responses: '200': description: '' security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/metadataTypes: get: operationId: DocumentationSalesforceController_getMetadataTypes parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: string security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/metadataTypes/{metadataTypeName}: get: operationId: DocumentationSalesforceController_getMetadata parameters: - name: crmOrgId required: true in: path schema: type: string - name: metadataTypeName required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/layouts/{metadataId}: get: operationId: DocumentationSalesforceController_getLayoutProperties parameters: - name: crmOrgId required: true in: path schema: type: string - name: metadataId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/ai-chat: post: operationId: DocumentationSalesforceController_createAiDocumentationChat parameters: - name: crmOrgId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AiChatDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/generate-configuration-gpt: post: operationId: DocumentationSalesforceController_getConfigurationGpt parameters: - name: crmOrgId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CalcParsedConfigurationGptDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/configuration/dependencies: get: operationId: DocumentationSalesforceController_getConfigurationDependencies parameters: - name: crmOrgId required: true in: path schema: type: string - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/configuration/consumers: get: operationId: DocumentationSalesforceController_getConfigurationConsumers parameters: - name: crmOrgId required: true in: path schema: type: string - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/field-consumers: get: operationId: DocumentationSalesforceController_getFieldConsumers parameters: - name: crmOrgId required: true in: path schema: type: string - name: objectName required: true in: query schema: type: string - name: fieldName required: true in: query schema: type: string - name: activeOnly required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/search: get: operationId: DocumentationSalesforceController_getSearchResults parameters: - name: crmOrgId required: true in: path schema: type: string - name: searchText required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/search-content: get: operationId: DocumentationSalesforceController_getSearchContent parameters: - name: crmOrgId required: true in: path schema: type: string - name: searchText required: true in: query schema: type: string - name: metadataTypes required: true in: query schema: type: array items: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/{crmOrgId}/nacl-file: get: operationId: DocumentationSalesforceController_getNaclFile parameters: - name: crmOrgId required: true in: path schema: type: string - name: metadataId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: string security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/user-inputs/tags: get: operationId: DocumentationSalesforceController_getUserInputTags parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Salesforce post: operationId: DocumentationSalesforceController_createUserInputTag parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateTagDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/user-inputs/tags/{tagId}: patch: operationId: DocumentationSalesforceController_editUserInputTag parameters: - name: tagId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EditTagDto' responses: '200': description: '' security: - bearer: [] tags: - Documentation Salesforce delete: operationId: DocumentationSalesforceController_deleteUserInputTag parameters: - name: tagId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/user-inputs/users: get: operationId: DocumentationSalesforceController_getUserInputsUsersWithMetadataElements parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/user-inputs/users/{userId}: delete: operationId: DocumentationSalesforceController_deleteUserInputUserConfigurations parameters: - name: userId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/user-inputs/{metadataId}: put: operationId: DocumentationSalesforceController_updateUserInputConfiguration parameters: - name: metadataId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateConfigurationUserInputsDto' responses: '200': description: '' security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/user-inputs/{metadataId}/comments: get: operationId: DocumentationSalesforceController_getUserInputConfigurationComments parameters: - name: metadataId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/ConfigurationUserInputComment' security: - bearer: [] tags: - Documentation Salesforce post: operationId: DocumentationSalesforceController_createUserInputConfigurationComment parameters: - name: metadataId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertConfigurationCommentDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/ConfigurationUserInputComment' security: - bearer: [] tags: - Documentation Salesforce /documentation-salesforce/user-inputs/{metadataId}/comments/{commentId}: patch: operationId: DocumentationSalesforceController_editUserInputConfigurationComment parameters: - name: metadataId required: true in: path schema: type: string - name: commentId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpsertConfigurationCommentDto' responses: '200': description: '' security: - bearer: [] tags: - Documentation Salesforce delete: operationId: DocumentationSalesforceController_deleteUserInputConfigurationComment parameters: - name: metadataId required: true in: path schema: type: string - name: commentId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Documentation Salesforce /best-practices: get: operationId: BestPracticesController_getAllBestPractices parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/BestPracticeResponseDto' security: - bearer: [] tags: - best-practices post: operationId: BestPracticesController_createBestPractice parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateBestPracticeDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/BestPracticeResponseDto' security: - bearer: [] tags: - best-practices /best-practices/{id}: patch: operationId: BestPracticesController_updateBestPractice parameters: - name: id required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateBestPracticeDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/BestPracticeResponseDto' security: - bearer: [] tags: - best-practices delete: operationId: BestPracticesController_deleteBestPractice parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - best-practices /plans/allowed-features: get: operationId: PlanController_getAllowedFeatures parameters: [] responses: '200': description: '' security: - bearer: [] tags: - Product Plan /mcp/apikey: get: operationId: MCPController_getTemporaryApikey[0] parameters: [] responses: '200': description: '' security: - bearer: [] tags: - MCP /mcp-deprecated/apikey: get: operationId: MCPController_getTemporaryApikey[1] parameters: [] responses: '200': description: '' security: - bearer: [] tags: - MCP /teams-integrations/message: post: operationId: TeamsIntegrationUnauthenticatedController_handleMessage parameters: [] responses: '201': description: '' tags: - Teams Integrations (Unauthenticated) /ai-prompts/prompt-groups: get: operationId: AiPromptsController_getPromptGroups parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/PromptGroupResponseDto' security: - bearer: [] tags: - AI Prompts post: operationId: AiPromptsController_createPromptGroup parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePromptGroupDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/PromptGroupResponseDto' security: - bearer: [] tags: - AI Prompts /ai-prompts: get: operationId: AiPromptsController_getPrompts parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/PromptResponseDto' security: - bearer: [] tags: - AI Prompts post: operationId: AiPromptsController_createPrompt parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreatePromptDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/PromptResponseDto' security: - bearer: [] tags: - AI Prompts /ai-prompts/prompt-groups/{groupId}: patch: operationId: AiPromptsController_updatePromptGroup parameters: - name: groupId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePromptGroupDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PromptGroupResponseDto' security: - bearer: [] tags: - AI Prompts delete: operationId: AiPromptsController_deletePromptGroup parameters: - name: groupId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Prompts /ai-prompts/{promptId}: patch: operationId: AiPromptsController_updatePrompt parameters: - name: promptId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdatePromptDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/PromptResponseDto' security: - bearer: [] tags: - AI Prompts delete: operationId: AiPromptsController_deletePrompt parameters: - name: promptId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Prompts /ai-prompts/optimize: post: operationId: AiPromptsController_optimizePrompt parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OptimizePromptDto' responses: '201': description: '' content: application/json: schema: type: string security: - bearer: [] tags: - AI Prompts /ai-agents/{agentId}/user-skills: get: operationId: AiUserSkillsController_listSkills parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI User Skills post: operationId: AiUserSkillsController_createSkill parameters: - name: agentId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateUserSkillDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI User Skills /ai-agents/{agentId}/user-skills/{skillId}: get: operationId: AiUserSkillsController_getSkill parameters: - name: agentId required: true in: path schema: type: string - name: skillId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI User Skills patch: operationId: AiUserSkillsController_updateSkill parameters: - name: agentId required: true in: path schema: type: string - name: skillId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateUserSkillDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI User Skills delete: operationId: AiUserSkillsController_deleteSkill parameters: - name: agentId required: true in: path schema: type: string - name: skillId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI User Skills /ai-agents/{agentId}/user-skills/{skillId}/enabled: patch: operationId: AiUserSkillsController_setSkillEnabled parameters: - name: agentId required: true in: path schema: type: string - name: skillId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/SetUserSkillEnabledDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI User Skills /account-selection/accounts: get: operationId: AccountSelectionController_getUserAccounts parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] summary: 'Get all accounts associated with the authenticated user''s sub. This endpoint is used during account selection and does not require an account context to be established yet.' tags: - Account Selection post: operationId: AccountSelectionController_createAccount parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAccountDto' responses: '201': description: '' security: - bearer: [] summary: 'Create a new Auth0 organization for the authenticated user. This will create an Auth0 organization and associate the user as a member. Returns the Auth0 organization ID.' tags: - Account Selection /account-selection/accounts/{accountId}: delete: operationId: AccountSelectionController_deactivateAccount parameters: - name: accountId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] summary: 'Deactivate an account (soft delete). Only allows deactivation if the account has exactly one user. Throws BadRequestException if the account has multiple users.' tags: - Account Selection /agentic-features: get: operationId: AgenticFeaturesController_getAgenticFeatureSettings parameters: [] responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Agentic Features patch: operationId: AgenticFeaturesController_overrideAgenticFeatureSettings parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateAgenticFeaturesSettingsDto' responses: '200': description: '' security: - bearer: [] tags: - Agentic Features /agentic-features/data-access-settings: get: operationId: AgenticFeaturesController_getDataAccessSettings parameters: [] responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Agentic Features patch: operationId: AgenticFeaturesController_updateDataAccessSettings parameters: [] responses: '200': description: '' security: - bearer: [] tags: - Agentic Features /public/artifacts/{id}: get: operationId: AiArtifactsUnauthenticatedController_getPublicArtifact parameters: - name: id required: true in: path schema: type: string - name: token required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - AI Artifacts (unauthenticated) /graph-db/sync/{orgId}: post: operationId: GraphDbController_syncOrg parameters: - name: orgId required: true in: path schema: type: string responses: '201': description: '' security: - bearer: [] tags: - graph-db /simulation/run: post: operationId: SimulationController_runSimulation parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RunSimulationDto' responses: '202': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Simulation /simulation/result: get: operationId: SimulationController_getSimulationResult parameters: - name: crmOrgId required: true in: query schema: type: string - name: tracedUserId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Simulation /data360-orgs/new: post: operationId: Data360OrgController_createOrg parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateData360OrgDto' responses: '201': description: Data 360 org created content: application/json: schema: $ref: '#/components/schemas/Data360OrgResponseDto' security: - bearer: [] summary: Create a new Data 360 org tags: - Data 360 Orgs /data360-orgs/org/{orgId}/salesforce-oauth: get: operationId: Data360OrgController_getOAuthUrl parameters: - name: orgId required: true in: path description: Data 360 Org ID schema: type: string - name: isSandbox required: false in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] summary: Get Salesforce OAuth URL with Data 360 scopes tags: - Data 360 Orgs /data360-orgs/salesforce-oauth2-code: post: operationId: Data360OrgController_handleOAuthCode parameters: - name: skipDuplicateCheck required: false in: query description: Skip duplicate instance URL check (for reconnection) schema: type: boolean requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/Data360OAuthDto' responses: '201': description: '' security: - bearer: [] summary: Exchange OAuth code for tokens tags: - Data 360 Orgs /data360-orgs/{orgId}/complete-connection: post: operationId: Data360OrgController_completeConnection parameters: - name: orgId required: true in: path description: Data 360 Org ID schema: type: string responses: '201': description: '' security: - bearer: [] summary: Complete connection (skip duplicate check) tags: - Data 360 Orgs /mcp-connectors: get: operationId: McpConnectorsController_getConnectors parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - MCP Connectors post: operationId: McpConnectorsController_createConnector parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/RegisterServerDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - MCP Connectors /mcp-connectors/{serverId}/oauth/url: get: operationId: McpConnectorsController_getOAuthAuthorizationUrl parameters: - name: serverId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - MCP Connectors /mcp-connectors/{serverId}/oauth/callback: post: operationId: McpConnectorsController_handleOAuthCallback parameters: - name: serverId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/OAuthCallbackDto' responses: '201': description: '' security: - bearer: [] tags: - MCP Connectors /mcp-connectors/{serverId}: delete: operationId: McpConnectorsController_deleteConnector parameters: - name: serverId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - MCP Connectors /mcp-connectors/connections/{connectionId}/tool-policies: get: operationId: McpConnectorsController_getConnectionTools parameters: - name: connectionId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - MCP Connectors /mcp-connectors/connections/{connectionId}: put: operationId: McpConnectorsController_updateConnectionToolPolicies parameters: - name: connectionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateToolPoliciesDto' responses: '200': description: '' security: - bearer: [] tags: - MCP Connectors delete: operationId: McpConnectorsController_deleteConnection parameters: - name: connectionId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - MCP Connectors /scheduling/webhook/{formId}: post: operationId: SchedulingPublicUnauthenticatedController_webhook parameters: - name: formId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LeadSubmissionDto' responses: '201': description: '' content: application/json: schema: type: object tags: - scheduling (public) /scheduling/booking/{token}: get: operationId: SchedulingPublicUnauthenticatedController_getBookingDetails parameters: - name: token required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - scheduling (public) /scheduling/availability/{token}: get: operationId: SchedulingPublicUnauthenticatedController_getAvailability parameters: - name: token required: true in: path schema: type: string - name: startDate required: true in: query schema: type: string - name: days required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object tags: - scheduling (public) /scheduling/book/{token}: post: operationId: SchedulingPublicUnauthenticatedController_book parameters: - name: token required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BookSlotDto' responses: '201': description: '' content: application/json: schema: type: object tags: - scheduling (public) /scheduling/reschedule/{token}: post: operationId: SchedulingPublicUnauthenticatedController_reschedule parameters: - name: token required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/BookSlotDto' responses: '201': description: '' content: application/json: schema: type: object tags: - scheduling (public) /scheduling/book-link/{linkId}: get: operationId: SchedulingPublicUnauthenticatedController_resolveBookingLink parameters: - name: linkId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object tags: - scheduling (public) post: operationId: SchedulingPublicUnauthenticatedController_submitBookingLink parameters: - name: linkId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/LeadSubmissionDto' responses: '201': description: '' content: application/json: schema: type: object tags: - scheduling (public) /scheduling/google/callback: get: operationId: SchedulingPublicUnauthenticatedController_googleCallback parameters: - name: code required: true in: query schema: type: string - name: state required: true in: query schema: type: string responses: '200': description: '' tags: - scheduling (public) /scheduling/zoom/callback: get: operationId: SchedulingPublicUnauthenticatedController_zoomCallback parameters: - name: code required: true in: query schema: type: string - name: state required: true in: query schema: type: string responses: '200': description: '' tags: - scheduling (public) /scheduling-dashboard/team-calendars: get: operationId: SchedulingDashboardController_getTeamCalendars parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/team-calendars/{userId}/working-hours: put: operationId: SchedulingDashboardController_updateWorkingHours parameters: - name: crmOrgId required: true in: query schema: type: string - name: userId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/team-calendars/invite: post: operationId: SchedulingDashboardController_sendInvite parameters: - name: crmOrgId required: true in: query schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/meeting-types: get: operationId: SchedulingDashboardController_listMeetingTypes parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Scheduling Dashboard post: operationId: SchedulingDashboardController_createMeetingType parameters: - name: crmOrgId required: true in: query schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/meeting-types/{meetingTypeId}: patch: operationId: SchedulingDashboardController_updateMeetingType parameters: - name: crmOrgId required: true in: query schema: type: string - name: meetingTypeId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard delete: operationId: SchedulingDashboardController_deleteMeetingType parameters: - name: crmOrgId required: true in: query schema: type: string - name: meetingTypeId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/forms: get: operationId: SchedulingDashboardController_listForms parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Scheduling Dashboard post: operationId: SchedulingDashboardController_createForm parameters: - name: crmOrgId required: true in: query schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/forms/{formId}: put: operationId: SchedulingDashboardController_updateForm parameters: - name: crmOrgId required: true in: query schema: type: string - name: formId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard delete: operationId: SchedulingDashboardController_deleteForm parameters: - name: crmOrgId required: true in: query schema: type: string - name: formId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/booking-links: get: operationId: SchedulingDashboardController_listBookingLinks parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Scheduling Dashboard post: operationId: SchedulingDashboardController_createBookingLink parameters: - name: crmOrgId required: true in: query schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/booking-links/{linkId}: put: operationId: SchedulingDashboardController_updateBookingLink parameters: - name: crmOrgId required: true in: query schema: type: string - name: linkId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard delete: operationId: SchedulingDashboardController_deleteBookingLink parameters: - name: crmOrgId required: true in: query schema: type: string - name: linkId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/routing-rules/{routingRuleId}/usage: get: operationId: SchedulingDashboardController_getRoutingRuleUsage parameters: - name: crmOrgId required: true in: query schema: type: string - name: routingRuleId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/routing-rules/{routingRuleId}/deactivate-dependents: post: operationId: SchedulingDashboardController_deactivateRoutingRuleDependents parameters: - name: crmOrgId required: true in: query schema: type: string - name: routingRuleId required: true in: path schema: type: string responses: '201': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/connected-users: get: operationId: SchedulingDashboardController_getConnectedUsers parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/settings/data-fields: get: operationId: SchedulingDashboardController_getDataFields parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - Scheduling Dashboard post: operationId: SchedulingDashboardController_addDataField parameters: - name: crmOrgId required: true in: query schema: type: string responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/settings/data-fields/{fieldId}: patch: operationId: SchedulingDashboardController_updateDataField parameters: - name: crmOrgId required: true in: query schema: type: string - name: fieldId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard delete: operationId: SchedulingDashboardController_deleteDataField parameters: - name: crmOrgId required: true in: query schema: type: string - name: fieldId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/settings/default-hours: get: operationId: SchedulingDashboardController_getDefaultHours parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard put: operationId: SchedulingDashboardController_updateDefaultHours parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/settings/branding: get: operationId: SchedulingDashboardController_getBranding parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard put: operationId: SchedulingDashboardController_updateBranding parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/settings/integrations: get: operationId: SchedulingDashboardController_getIntegrationSettings parameters: - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard put: operationId: SchedulingDashboardController_updateIntegrationSettings parameters: - name: crmOrgId required: true in: query schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateIntegrationSettingsDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - Scheduling Dashboard /scheduling-dashboard/logs/{sourceType}/{sourceId}: get: operationId: SchedulingDashboardController_getLogs parameters: - name: crmOrgId required: true in: query schema: type: string - name: sourceType required: true in: path schema: type: string - name: sourceId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: $ref: '#/components/schemas/SchedulingSubmissionLog' security: - bearer: [] tags: - Scheduling Dashboard /projects: post: operationId: AiProjectsController_createProject parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProjectDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AiProject' security: - bearer: [] tags: - projects get: operationId: AiProjectsController_listProjects parameters: - name: limit required: true in: query schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - projects /projects/agent-ids: get: operationId: AiProjectsController_listProjectAgentIds parameters: [] responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - projects /projects/by-agent/{agentId}: get: operationId: AiProjectsController_getProjectByAgent parameters: - name: agentId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiProject' security: - bearer: [] tags: - projects /projects/{projectId}/duplicate: post: operationId: AiProjectsController_duplicateProject parameters: - name: projectId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/DuplicateProjectDto' responses: '201': description: '' security: - bearer: [] tags: - projects /projects/{projectId}: get: operationId: AiProjectsController_getProject parameters: - name: projectId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiProject' security: - bearer: [] tags: - projects patch: operationId: AiProjectsController_updateProject parameters: - name: projectId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateProjectDto' responses: '200': description: '' content: application/json: schema: $ref: '#/components/schemas/AiProject' security: - bearer: [] tags: - projects delete: operationId: AiProjectsController_deleteProject parameters: - name: projectId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/prompts/reset: patch: operationId: AiProjectsController_resetAllPrompts parameters: - name: projectId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/sections/{sectionId}/prompts/reset: patch: operationId: AiProjectsController_resetSectionPrompts parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/prompts/{promptId}/complete: patch: operationId: AiProjectsController_completePrompt parameters: - name: projectId required: true in: path schema: type: string - name: promptId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/prompts/{promptId}/chats: get: operationId: AiProjectsController_getPromptHistory parameters: - name: projectId required: true in: path schema: type: string - name: promptId required: true in: path schema: type: string responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - projects /projects/{projectId}/sections/reorder: patch: operationId: AiProjectsController_reorderSections parameters: - name: projectId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReorderSectionsDto' responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/sections: post: operationId: AiProjectsController_addSection parameters: - name: projectId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddSectionDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AiProjectSection' security: - bearer: [] tags: - projects /projects/{projectId}/sections/{sectionId}: patch: operationId: AiProjectsController_updateSection parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSectionDto' responses: '200': description: '' security: - bearer: [] tags: - projects delete: operationId: AiProjectsController_deleteSection parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/sections/{sectionId}/items: post: operationId: AiProjectsController_addSectionItem parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddSectionItemDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AiProjectSectionItem' security: - bearer: [] tags: - projects /projects/{projectId}/items/{itemId}/move: patch: operationId: AiProjectsController_moveItem parameters: - name: projectId required: true in: path schema: type: string - name: itemId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/MoveItemDto' responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/items/{itemId}: patch: operationId: AiProjectsController_updateSectionItem parameters: - name: projectId required: true in: path schema: type: string - name: itemId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateSectionItemDto' responses: '200': description: '' security: - bearer: [] tags: - projects delete: operationId: AiProjectsController_deleteSectionItem parameters: - name: projectId required: true in: path schema: type: string - name: itemId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/sections/{sectionId}/items/reorder: patch: operationId: AiProjectsController_reorderItems parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReorderItemsDto' responses: '200': description: '' security: - bearer: [] tags: - projects /projects/{projectId}/memory: post: operationId: AiProjectsController_addToMemory parameters: - name: projectId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/AddToMemoryDto' responses: '201': description: '' content: application/json: schema: $ref: '#/components/schemas/AiProjectSectionItem' security: - bearer: [] tags: - projects /ai-retrievers/projects/{projectId}: get: operationId: ProjectToolsController_getProject parameters: - name: projectId required: true in: path schema: type: string - name: includePromptBodies required: true in: query schema: type: boolean responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers patch: operationId: ProjectToolsController_updateProject parameters: - name: projectId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateProjectToolsDto' responses: '200': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/projects/{projectId}/prompts/search: get: operationId: ProjectToolsController_searchPrompts parameters: - name: projectId required: true in: path schema: type: string - name: query required: true in: query schema: type: string - name: limit required: true in: query schema: type: number responses: '200': description: '' content: application/json: schema: type: array items: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/projects/{projectId}/sections: post: operationId: ProjectToolsController_createSection parameters: - name: projectId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProjectToolsSectionDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/projects/{projectId}/sections/{sectionId}: patch: operationId: ProjectToolsController_updateSection parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateProjectToolsSectionDto' responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers delete: operationId: ProjectToolsController_deleteSection parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts: post: operationId: ProjectToolsController_createPrompt parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateProjectToolsPromptDto' responses: '201': description: '' content: application/json: schema: type: object security: - bearer: [] tags: - AI Retrievers /ai-retrievers/projects/{projectId}/prompts/{promptId}: patch: operationId: ProjectToolsController_updatePrompt parameters: - name: projectId required: true in: path schema: type: string - name: promptId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateProjectToolsPromptDto' responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers delete: operationId: ProjectToolsController_deletePrompt parameters: - name: projectId required: true in: path schema: type: string - name: promptId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /ai-retrievers/projects/{projectId}/sections/{sectionId}/prompts/reorder: patch: operationId: ProjectToolsController_reorderPrompts parameters: - name: projectId required: true in: path schema: type: string - name: sectionId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/ReorderProjectToolsPromptsDto' responses: '200': description: '' security: - bearer: [] tags: - AI Retrievers /funnel-maps: get: operationId: FunnelMapsController_getAllFunnelMaps parameters: - name: includeFunnelsData required: true in: query schema: type: boolean - name: includeFunnelId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Funnel Maps post: operationId: FunnelMapsController_createFunnelMap parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateFunnelMapDto' responses: '201': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/{id}: get: operationId: FunnelMapsController_getOneFunnelMap parameters: - name: id required: true in: path schema: type: string - name: includeFunnelsData required: true in: query schema: type: boolean responses: '200': description: '' security: - bearer: [] tags: - Funnel Maps delete: operationId: FunnelMapsController_deleteOneFunnelMap parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/{id}/fields: get: operationId: FunnelMapsController_getFunnelMapFields parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/{funnelMapId}: put: operationId: FunnelMapsController_updateFunnelMap parameters: - name: funnelMapId required: true in: path schema: type: string requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/UpdateFunnelMapDto' responses: '200': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/{id}/isPinned: patch: operationId: FunnelMapsController_updateFunnelMapIsPinned parameters: - name: id required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/ai-process-mining: post: operationId: FunnelMapsController_createAiProcessMiningFunnels parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CreateAiProcessMiningFunnelsDto' responses: '201': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/links: post: operationId: FunnelMapsController_enrichMetadataElements parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/EnrichMetadataElementsRequestDto' responses: '201': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/metadata/{metadataId}: get: operationId: FunnelMapsController_getMetadataElementCard parameters: - name: metadataId required: true in: path schema: type: string - name: crmOrgId required: true in: query schema: type: string responses: '200': description: '' security: - bearer: [] tags: - Funnel Maps /funnel-maps/pills: post: operationId: FunnelMapsController_calculatePills parameters: [] requestBody: required: true content: application/json: schema: $ref: '#/components/schemas/CalculatePillsDto' responses: '201': description: '' security: - bearer: [] tags: - Funnel Maps /user-sfdc-connection/{crmOrgId}/status: get: operationId: UserSfdcConnectionController_getConnectionStatus parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - User SFDC Connection /user-sfdc-connection/{crmOrgId}/oauth/url: get: operationId: UserSfdcConnectionController_getOAuthUrl parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - User SFDC Connection /user-sfdc-connection/{crmOrgId}/oauth/callback: post: operationId: UserSfdcConnectionController_handleOAuthCallback parameters: - name: crmOrgId required: true in: path schema: type: string responses: '201': description: '' security: - bearer: [] tags: - User SFDC Connection /user-sfdc-connection/{crmOrgId}: delete: operationId: UserSfdcConnectionController_disconnect parameters: - name: crmOrgId required: true in: path schema: type: string responses: '200': description: '' security: - bearer: [] tags: - User SFDC Connection tags: [] components: securitySchemes: bearer: scheme: bearer bearerFormat: JWT type: http schemas: CreateSnowflakeOrgDto: type: object properties: snowflakeAccountIdentifier: type: string pattern: /^[a-zA-Z0-9_\-]+$/i description: Snowflake account identifier (e.g., ORGNAME-ACCOUNTNAME or account locator) example: MYORG-MYACCOUNT username: type: string description: Snowflake username for authentication example: my_user privateKey: type: string description: RSA private key in PEM format for key pair authentication example: 'REDACTED_PRIVATE_KEY_EXAMPLE' name: type: string maxLength: 255 description: Display name for the Snowflake org example: Production Snowflake database: type: string maxLength: 255 description: Database name to use for this Snowflake org example: ANALYTICS_DB required: - snowflakeAccountIdentifier - username - privateKey - name - database SnowflakeCredentialsDto: type: object properties: snowflakeAccountIdentifier: type: string pattern: /^[a-zA-Z0-9_\-]+$/i description: Snowflake account identifier (e.g., ORGNAME-ACCOUNTNAME or account locator) example: MYORG-MYACCOUNT username: type: string description: Snowflake username for authentication example: my_user privateKey: type: string description: RSA private key in PEM format for key pair authentication example: 'REDACTED_PRIVATE_KEY_EXAMPLE' required: - snowflakeAccountIdentifier - username - privateKey GetDatabasesDto: type: object properties: credentials: description: Snowflake credentials for temporary connection allOf: - $ref: '#/components/schemas/SnowflakeCredentialsDto' required: - credentials CreateServiceNowOrgDto: type: object properties: instanceUrl: type: string format: uri description: ServiceNow instance URL example: https://mycompany.service-now.com clientId: type: string description: OAuth Client ID for ServiceNow integration example: abc123def456 clientSecret: type: string description: OAuth Client Secret for ServiceNow integration example: secret_value_here name: type: string maxLength: 255 description: Display name for the ServiceNow org example: Production ServiceNow environmentType: enum: - Development - Test - Production type: string example: Production description: ServiceNow instance environment scope required: - instanceUrl - clientId - clientSecret - name - environmentType ServiceNowCredentialsDto: type: object properties: instanceUrl: type: string format: uri description: ServiceNow instance URL example: https://mycompany.service-now.com clientId: type: string description: OAuth Client ID for ServiceNow integration example: abc123def456 clientSecret: type: string description: OAuth Client Secret for ServiceNow integration example: secret_value_here required: - instanceUrl - clientId - clientSecret WorkatoCredentialsDto: type: object properties: baseUrl: type: string format: uri description: Workato Developer API base URL (`https://{workspace}/api` only; not the bare workspace origin) example: https://www.workato.com/api apiToken: type: string description: 'Workato API client secret only (no "Bearer" prefix; the server sends Authorization: Bearer on each request)' required: - baseUrl - apiToken CreateWorkatoOrgDto: type: object properties: name: type: string maxLength: 255 example: Production Workato credentials: $ref: '#/components/schemas/WorkatoCredentialsDto' environmentType: enum: - Development - Test - Production type: string example: Development description: Workato environment the API client token is scoped to (assigned in Workspace admin → API clients) required: - name - credentials - environmentType DocumentationChatRequestDto: type: object properties: message: type: string description: User message to the documentation agent sessionId: type: string description: Chat session identifier isFirstMessage: type: boolean description: Whether this is the first message in the session required: - message - sessionId - isFirstMessage CustomEcaDto: type: object properties: clientId: type: string clientSecret: type: string required: - clientId - clientSecret CrmOrgCreateDto: type: object properties: name: type: string platform: type: string enum: - salesforce isSandbox: type: boolean isMain: type: boolean customEca: $ref: '#/components/schemas/CustomEcaDto' required: - name - platform - isSandbox CrmOrgUpdateDto: type: object properties: name: type: string required: - name CrmOrgOAuthDto: type: object properties: crmOrgId: type: string authCode: type: string isSandbox: type: boolean isOnboardingFastFetch: type: boolean required: - crmOrgId - authCode - isSandbox CrmOrgUserTimeOff: type: object properties: id: type: string type: enum: - TIME_OFF - SNOOZE type: string description: type: string startDate: format: date-time type: string endDate: format: date-time type: string timezone: type: string required: - id - type - description - startDate - endDate - timezone FunnelsAndRecordTypesDto: type: object properties: orgId: type: string activeOnly: type: boolean objectsData: type: array items: type: object required: - orgId - activeOnly - objectsData CreditQueueCreateRecordDto: type: object properties: userId: type: string creditsTargetAmount: type: number required: - userId - creditsTargetAmount CreditQueueCreateConfigDto: type: object properties: groupApiName: type: string creditsList: type: array items: $ref: '#/components/schemas/CreditQueueCreateRecordDto' required: - groupApiName - creditsList CreditQueueUpdateRecordDto: type: object properties: sfId: type: string index: type: number required: - sfId - index CreditQueueUpdateConfigDto: type: object properties: recordsToUpdate: type: array items: $ref: '#/components/schemas/CreditQueueUpdateRecordDto' recordsToDelete: type: array items: type: string EmojiDto: type: object properties: content: type: string bgColor: type: string AssignmentGroupAvatarDto: type: object properties: emoji: $ref: '#/components/schemas/EmojiDto' imageUrl: type: string imageUploadBase64: type: string AssignmentGroupMemberSetterDto: type: object properties: userId: type: string membershipActive: type: boolean weight: type: number limitValue: type: number creditCount: type: number minimum: 0 required: - userId - membershipActive - weight AssignmentGroupSetterDto: type: object properties: name: type: string description: type: string avatar: $ref: '#/components/schemas/AssignmentGroupAvatarDto' members: type: array items: $ref: '#/components/schemas/AssignmentGroupMemberSetterDto' groupLimit: type: object required: - name - description - avatar - members LeadingObjectDto: type: object properties: objectName: type: string fieldName: type: string _leadingFieldLabels: type: array items: type: string _leadingFieldId: type: string required: - objectName - fieldName - _leadingFieldId SweepExitCriteria: type: object properties: _exitCriteriaId: type: string _nextStageId: type: string isAutoMoveToNextStage: type: boolean guidance: type: string criteria: type: array items: type: object criteriaLogic: type: string required: - _exitCriteriaId - criteria - criteriaLogic SweepAssignmentRule: type: object properties: assignmentId: type: string ruleName: type: string assignedTo: type: string assignedToType: type: string criteriaLogic: type: string criteria: type: array items: type: object required: - assignmentId - ruleName - assignedTo - assignedToType - criteriaLogic - criteria FunnelLinkDto: type: object properties: _id: type: string _type: type: string enum: - salesforce - thirdParty - recordType - hubspot - metadataElement funnelId: type: string stageId: type: string required: - _id - _type - funnelId SweepFieldReference: type: object properties: fieldIds: type: array items: type: string fieldSource: type: string required: - fieldIds SweepStage: type: object properties: stageName: type: string _stageId: type: string stageDescription: type: string _branchIndex: type: number _stageColumnIndex: type: number exitCriteria: type: array items: $ref: '#/components/schemas/SweepExitCriteria' assignmentRules: type: array items: $ref: '#/components/schemas/SweepAssignmentRule' _team: type: string stageType: type: string enum: - regular - lost - nurturing preventBackwardStages: type: boolean funnelLinks: type: array items: $ref: '#/components/schemas/FunnelLinkDto' additionalFields: default: [] type: array items: $ref: '#/components/schemas/SweepFieldReference' required: - stageName - _stageId - stageDescription - exitCriteria - assignmentRules FunnelPluginsDto: type: object properties: {} FunnelDetailsDto: type: object properties: leadingObject: $ref: '#/components/schemas/LeadingObjectDto' stages: type: array items: $ref: '#/components/schemas/SweepStage' _firstStageId: type: string plugins: default: {} allOf: - $ref: '#/components/schemas/FunnelPluginsDto' funnelLinks: type: array items: $ref: '#/components/schemas/FunnelLinkDto' stageMetadata: type: array items: type: object required: - leadingObject - stages - plugins CreateFunnelDto: type: object properties: funnelName: type: string templateDetails: $ref: '#/components/schemas/FunnelDetailsDto' required: - funnelName - templateDetails BIFlagDto: type: object properties: name: type: string enum: - TIMESTAMP - OWNER - OWNER_ROLE value: type: boolean required: - name - value BISettingsDto: type: object properties: flags: type: array items: $ref: '#/components/schemas/BIFlagDto' required: - flags FunnelRecordTypeDto: type: object properties: name: type: string objectName: type: string label: type: string description: type: string required: - name - objectName - label - description FunnelDto: type: object properties: id: type: string apiName: type: string accountId: type: string crmOrgId: type: string name: type: string funnelDetails: $ref: '#/components/schemas/FunnelDetailsDto' restoredFromSnapshot: type: number createdById: type: string updatedById: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string biSettings: $ref: '#/components/schemas/BISettingsDto' pendingChanges: type: boolean isDeployed: type: boolean recordType: deprecated: true allOf: - $ref: '#/components/schemas/FunnelRecordTypeDto' description: type: string sweepFields: type: object fieldUsage: type: object required: - id - apiName - accountId - crmOrgId - name - funnelDetails - restoredFromSnapshot - createdById - updatedById - createdAt - updatedAt - biSettings - pendingChanges - isDeployed - recordType - description - fieldUsage LeadingFieldDto: type: object properties: name: type: string label: type: string values: type: array items: type: object required: - name - label - values ConvertRecordTypeToFunnelDto: type: object properties: funnelName: type: string recordTypeName: type: string recordTypeDescription: type: string objectName: type: string leadingField: $ref: '#/components/schemas/LeadingFieldDto' defaultCrmOrgId: type: string required: - funnelName - recordTypeName - objectName - leadingField - defaultCrmOrgId FunnelSnapshotDto: type: object properties: apiName: type: string id: type: string name: type: string createdAt: format: date-time type: string createdById: type: string ord: type: number funnelDetails: $ref: '#/components/schemas/FunnelDetailsDto' deployments: type: array items: $ref: '#/components/schemas/FunnelDeploymentDto' required: - apiName - id - name - createdAt - createdById - ord - funnelDetails - deployments FunnelDeploymentDto: type: object properties: id: type: string crmOrgId: type: string crmOrgName: type: string crmOrgIsSandbox: type: boolean snapshotName: type: string deployedById: type: string deployedAt: format: date-time type: string snapshot: $ref: '#/components/schemas/FunnelSnapshotDto' apiName: type: string name: type: string moreAdvancedDraft: type: boolean moreAdvancedSnapshots: type: number status: type: object required: - id - crmOrgId - crmOrgName - crmOrgIsSandbox - snapshotName - deployedById - deployedAt - snapshot - apiName - name - moreAdvancedDraft - moreAdvancedSnapshots - status UpdateFunnelSnapshotDto: type: object properties: name: type: string required: - name UpdateFunnelDto: type: object properties: name: type: string description: type: string funnelDetails: $ref: '#/components/schemas/FunnelDetailsDto' required: - name - description - funnelDetails RestoreFunnelDto: type: object properties: sourceSnapshotId: type: string preserveCurrent: type: boolean required: - sourceSnapshotId - preserveCurrent RecordTypeDto: type: object properties: name: type: string objectName: type: string label: type: string description: type: string required: - name - objectName - label - description FunnelRecordTypesDto: type: object properties: recordTypes: type: array items: $ref: '#/components/schemas/RecordTypeDto' required: - recordTypes DeploymentRequestDto: type: object properties: snapshotId: type: string funnelId: type: string required: - snapshotId - funnelId CreateTemplateDto: type: object properties: description: type: string imageUrl: type: string format: uri required: - description - imageUrl FieldMappingDto: type: object properties: fromTemplateFieldId: type: string toSweepFieldId: type: string required: - fromTemplateFieldId - toSweepFieldId ConvertTemplateDto: type: object properties: fieldMapping: type: array items: $ref: '#/components/schemas/FieldMappingDto' required: - fieldMapping RoleGroupAccountRole: type: object properties: role: type: object roleGroupId: type: string roleGroup: $ref: '#/components/schemas/RoleGroup' required: - role - roleGroupId - roleGroup Org: type: object properties: id: type: string accountId: type: string account: $ref: '#/components/schemas/Account' required: - id - accountId - account User: type: object properties: id: type: string sub: type: string email: type: string account: $ref: '#/components/schemas/Account' preferences: type: object name: type: string emoji: type: string imageUrl: type: string jobTitle: type: string roleGroup: $ref: '#/components/schemas/RoleGroup' roleGroupId: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string deletedAt: format: date-time type: string lastSeen: format: date-time type: string required: - id - sub - email - account - preferences - name - emoji - imageUrl - jobTitle - roleGroup - roleGroupId - createdAt - updatedAt FunnelSnapshot: type: object properties: id: type: string ord: type: number createdById: type: string createdBy: $ref: '#/components/schemas/User' apiName: type: string accountId: type: string account: $ref: '#/components/schemas/Account' name: type: string funnelName: type: string description: type: string recordTypeName: type: string restoredFromSnapshot: type: number funnelDetails: $ref: '#/components/schemas/FunnelDetailsDto' deployments: type: array items: $ref: '#/components/schemas/FunnelDeployment' createdAt: format: date-time type: string required: - id - ord - createdById - createdBy - apiName - accountId - account - name - funnelName - description - recordTypeName - restoredFromSnapshot - funnelDetails - deployments - createdAt FunnelDeployment: type: object properties: id: type: string crmOrgId: type: string crmOrg: $ref: '#/components/schemas/CrmOrg' snapshotId: type: string snapshot: $ref: '#/components/schemas/FunnelSnapshot' deployedById: type: string deployedBy: $ref: '#/components/schemas/User' deployedAt: format: date-time type: string status: type: object required: - id - crmOrgId - crmOrg - snapshotId - snapshot - deployedById - deployedBy - deployedAt - status CrmOrg: type: object properties: id: type: string org: $ref: '#/components/schemas/Org' name: type: string platform: type: string instanceUrl: type: string isSandbox: type: boolean isMain: type: boolean isDemo: type: boolean isConnected: type: object default: false createdById: type: string createdBy: $ref: '#/components/schemas/User' fetchStatus: enum: - fetching - initial_fetching - error - fetched - invalid_credentials type: string lastSuccessfulFetchTs: type: number disconnectedAt: format: date-time type: string nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string accountId: type: string connectedUser: type: string account: $ref: '#/components/schemas/Account' deployments: type: array items: $ref: '#/components/schemas/FunnelDeployment' optMonitoring: type: boolean graphVersion: type: string nullable: true graphDbReleaseChannel: nullable: true enum: - stable - beta - shadow type: string tier: enum: - T0 - T1 type: string required: - id - org - name - platform - instanceUrl - isSandbox - isMain - isDemo - isConnected - createdById - createdBy - fetchStatus - lastSuccessfulFetchTs - disconnectedAt - createdAt - updatedAt - accountId - connectedUser - account - deployments - optMonitoring - graphVersion - graphDbReleaseChannel - tier RoleGroupOrgRole: type: object properties: role: type: object crmOrgId: type: string crmOrg: $ref: '#/components/schemas/CrmOrg' roleGroupId: type: string roleGroup: $ref: '#/components/schemas/RoleGroup' required: - role - crmOrgId - crmOrg - roleGroupId - roleGroup RoleGroup: type: object properties: id: type: string accountId: type: string account: $ref: '#/components/schemas/Account' type: type: string enum: - SYSTEM - USER_CREATED accountRoles: type: array items: $ref: '#/components/schemas/RoleGroupAccountRole' orgRoles: type: array items: $ref: '#/components/schemas/RoleGroupOrgRole' createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedById: type: string updatedBy: $ref: '#/components/schemas/User' updatedAt: format: date-time type: string name: type: string description: type: string required: - id - accountId - account - type - accountRoles - orgRoles - createdById - createdBy - createdAt - updatedById - updatedBy - updatedAt - name Account: type: object properties: id: type: string name: type: string authZeroOrgId: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string deletedAt: format: date-time type: string onboardingStep: type: string enum: - ConnectOrg - Completed trialStartDate: format: date-time type: string trialEndDate: format: date-time type: string type: type: string enum: - Customer - POC - Inactive - SI - Free - Internal roleGroups: type: array items: $ref: '#/components/schemas/RoleGroup' users: type: array items: $ref: '#/components/schemas/User' disableAi: type: boolean isBuildModeEnabled: type: boolean lastSeen: format: date-time type: string allowedIpRanges: nullable: true type: array items: type: string required: - id - name - authZeroOrgId - createdAt - updatedAt - deletedAt - onboardingStep - trialStartDate - trialEndDate - type - roleGroups - users - disableAi - isBuildModeEnabled - lastSeen - allowedIpRanges Reporting: type: object properties: id: type: string accountId: type: string account: $ref: '#/components/schemas/Account' name: type: string type: enum: - AePerformance - Forecasting - FunnelConversion - LeadOverview - Velocity type: string status: type: object url: type: string createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedById: type: string updatedBy: $ref: '#/components/schemas/User' updatedAt: format: date-time type: string required: - id - accountId - account - name - type - status - url - createdById - createdBy - createdAt - updatedById - updatedBy - updatedAt UserEmojiDto: type: object properties: content: type: string bgColor: type: string required: - content - bgColor GetStartedDto: type: object properties: {} QuestionnaireDataDto: type: object properties: role: type: string enum: - ADMIN - BUSINESS_SYSTEMS - OPERATIONS - SALES - MARKETING - CUSTOMER_SUCCESS - CONSULTANT - OTHER interests: type: array items: type: string enum: - DOCUMENTATION - AUTOMATIONS - ALERTS - ROLLUPS - ROUTING - DEDUPE - VISUALIZE - PLAN - TRACK_CHANGES - OTHER QuestionnaireDto: type: object properties: status: type: string enum: - COMPLETED - NOT_COMPLETED data: $ref: '#/components/schemas/QuestionnaireDataDto' required: - status UserPreferencesDto: type: object properties: getStarted: $ref: '#/components/schemas/GetStartedDto' defaultCreationCrmOrgId: type: string nullable: true questionnaire: $ref: '#/components/schemas/QuestionnaireDto' tableColumnSettings: type: array items: type: object UserDto: type: object properties: id: type: string canResetPassword: type: boolean name: type: string imageUrl: type: string jobTitle: type: string email: type: string account: type: object properties: id: type: string name: type: string required: - id - name roles: type: array items: type: string emoji: $ref: '#/components/schemas/UserEmojiDto' preferences: $ref: '#/components/schemas/UserPreferencesDto' mcpOrgId: type: string required: - id - canResetPassword - name - imageUrl - jobTitle - email - account - emoji - preferences UpdateOnboardingStatusDto: type: object properties: status: type: string enum: - ConnectOrg - Completed required: - status InvitationDto: type: object properties: email: type: string format: email roleGroupId: type: string message: type: string template: type: string enum: - FUNNEL - ACCOUNT entryPointId: type: string entryPointName: type: string required: - email - roleGroupId - template - entryPointId - entryPointName EditUserDto: type: object properties: name: type: string imageUrl: type: string jobTitle: type: string emoji: $ref: '#/components/schemas/UserEmojiDto' UserRoleDto: type: object properties: roleGroupId: type: string required: - roleGroupId ImageDataDto: type: object properties: image: type: string required: - image FieldIdsDto: type: object properties: fieldIds: type: array items: required: true type: array items: type: string required: - fieldIds SweepFieldBaseDto: type: object properties: id: type: string objectName: type: string sweepFieldName: type: string sfFieldName: type: string fieldType: type: string enum: - Id - Address - AutoNumber - Checkbox - Currency - Date - DateTime - Email - Html - EncryptedText - Geolocation - Hierarchy - LongTextArea - Lookup - MasterDetail - MultiselectPicklist - Name - Name2 - Number - Percent - Phone - Picklist - Summary - Text - TextArea - Time - Unknown - Url - FormulaCheckbox - FormulaCurrency - FormulaDate - FormulaDateTime - FormulaNumber - FormulaPercent - FormulaText - FormulaTime - Combobox compoundFieldId: type: string isCompound: type: boolean properties: type: object origin: type: string enum: - SF_STANDARD - SF_CUSTOM - SWEEP_CUSTOM - MP_CUSTOM isRequired: type: boolean isCreatedInSweep: type: boolean helpText: type: string description: type: string pinToFunnelMap: type: string sfDisplayType: type: string enum: - ADDRESS - BOOLEAN - CURRENCY - DATE - DATETIME - EMAIL - GEOLOCATION - TEXTAREA - LONGTEXTAREA - REFERENCE - MULTIPICKLIST - NUMBER - PERCENT - PHONE - PICKLIST - COMBOBOX - STRING - TIME - URL - INTEGER - DOUBLE - ID - ENCRYPTEDSTRING - Unknown required: - objectName - sweepFieldName - fieldType - properties FieldUpdateDto: type: object properties: field: $ref: '#/components/schemas/SweepFieldBaseDto' enableDeduceValuesOrder: type: boolean required: - field SlackOAuthDto: type: object properties: {} SlackConnectionDto: type: object properties: status: type: string enum: - connected - error - invalid_credentials - initialization - not_initialized upgradeRequired: type: boolean includeSandboxes: type: boolean required: - status - includeSandboxes EditSlackConnectionDto: type: object properties: includeSandboxes: type: boolean required: - includeSandboxes Logo: type: object properties: name: type: string domain: type: string required: - name - domain UpsertCustomIntegrationDto: type: object properties: name: type: string baseUrl: type: string format: uri authentication: type: object logo: $ref: '#/components/schemas/Logo' required: - name - baseUrl - authentication TeamsOAuthDto: type: object properties: code: type: string state: type: string required: - code - state TeamsRecipientInfo: type: object properties: label: type: string id: type: string type: enum: - channel - user - team - user_stored_in_salesforce_field - channel_stored_in_sweep - channel_stored_in_salesforce_field type: string required: - label - id - type Field: type: object properties: fieldIds: type: array items: type: string value: type: string required: - fieldIds - value StringTemplate: type: object properties: template: type: string variables: type: array items: $ref: '#/components/schemas/SweepFieldReference' required: - template - variables KeyValueStringTemplate: type: object properties: key: type: string value: $ref: '#/components/schemas/StringTemplate' required: - key - value SweepCondition: type: object properties: criteria: type: array items: type: object criteriaLogic: type: string required: - criteria - criteriaLogic OptionalCondition: type: object properties: isCriteria: type: boolean criteria: $ref: '#/components/schemas/SweepCondition' AutomationConditionalActions: type: object properties: _id: type: string when: $ref: '#/components/schemas/OptionalCondition' actions: type: array items: type: object _name: type: string required: - _id - actions - _name AutomationActionParamsWebhook: type: object properties: verb: type: string enum: - GET - POST - PUT - PATCH - DELETE path: $ref: '#/components/schemas/StringTemplate' queryParams: type: array items: $ref: '#/components/schemas/KeyValueStringTemplate' headers: type: array items: $ref: '#/components/schemas/KeyValueStringTemplate' body: type: object integrationId: type: string followUpActions: type: array items: $ref: '#/components/schemas/AutomationConditionalActions' required: - verb - path - queryParams - headers - body - integrationId - followUpActions AutomationActionWebhook: type: object properties: actionType: enum: [] type: number default: WEBHOOK actionParams: $ref: '#/components/schemas/AutomationActionParamsWebhook' _id: type: string required: - actionType - actionParams - _id WebhookTestDto: type: object properties: fields: type: array items: $ref: '#/components/schemas/Field' action: $ref: '#/components/schemas/AutomationActionWebhook' required: - fields - action TeamsWithInstallationStatus: type: object properties: label: type: string id: type: string type: enum: - channel - user - team - user_stored_in_salesforce_field - channel_stored_in_sweep - channel_stored_in_salesforce_field type: string isSweepAppInstalled: type: boolean required: - label - id - type - isSweepAppInstalled CreateCommentThreadDto: type: object properties: positionX: type: number positionY: type: number commentBody: type: string mentionedUserIds: type: array items: type: string required: - positionX - positionY - commentBody - mentionedUserIds CommentReplyDto: type: object properties: id: type: string commentBody: type: string createdById: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string mentionedUserIds: type: array items: type: string required: - id - commentBody - createdById - createdAt - updatedAt - mentionedUserIds CommentThreadDto: type: object properties: id: type: string positionX: type: number positionY: type: number isResolved: type: boolean isRead: type: boolean commentReplies: type: array items: $ref: '#/components/schemas/CommentReplyDto' createdById: type: string createdAt: format: date-time type: string funnelMapId: type: string required: - id - positionX - positionY - isResolved - commentReplies - createdById - createdAt - funnelMapId UpdateCommentThreadPositionDto: type: object properties: positionX: type: number positionY: type: number required: - positionX - positionY CreateCommentReplyDto: type: object properties: commentBody: type: string mentionedUserIds: type: array items: type: string transientId: type: string required: - commentBody - mentionedUserIds UpdateCommentReplyDto: type: object properties: commentBody: type: string mentionedUserIds: type: array items: type: string required: - commentBody - mentionedUserIds Buffer: type: object properties: {} Funnel: type: object properties: id: type: string apiName: type: string accountId: type: string account: $ref: '#/components/schemas/Account' name: type: string funnelDetails: $ref: '#/components/schemas/FunnelDetailsDto' restoredFromSnapshot: type: number currentlyDeployedSnapshotId: type: string createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedById: type: string updatedBy: $ref: '#/components/schemas/User' description: type: string objectName: type: string leadingFieldId: type: string recordTypeName: type: string updatedAt: format: date-time type: string biSettings: $ref: '#/components/schemas/BISettingsDto' crmOrgId: type: string crmOrg: $ref: '#/components/schemas/CrmOrg' required: - id - apiName - accountId - account - name - funnelDetails - restoredFromSnapshot - currentlyDeployedSnapshotId - createdById - createdBy - createdAt - updatedById - updatedBy - description - objectName - leadingFieldId - recordTypeName - updatedAt - biSettings - crmOrgId - crmOrg FreePosition: type: object properties: x: type: number y: type: number required: - x - y FunnelMapSection: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' sectionId: type: string backgroundColor: type: string name: type: string xyPosition: $ref: '#/components/schemas/FreePosition' width: type: number height: type: number required: - funnelMapId - funnelMap - sectionId - backgroundColor - name - xyPosition - width - height FunnelMapMember: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' funnelId: type: string funnel: $ref: '#/components/schemas/Funnel' row: type: number column: type: number sectionId: type: string section: $ref: '#/components/schemas/FunnelMapSection' required: - funnelMapId - funnelMap - funnelId - funnel - row - column - sectionId - section ThirdPartyFunnel: type: object properties: id: type: string accountId: type: string account: $ref: '#/components/schemas/Account' name: type: string description: type: string system: type: object steps: type: array items: type: object funnelLinks: type: array items: type: object createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedById: type: string updatedBy: $ref: '#/components/schemas/User' required: - id - accountId - account - name - description - steps - funnelLinks - createdById - createdBy - createdAt - updatedById - updatedBy FunnelMapThirdParty: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' thirdPartyFunnelId: type: string thirdPartyFunnel: $ref: '#/components/schemas/ThirdPartyFunnel' row: type: number column: type: number sectionId: type: string section: $ref: '#/components/schemas/FunnelMapSection' required: - funnelMapId - funnelMap - thirdPartyFunnelId - thirdPartyFunnel - row - column - sectionId - section FunnelMapRecordType: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' recordTypeName: type: string objectName: type: string leadingFieldName: type: string row: type: number column: type: number sectionId: type: string section: $ref: '#/components/schemas/FunnelMapSection' required: - funnelMapId - funnelMap - recordTypeName - objectName - leadingFieldName - row - column - sectionId - section FunnelMapHubspot: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' objectName: type: string leadingFieldName: type: string row: type: number column: type: number sectionId: type: string section: $ref: '#/components/schemas/FunnelMapSection' required: - funnelMapId - funnelMap - objectName - leadingFieldName - row - column - sectionId - section FunnelMapMetadataElement: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' org: $ref: '#/components/schemas/Org' crmOrgId: type: string metadataId: type: string funnelLinks: type: array items: type: object color: type: string icon: type: string row: type: number column: type: number sectionId: type: string section: $ref: '#/components/schemas/FunnelMapSection' required: - funnelMapId - funnelMap - org - crmOrgId - metadataId - funnelLinks - color - icon - row - column - sectionId - section FunnelMapStickyNote: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' stickyNoteId: type: string backgroundColor: type: string richText: type: string textScale: type: number sectionId: type: string section: $ref: '#/components/schemas/FunnelMapSection' xyPosition: $ref: '#/components/schemas/FreePosition' width: type: number height: type: number required: - funnelMapId - funnelMap - stickyNoteId - backgroundColor - richText - textScale - sectionId - section - xyPosition - width - height FunnelMapText: type: object properties: funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' textId: type: string richText: type: string textScale: type: number sectionId: type: string section: $ref: '#/components/schemas/FunnelMapSection' xyPosition: $ref: '#/components/schemas/FreePosition' width: type: number height: type: number required: - funnelMapId - funnelMap - textId - richText - textScale - sectionId - section - xyPosition - width - height SweepFieldToFunnelMapPin: type: object properties: accountId: type: string sweepFieldId: type: string funnelMapId: type: string funnelMap: $ref: '#/components/schemas/FunnelMap' required: - accountId - sweepFieldId - funnelMapId - funnelMap FunnelMap: type: object properties: id: type: string accountId: type: string account: $ref: '#/components/schemas/Account' name: type: string defaultCrmOrgId: type: string defaultCrmOrg: $ref: '#/components/schemas/CrmOrg' createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedById: type: string updatedBy: $ref: '#/components/schemas/User' updatedAt: format: date-time type: string version: type: number isPinned: type: boolean sections: type: array items: $ref: '#/components/schemas/FunnelMapSection' funnels: type: array items: $ref: '#/components/schemas/FunnelMapMember' thirdPartyFunnels: type: array items: $ref: '#/components/schemas/FunnelMapThirdParty' recordTypes: type: array items: $ref: '#/components/schemas/FunnelMapRecordType' hubspotFunnels: type: array items: $ref: '#/components/schemas/FunnelMapHubspot' metadataElements: type: array items: $ref: '#/components/schemas/FunnelMapMetadataElement' stickyNotes: type: array items: $ref: '#/components/schemas/FunnelMapStickyNote' texts: type: array items: $ref: '#/components/schemas/FunnelMapText' sweepFieldsPins: type: array items: $ref: '#/components/schemas/SweepFieldToFunnelMapPin' required: - id - accountId - account - name - defaultCrmOrgId - defaultCrmOrg - createdById - createdBy - createdAt - updatedById - updatedBy - updatedAt - version - isPinned - sections - funnels - thirdPartyFunnels - recordTypes - hubspotFunnels - metadataElements - stickyNotes - texts - sweepFieldsPins RequestChange: type: object properties: id: type: string createdById: type: string createdBy: $ref: '#/components/schemas/User' crmOrgId: type: string crmOrg: $ref: '#/components/schemas/CrmOrg' funnelId: type: string funnel: $ref: '#/components/schemas/Funnel' originatedFunnelMapId: type: string originatedFunnelMap: $ref: '#/components/schemas/FunnelMap' snapshotId: type: string snapshot: $ref: '#/components/schemas/FunnelSnapshot' note: type: string status: type: string enum: - proposed - approved - rejected createdAt: format: date-time type: string required: - id - createdById - createdBy - crmOrgId - crmOrg - funnelId - funnel - originatedFunnelMapId - originatedFunnelMap - snapshotId - snapshot - note - status - createdAt CreateRequestChangesDto: type: object properties: funnelId: type: string funnelMapId: type: string crmOrgId: type: string note: type: string required: - funnelId - funnelMapId - crmOrgId - note RequestChangesActionDto: type: object properties: requestChangeId: type: string note: type: string required: - requestChangeId - note ReadCriteriaDto: type: object properties: criterionId: type: string fieldName: type: string operator: type: string value: type: string required: - criterionId - fieldName - operator - value ReadTerritoryDto: type: object properties: criteria: type: array items: $ref: '#/components/schemas/ReadCriteriaDto' criteriaLogic: type: string name: type: string updatedAt: format: date-time type: string updatedById: type: string required: - criteria - criteriaLogic - name - updatedAt - updatedById CreateTerritoryCriterionDto: type: object properties: criterionId: type: string fieldName: type: string operator: type: string value: type: string required: - criterionId - fieldName - operator - value UpsertTerritoryDto: type: object properties: name: type: string criteria: type: array items: $ref: '#/components/schemas/CreateTerritoryCriterionDto' criteriaLogic: type: string required: - name - criteria - criteriaLogic TerritoryCriterion: type: object properties: criterionId: type: string fieldName: type: string operator: type: string value: type: string required: - criterionId - fieldName - operator - value Territory: type: object properties: id: type: string accountId: type: string account: $ref: '#/components/schemas/Account' name: type: string createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedById: type: string updatedBy: $ref: '#/components/schemas/User' updatedAt: format: date-time type: string criteria: type: array items: $ref: '#/components/schemas/TerritoryCriterion' criteriaLogic: type: string required: - id - accountId - account - name - createdById - createdBy - createdAt - updatedById - updatedBy - updatedAt - criteria - criteriaLogic SalesforceChangeFeedItem: type: object properties: sfId: type: string crmOrgId: type: string sfUserName: type: string action: type: string section: type: string nameSpace: type: string timestamp: format: date-time type: string required: - sfId - crmOrgId - sfUserName - action - section - nameSpace - timestamp SalesforceChangeFeedFilterList: type: object properties: sections: type: array items: type: string sfUserNames: type: array items: type: string crmOrgs: type: array items: type: string nameSpaces: type: array items: type: string required: - sections - sfUserNames - crmOrgs - nameSpaces SalesforceChangeFeedDto: type: object properties: changeFeedList: type: array items: $ref: '#/components/schemas/SalesforceChangeFeedItem' filters: $ref: '#/components/schemas/SalesforceChangeFeedFilterList' required: - changeFeedList SalesforceChangeFeedCriterionDto: type: object properties: criterionId: type: string minLength: 1 fieldName: type: string minLength: 1 operator: type: string minLength: 1 value: type: string minLength: 1 required: - criterionId - fieldName - operator - value UpdateSalesforceChangeFeedNotificationDto: type: object properties: name: type: string minLength: 1 criteriaLogic: type: string crmOrgIds: minItems: 1 type: array items: type: string isActive: type: boolean criteria: minItems: 1 type: array items: $ref: '#/components/schemas/SalesforceChangeFeedCriterionDto' actions: minItems: 1 type: array items: type: object required: - name - criteriaLogic - crmOrgIds - isActive - criteria - actions ClientNotificationDto: type: object properties: id: type: string format: uuid senderId: type: string format: uuid title: type: string body: type: string deepLink: type: string isRead: type: boolean createdAt: format: date-time type: string required: - id - senderId - title - body - deepLink - isRead - createdAt GetNotificationsResponseDto: type: object properties: totalUnread: type: number notifications: type: array items: $ref: '#/components/schemas/ClientNotificationDto' required: - totalUnread - notifications FunnelAnalyticsPeriodDto: type: object properties: from: type: string to: type: string required: - from - to GetFunnelAnalyticsRequestDto: type: object properties: crmOrgId: type: string funnelIds: type: array items: type: string period: $ref: '#/components/schemas/FunnelAnalyticsPeriodDto' sources: type: array items: type: string regions: type: array items: type: string assignmentGroups: type: array items: type: string required: - crmOrgId - funnelIds SalesforceEventMonitoringLogExportDto: type: object properties: {} JobExecutionParams: type: object properties: {} JobResultDetails: type: object properties: {} JobExecution: type: object properties: jobId: type: string jobStatus: type: string enum: - NOT_STARTED - IN_PROGRESS - COMPLETED executionParams: $ref: '#/components/schemas/JobExecutionParams' resultStatus: type: string enum: - SUCCESS - ERROR resultDetails: $ref: '#/components/schemas/JobResultDetails' createdAt: format: date-time type: string startedAt: format: date-time type: string completedAt: format: date-time type: string crmOrgId: type: string required: - jobId - jobStatus - executionParams - resultStatus - resultDetails - createdAt - startedAt - completedAt - crmOrgId UpdateFeaturePlanDto: type: object properties: {} UpdatePlanDto: type: object properties: {} OpenSearchScope: type: object properties: id: type: string orgId: type: string org: $ref: '#/components/schemas/Org' searchIndexName: type: string migrateToIndexName: type: string nullable: true enableIngest: type: boolean lastSyncedVersion: type: string nullable: true ongoingSyncVersion: type: string nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - orgId - org - searchIndexName - migrateToIndexName - enableIngest - lastSyncedVersion - ongoingSyncVersion - createdAt - updatedAt HubspotCrmOrgCreateDto: type: object properties: name: type: string isMain: type: boolean required: - name AutomationParamsFieldUpdate: type: object properties: _leadingFieldId: type: string _leadingFieldLabels: type: array items: type: string fieldType: type: string enum: - ADDRESS - BOOLEAN - CURRENCY - DATE - DATETIME - EMAIL - GEOLOCATION - TEXTAREA - LONGTEXTAREA - REFERENCE - MULTIPICKLIST - NUMBER - PERCENT - PHONE - PICKLIST - COMBOBOX - STRING - TIME - URL - INTEGER - DOUBLE - ID - ENCRYPTEDSTRING - Unknown operator: type: string operatorValue: type: object required: - _leadingFieldId - _leadingFieldLabels - operator AutomationParamsStageReference: type: object properties: _stageId: type: string stageName: type: string required: - _stageId - stageName AutomationTriggerStageTransitionParams: type: object properties: fromStage: $ref: '#/components/schemas/AutomationParamsStageReference' toStage: $ref: '#/components/schemas/AutomationParamsStageReference' AutomationTriggerTimeInStep: type: object properties: stage: $ref: '#/components/schemas/AutomationParamsStageReference' offsetValue: type: number offsetType: type: string enum: - Hours - Days - Weeks required: - stage - offsetValue - offsetType AutomationImmediateFieldReference: type: object properties: _leadingFieldId: type: string _leadingFieldLabels: type: array items: type: string required: - _leadingFieldId - _leadingFieldLabels AutomationTriggerDateArrives: type: object properties: relativeTime: type: string enum: - exact - before - after sourceField: $ref: '#/components/schemas/AutomationImmediateFieldReference' offsetValue: type: number offsetType: type: string enum: - Hours - Days - Weeks required: - relativeTime - sourceField AutomationSchedule: type: object properties: offset: type: object executeTime: type: string pattern: /^(?:(?:([01]?\d|2[0-3]):)?([0-5]?\d):)?([0-5]?\d)$/ startDate: type: string pattern: /^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$/ endDate: type: string pattern: /^\d{4}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])$/ timezone: type: string required: - executeTime - startDate - timezone AutomationParams: type: object properties: fieldUpdate: $ref: '#/components/schemas/AutomationParamsFieldUpdate' stageExit: $ref: '#/components/schemas/AutomationTriggerStageTransitionParams' stageEnter: $ref: '#/components/schemas/AutomationTriggerStageTransitionParams' timeInStep: $ref: '#/components/schemas/AutomationTriggerTimeInStep' dateArrive: $ref: '#/components/schemas/AutomationTriggerDateArrives' schedule: $ref: '#/components/schemas/AutomationSchedule' AutomationRecordTypeRef: type: object properties: name: type: string label: type: string required: - name - label DelayActionsParams: type: object properties: offsetValue: type: number offsetType: type: string enum: - Minutes - Hours - Days shouldReevaluate: type: boolean required: - offsetValue - offsetType AutomationDetailsWithFunnelIdDto: type: object properties: funnelId: type: string automationParams: $ref: '#/components/schemas/AutomationParams' recordTypes: type: array items: $ref: '#/components/schemas/AutomationRecordTypeRef' when: $ref: '#/components/schemas/OptionalCondition' delay: $ref: '#/components/schemas/DelayActionsParams' actions: type: array items: type: object triggerType: type: string enum: - FIELD_UPDATE - STAGE_EXIT - STAGE_ENTER - TIME_IN_STEP - DATE_ARRIVE - ON_CREATE - ON_UPDATE - ON_UPSERT - SCHEDULED - BOOKING_REQUEST getDataAction: type: object permissionMode: type: string enum: - USER_MODE - SYSTEM_MODE required: - automationParams - actions - triggerType AutomationDto: type: object properties: automationId: type: string versionId: type: string versionName: type: string name: type: string automationDetails: $ref: '#/components/schemas/AutomationDetailsWithFunnelIdDto' crmOrgId: type: string accountId: type: string objectName: type: string status: enum: - Draft - Deployed type: string deployedAs: enum: - AUTOMATION - FLOW type: string isActive: type: boolean notifyAdmin: type: boolean priority: type: number type: enum: - Default - Assignment - Alert - Dedupe - Matching - ScheduledAssignment - ScheduledReport - ScheduledJob - MarketingAttribution - Booking type: string funnelRecordType: $ref: '#/components/schemas/FunnelRecordTypeDto' createdById: type: string createdAt: format: date-time type: string updatedById: type: string updatedAt: format: date-time type: string required: - automationId - versionId - versionName - name - automationDetails - crmOrgId - accountId - status - isActive - notifyAdmin - priority - type - createdById - createdAt - updatedById - updatedAt CreateAutomationOrderHintDto: type: object properties: orderGroupId: type: string insertBeforeAutomationId: type: string required: - orderGroupId CreateAutomationDto: type: object properties: name: type: string automationDetails: $ref: '#/components/schemas/AutomationDetailsWithFunnelIdDto' objectName: type: string type: enum: - Default - Assignment - Alert - Dedupe - Matching - ScheduledAssignment - ScheduledReport - ScheduledJob - MarketingAttribution - Booking type: string orderHint: $ref: '#/components/schemas/CreateAutomationOrderHintDto' required: - name - automationDetails - type CreateAutomationWithAiDto: type: object properties: description: type: string required: - description AutoTemplatesStructDto: type: object properties: fieldsList: type: array items: type: string automation: type: object required: - fieldsList - automation UpdateAutomationDto: type: object properties: name: type: string automationDetails: $ref: '#/components/schemas/AutomationDetailsWithFunnelIdDto' required: - name - automationDetails DeployAutomationDto: type: object properties: deployToOrgIds: minItems: 1 type: array items: type: string deployAs: enum: - AUTOMATION - FLOW type: string required: - deployToOrgIds AiChatDto: type: object properties: sessionId: type: string message: type: string context: type: object isFirstMessage: type: boolean required: - sessionId - message - context - isFirstMessage AutomationActivationDto: type: object properties: isActive: type: boolean deployToOrgIds: minItems: 1 type: array items: type: string deployAs: enum: - AUTOMATION - FLOW type: string required: - isActive - deployToOrgIds AdminNotificationDto: type: object properties: note: type: string SweepFieldOutgoingDto: type: object properties: id: type: string objectName: type: string sweepFieldName: type: string sfFieldName: type: string fieldType: type: string enum: - Id - Address - AutoNumber - Checkbox - Currency - Date - DateTime - Email - Html - EncryptedText - Geolocation - Hierarchy - LongTextArea - Lookup - MasterDetail - MultiselectPicklist - Name - Name2 - Number - Percent - Phone - Picklist - Summary - Text - TextArea - Time - Unknown - Url - FormulaCheckbox - FormulaCurrency - FormulaDate - FormulaDateTime - FormulaNumber - FormulaPercent - FormulaText - FormulaTime - Combobox isCompound: type: boolean properties: type: object origin: type: string enum: - SF_STANDARD - SF_CUSTOM - SWEEP_CUSTOM - MP_CUSTOM isRequired: type: boolean isCreatedInSweep: type: boolean helpText: type: string description: type: string compoundFieldId: type: string rollup: type: object required: - objectName - sweepFieldName - fieldType - properties - rollup RollupDto: type: object properties: name: type: string rollupId: type: string versionId: type: string rollupField: $ref: '#/components/schemas/SweepFieldOutgoingDto' crmOrgId: type: string accountId: type: string objectName: type: string status: enum: - Draft - Deployed type: string isActive: type: boolean notifyAdmin: type: boolean priority: type: number type: type: string createdById: type: string createdAt: format: date-time type: string updatedById: type: string updatedAt: format: date-time type: string required: - name - rollupId - versionId - rollupField - crmOrgId - accountId - objectName - status - isActive - notifyAdmin - priority - type - createdById - createdAt - updatedById - updatedAt SweepFieldRollupDto: type: object properties: id: type: string objectName: type: string sweepFieldName: type: string sfFieldName: type: string fieldType: enum: - Id - Address - AutoNumber - Checkbox - Currency - Date - DateTime - Email - Html - EncryptedText - Geolocation - Hierarchy - LongTextArea - Lookup - MasterDetail - MultiselectPicklist - Name - Name2 - Number - Percent - Phone - Picklist - Summary - Text - TextArea - Time - Unknown - Url - FormulaCheckbox - FormulaCurrency - FormulaDate - FormulaDateTime - FormulaNumber - FormulaPercent - FormulaText - FormulaTime - Combobox type: string compoundFieldId: type: string isCompound: type: boolean properties: type: object origin: enum: - SF_STANDARD - SF_CUSTOM - SWEEP_CUSTOM - MP_CUSTOM type: string isRequired: type: boolean isCreatedInSweep: type: boolean helpText: type: string description: type: string pinToFunnelMap: type: string sfDisplayType: enum: - ADDRESS - BOOLEAN - CURRENCY - DATE - DATETIME - EMAIL - GEOLOCATION - TEXTAREA - LONGTEXTAREA - REFERENCE - MULTIPICKLIST - NUMBER - PERCENT - PHONE - PICKLIST - COMBOBOX - STRING - TIME - URL - INTEGER - DOUBLE - ID - ENCRYPTEDSTRING - Unknown type: string rollup: type: object required: - objectName - sweepFieldName - fieldType - properties UpdateRollupDto: type: object properties: rollupField: $ref: '#/components/schemas/SweepFieldRollupDto' required: - rollupField CreateRollupDto: type: object properties: rollupField: $ref: '#/components/schemas/SweepFieldRollupDto' objectName: type: string required: - rollupField - objectName DeployRollupDto: type: object properties: deployToOrgIds: minItems: 1 type: array items: type: string format: uuid required: - deployToOrgIds UpdateUserAndAccountDetails: type: object properties: {} SfdcSupportMessageDto: type: object properties: role: type: number enum: [] content: type: string createdAt: format: date-time type: string required: - role - content - createdAt CreateSupportChatDto: type: object properties: userId: type: string fullName: type: string recordId: type: string pageUrl: type: string objectName: type: string message: $ref: '#/components/schemas/SfdcSupportMessageDto' timeoutMs: type: number required: - userId - message SendSupportMessageDto: type: object properties: userId: type: string message: $ref: '#/components/schemas/SfdcSupportMessageDto' timeoutMs: type: number required: - userId - message SfdcCreateChannelRequest: type: object properties: requestId: type: string actionId: type: string recordId: type: string objectName: type: string fields: type: array items: $ref: '#/components/schemas/Field' required: - requestId - actionId - recordId - objectName SfdcCreateChannelsRequestDto: type: object properties: createChannelRequests: type: array items: $ref: '#/components/schemas/SfdcCreateChannelRequest' required: - createChannelRequests CreateChannelResult: type: object properties: status: type: string enum: - SUCCESS - PARTIAL_SUCCESS - ERROR channelId: type: string errorMessage: type: string required: - status SfdcCreateChannelResponse: type: object properties: requestId: type: string resultParams: $ref: '#/components/schemas/CreateChannelResult' required: - requestId - resultParams CreateJobExecutionsDto: type: object properties: {} GetJobExecutionResultDto: type: object properties: {} JobExecutionResult: type: object properties: {} CampaignMemberStatus: type: object properties: {} WriteCampaignDto: type: object properties: {} CampaignDto: type: object properties: {} WriteCampaignMemberStatusDto: type: object properties: {} ReplaceStatusDto: type: object properties: {} UpdateCampaignMemberStatusDto: type: object properties: {} WorkflowDetailsDto: type: object properties: when: type: object actions: type: array items: type: object onlyEnrollsManually: type: boolean required: - actions - onlyEnrollsManually WorkflowDto: type: object properties: hubspotWorkflowId: type: string name: type: string workflowDetails: $ref: '#/components/schemas/WorkflowDetailsDto' accountId: type: string objectName: type: string isActive: type: boolean createdById: type: string createdAt: format: date-time type: string updatedById: type: string updatedAt: format: date-time type: string required: - hubspotWorkflowId - name - workflowDetails - accountId - objectName - isActive - createdById - createdAt - updatedById - updatedAt CreateWorkflowDto: type: object properties: name: type: string workflowDetails: $ref: '#/components/schemas/WorkflowDetailsDto' objectName: type: string enrollExistingContacts: type: boolean required: - name - workflowDetails - objectName UpdateWorkflowDto: type: object properties: workflowId: type: string name: type: string workflowDetails: $ref: '#/components/schemas/WorkflowDetailsDto' enrollExistingContacts: type: boolean required: - workflowId - name - workflowDetails AppUtilityBarDto: type: object properties: appDeveloperName: type: string hasSweepSupport: type: boolean required: - appDeveloperName - hasSweepSupport ToggleUtilityBarDto: type: object properties: toggleOn: type: array items: $ref: '#/components/schemas/AppUtilityBarDto' toggleOff: type: array items: $ref: '#/components/schemas/AppUtilityBarDto' SalesforceAppDto: type: object properties: developerName: type: string label: type: string logoUrl: type: string hasSweepSupport: type: boolean required: - developerName - label - logoUrl - hasSweepSupport UpdateSessionStatusDto: type: object properties: status: type: string enum: - Open - Ask_Admin - Closed_By_Rep - Closed_By_Admin required: - status UpsertRoleGroupDto: type: object properties: name: type: string roleGroupLevels: type: object description: type: string required: - name - roleGroupLevels ThirdPartySystemDto: type: object properties: name: type: string domain: type: string required: - name - domain StepConnectionDto: type: object properties: _id: type: string targetId: type: string required: - _id - targetId StepPositionDto: type: object properties: row: type: number column: type: number required: - row - column ThirdPartyStepsDto: type: object properties: id: type: string name: type: string stepConnections: type: array items: $ref: '#/components/schemas/StepConnectionDto' funnelLinks: type: array items: $ref: '#/components/schemas/FunnelLinkDto' position: $ref: '#/components/schemas/StepPositionDto' required: - id - name - stepConnections - funnelLinks - position ThirdPartyFunnelDto: type: object properties: id: type: string name: type: string description: type: string system: $ref: '#/components/schemas/ThirdPartySystemDto' steps: type: array items: $ref: '#/components/schemas/ThirdPartyStepsDto' funnelLinks: type: array items: $ref: '#/components/schemas/FunnelLinkDto' required: - id - name - description - steps - funnelLinks UpsertThirdPartyFunnelDto: type: object properties: name: type: string description: type: string system: $ref: '#/components/schemas/ThirdPartySystemDto' steps: type: array items: $ref: '#/components/schemas/ThirdPartyStepsDto' funnelLinks: type: array items: $ref: '#/components/schemas/FunnelLinkDto' required: - name - description - steps - funnelLinks IncludeConfigurationDto: type: object properties: name: type: string type: type: string required: - name - type CreateAgentDto: type: object properties: name: type: string type: type: object contextComponents: type: object userInstructions: type: string systemInstructions: type: string bestPracticeIds: type: array items: type: string format: uuid metadataElements: type: array items: $ref: '#/components/schemas/IncludeConfigurationDto' required: - name - type - contextComponents AiProjectOriginTemplate: type: object properties: projectId: type: string project: $ref: '#/components/schemas/AiProject' originTemplateExternalId: type: string enum: - blank - cpq-agentforce-revenue-management - process-builder-to-flow - profiles-permission-set-groups-migration - visualforce-aura-lwc-modernization - field-cleanup-hygiene - salesforce-winter-27-release-prep - ai-security-risk-remediation - product-catalog-rationalization - agentforce-readiness required: - projectId - project - originTemplateExternalId AiAgentFileCache: type: object properties: contentHash: type: string name: type: string summary: type: string files: type: array items: $ref: '#/components/schemas/AiAgentFile' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - contentHash - name - summary - files - createdAt - updatedAt AiAgentFile: type: object properties: id: type: string name: type: string type: enum: - txt - json - xml - csv - tsv - log - env - md - config - pdf - docx - png - jpg - jpeg - webp - avif type: string agentId: type: string agent: $ref: '#/components/schemas/AiAgent' createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string summary: type: string contentHash: type: string nullable: true description: 'Null until the shared summary row exists. MySQL permits this because a composite foreign key with a null part is not checked.' fileCache: nullable: true allOf: - $ref: '#/components/schemas/AiAgentFileCache' status: enum: - processing - completed - failed type: string required: - id - name - type - agentId - agent - createdById - createdBy - createdAt - summary - contentHash - fileCache - status BestPractice: type: object properties: id: type: string name: type: string severity: type: object text: type: string isSystem: type: boolean applicableDomain: type: string enum: - MetadataMonitoring - BusinessProcess applicableResourceType: type: string accountId: type: string account: $ref: '#/components/schemas/Account' createdById: type: string createdBy: $ref: '#/components/schemas/User' updatedById: type: string updatedBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - name - severity - text - isSystem - applicableDomain - applicableResourceType - accountId - account - createdById - createdBy - updatedById - updatedBy - createdAt - updatedAt AiAgentBestPractice: type: object properties: aiAgentId: type: string bestPracticeId: type: string aiAgent: $ref: '#/components/schemas/AiAgent' bestPractice: $ref: '#/components/schemas/BestPractice' createdAt: format: date-time type: string required: - aiAgentId - bestPracticeId - aiAgent - bestPractice - createdAt AiAgentMetadataElement: type: object properties: aiAgentId: type: string name: type: string type: type: string aiAgent: $ref: '#/components/schemas/AiAgent' createdAt: format: date-time type: string required: - aiAgentId - name - type - aiAgent - createdAt AiAgent: type: object properties: id: type: string name: type: string type: enum: - Documentation - Process Optimization - MonitoringV2 - Permissions - Support type: string contextComponents: type: object userInstructions: type: string systemInstructions: type: string projectId: type: string nullable: true project: nullable: true allOf: - $ref: '#/components/schemas/AiProject' orgId: type: string org: $ref: '#/components/schemas/Org' files: type: array items: $ref: '#/components/schemas/AiAgentFile' bestPractices: type: array items: $ref: '#/components/schemas/AiAgentBestPractice' metadataElements: type: array items: $ref: '#/components/schemas/AiAgentMetadataElement' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - name - type - contextComponents - userInstructions - systemInstructions - projectId - project - orgId - org - files - bestPractices - metadataElements - createdAt - updatedAt AiProjectPrompt: type: object properties: id: type: string promptTitle: type: string promptText: type: string mode: type: string enum: - none - researchMode - buildMode - multiOrgMode - artifactMode isCompleted: type: boolean completedById: type: string nullable: true completedAt: format: date-time type: string nullable: true projectId: type: string project: $ref: '#/components/schemas/AiProject' required: - id - promptTitle - promptText - mode - isCompleted - completedById - completedAt - projectId - project AiChatFolder: type: object properties: id: type: string name: type: string createdById: type: string createdBy: $ref: '#/components/schemas/User' agentId: type: string agent: $ref: '#/components/schemas/AiAgent' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - name - createdById - createdBy - agentId - agent - createdAt - updatedAt AiChat: type: object properties: id: type: string name: type: string aiChatDetails: type: object orgId: type: string org: $ref: '#/components/schemas/Org' accountId: type: string account: $ref: '#/components/schemas/Account' agentId: type: string agent: $ref: '#/components/schemas/AiAgent' createdAt: format: date-time type: string updatedAt: format: date-time type: string userId: type: string nullable: true sfdcUserId: type: string nullable: true isFavorite: type: boolean folderId: type: string nullable: true folder: $ref: '#/components/schemas/AiChatFolder' chatContext: type: string chatSource: enum: - Sweep - Salesforce type: string required: - id - name - aiChatDetails - orgId - org - accountId - account - agentId - agent - createdAt - updatedAt - userId - sfdcUserId - isFavorite - folderId - folder - chatContext - chatSource AiArtifact: type: object properties: id: type: string artifactId: type: string chatId: type: string chat: $ref: '#/components/schemas/AiChat' accountId: type: string account: $ref: '#/components/schemas/Account' createdById: type: string createdBy: $ref: '#/components/schemas/User' title: type: string code: type: string version: type: number isShared: type: boolean isPublic: type: boolean toolResults: type: object nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - artifactId - chatId - chat - accountId - account - createdById - createdBy - title - code - version - isShared - isPublic - toolResults - createdAt - updatedAt AiTableArtifact: type: object properties: id: type: string chatId: type: string chat: $ref: '#/components/schemas/AiChat' accountId: type: string account: $ref: '#/components/schemas/Account' createdById: type: string createdBy: $ref: '#/components/schemas/User' title: type: string markdown: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - chatId - chat - accountId - account - createdById - createdBy - title - markdown - createdAt - updatedAt AiProjectSectionItem: type: object properties: id: type: string sortOrder: type: number sectionId: type: string section: $ref: '#/components/schemas/AiProjectSection' promptId: type: string nullable: true prompt: nullable: true allOf: - $ref: '#/components/schemas/AiProjectPrompt' artifactId: type: string nullable: true artifact: nullable: true allOf: - $ref: '#/components/schemas/AiArtifact' tableArtifactId: type: string nullable: true tableArtifact: nullable: true allOf: - $ref: '#/components/schemas/AiTableArtifact' fileId: type: string nullable: true file: nullable: true allOf: - $ref: '#/components/schemas/AiAgentFile' required: - id - sortOrder - sectionId - section - promptId - prompt - artifactId - artifact - tableArtifactId - tableArtifact - fileId - file AiProjectSection: type: object properties: id: type: string name: type: string sortOrder: type: number type: enum: - prompts - artifacts - files type: string isDefault: type: boolean description: 'When true, this section is the auto-placement target for new artifacts produced by `processFinalResult()`. Only one default section per project (only applicable when `type = artifacts`). A default section can be renamed; it can be deleted only when empty. If deleted and new artifacts arrive, it is re-created automatically.' runMode: description: 'How "Run section" executes prompts. Only applicable when `type = prompts`. - `individual`: each prompt creates its own chat (default) - `queue`: one chat, prompts run as sequential messages' enum: - individual - queue type: string projectId: type: string project: $ref: '#/components/schemas/AiProject' items: type: array items: $ref: '#/components/schemas/AiProjectSectionItem' required: - id - name - sortOrder - type - isDefault - runMode - projectId - project - items AiProject: type: object properties: id: type: string name: type: string description: type: string nullable: true visibility: enum: - team - private type: string accountId: type: string account: $ref: '#/components/schemas/Account' createdById: type: string autonomyMode: nullable: true enum: - guided - balanced - autonomous type: string originTemplateId: nullable: true description: 'API-facing origin template id. Not a DB column — populated from `originTemplate.originTemplateExternalId` when that relation is loaded.' enum: - blank - cpq-agentforce-revenue-management - process-builder-to-flow - profiles-permission-set-groups-migration - visualforce-aura-lwc-modernization - field-cleanup-hygiene - salesforce-winter-27-release-prep - ai-security-risk-remediation - product-catalog-rationalization - agentforce-readiness type: string originTemplate: nullable: true allOf: - $ref: '#/components/schemas/AiProjectOriginTemplate' agent: $ref: '#/components/schemas/AiAgent' sections: type: array items: $ref: '#/components/schemas/AiProjectSection' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - name - description - visibility - accountId - account - createdById - autonomyMode - agent - sections - createdAt - updatedAt EditAgentNameDto: type: object properties: name: type: string required: - name EditAgentUserInstructionsDto: type: object properties: userInstructions: type: string required: - userInstructions EditAgentSystemInstructionsDto: type: object properties: systemInstructions: type: string required: - systemInstructions PatchAgentConfigurationsDto: type: object properties: includeConfigurations: type: array items: $ref: '#/components/schemas/IncludeConfigurationDto' required: - includeConfigurations GenerateFileUploadUrlDto: type: object properties: fileName: type: string fileType: type: string enum: - txt - json - xml - csv - tsv - log - env - md - config - pdf - docx - png - jpg - jpeg - webp - avif contentType: type: string required: - fileName - fileType - contentType ConfirmFileUploadDto: type: object properties: fileKey: type: string fileName: type: string fileType: type: string enum: - txt - json - xml - csv - tsv - log - env - md - config - pdf - docx - png - jpg - jpeg - webp - avif required: - fileKey - fileName - fileType AiChatMessageDto: type: object properties: role: type: number enum: [] content: type: object replyTo: type: string createdAt: format: date-time type: string hidden: type: boolean required: - role - content - createdAt SupportContextDto: type: object properties: recordId: type: string objectName: type: string sfdcUserId: type: string ChatMessageDto: type: object properties: message: $ref: '#/components/schemas/AiChatMessageDto' mode: enum: - none - researchMode - buildMode - multiOrgMode - artifactMode type: string additionalOrgIds: type: array items: type: string format: uuid enableArtifactsVersioning: type: boolean enableUnifiedArtifactFilePath: type: boolean enableResearchRubric: type: boolean useRedis: type: boolean mcpConnectionIds: type: array items: type: string format: uuid chatName: type: string folderId: type: string format: uuid promptId: type: string format: uuid supportContext: $ref: '#/components/schemas/SupportContextDto' required: - message McpToolApprovalDecisionDto: type: object properties: toolName: type: string serverType: type: string connectionId: type: string decision: type: string enum: - allow_once - always_allow - deny required: - toolName - serverType - connectionId - decision McpToolApprovalDto: type: object properties: decisions: type: array items: $ref: '#/components/schemas/McpToolApprovalDecisionDto' mcpConnectionIds: type: array items: type: string mode: type: string enum: - none - researchMode - buildMode - multiOrgMode - artifactMode enableArtifactsVersioning: type: boolean enableResearchRubric: type: boolean required: - decisions - mcpConnectionIds UpdateIssueDto: type: object properties: status: type: object severity: type: object DeleteAiChatMessagePairDto: type: object properties: expectedUserCreatedAt: type: string expectedAssistantCreatedAt: type: string required: - expectedUserCreatedAt - expectedAssistantCreatedAt SubmitFeedbackDto: type: object properties: satisfaction: type: number minimum: 0 maximum: 1 required: - satisfaction ManageBestPracticesDto: type: object properties: bestPracticeIds: minItems: 1 type: array items: type: string format: uuid required: - bestPracticeIds AiBuildDefinition: type: object properties: id: type: string chatId: type: string chat: $ref: '#/components/schemas/AiChat' text: type: string status: type: string enum: - draft - building - success - partial_success - failed createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - chatId - chat - text - status - createdAt - updatedAt ProcessMiningAgentDto: type: object properties: message: $ref: '#/components/schemas/AiChatMessageDto' required: - message ChatAttachmentsUploadUrlsDto: type: object properties: attachmentIds: minItems: 1 type: array items: type: string format: uuid required: - attachmentIds SfdcRunSoqlQueryDto: type: object properties: {} SfdcRunSoqlNextQueryDto: type: object properties: {} EventMonitoringListEventsDto: type: object properties: eventType: type: string startDate: type: string pattern: ISO_DATE endDate: type: string pattern: ISO_DATE filters: type: object fields: type: array items: type: string orderBy: type: string countOnly: type: boolean distinct: type: boolean required: - eventType - startDate - endDate EventMonitoringAggregateDto: type: object properties: eventType: type: string startDate: type: string pattern: ISO_DATE endDate: type: string pattern: ISO_DATE groupBy: minItems: 1 type: array items: type: string filters: type: object orderBy: type: string limit: type: number minimum: 1 maximum: 200000 required: - eventType - startDate - endDate - groupBy DeployMetadataDto: type: object properties: {} DeploySalesforceRecordsDto: type: object properties: objectName: type: string records: description: 'Array of plain JSON objects keyed by Salesforce field API name. For `UPDATE`, each record MUST include an `Id` field.' type: array items: type: object operation: type: string enum: - CREATE - UPDATE allOrNothing: type: boolean description: 'If true (default), Salesforce rolls back the whole batch when any record fails. If false, each record is committed independently.' required: - objectName - records - operation ConfigurationsSummariesDto: type: object properties: {} FunnelMapUpdateFunnelMapDto: type: object properties: operations: type: array items: type: object version: type: number required: - operations - version SearchMetadataDto: type: object properties: {} DocumentationObjectCounters: type: object properties: crmOrgId: type: string name: type: string crmOrg: $ref: '#/components/schemas/CrmOrg' label: type: string namespace: type: string customFields: type: number standardFields: type: number flows: type: number processBuilderFlows: type: number workflowRules: type: number apexTriggers: type: number apexClasses: type: number approvalProcesses: type: number validationRules: type: number layouts: type: number recordTypes: type: number createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - crmOrgId - name - crmOrg - label - namespace - customFields - standardFields - flows - processBuilderFlows - workflowRules - apexTriggers - apexClasses - approvalProcesses - validationRules - layouts - recordTypes - createdAt - updatedAt WorkatoEdgePredicateDto: type: object properties: field: type: string enum: - projectId - folderId - connectionId - collaboratorId - tag - app - recipeId op: type: string enum: - has - hasNot value: type: string required: - field - op - value WorkatoListElementsDto: type: object properties: filters: type: array items: $ref: '#/components/schemas/WorkatoEdgePredicateDto' limit: type: number minimum: 1 offset: type: number minimum: 0 RetrieveMetadataTypesDto: type: object properties: {} StreamCompletionDto: type: object properties: chat_id: type: string final_result: type: object required: - chat_id - final_result DocumentationObjectDto: type: object properties: favorite: type: boolean required: - favorite CalcParsedConfigurationGptDto: type: object properties: metadataId: type: string required: - metadataId CreateTagDto: type: object properties: name: type: string color: type: string required: - name - color EditTagDto: type: object properties: name: type: string color: type: string UpdateConfigurationUserInputsDto: type: object properties: tags: type: array items: type: string owner: type: string collaborators: type: array items: type: string required: - tags - owner - collaborators ConfigurationUserInputComment: type: object properties: id: type: string metadataId: type: string commentBody: type: string mentionedUserIds: type: array items: type: string properties: type: object crmOrgId: type: string crmOrg: $ref: '#/components/schemas/CrmOrg' createdById: type: string createdBy: $ref: '#/components/schemas/User' createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - metadataId - commentBody - mentionedUserIds - properties - crmOrgId - crmOrg - createdById - createdBy - createdAt - updatedAt ConfigurationCommentPropertiesDto: type: object properties: pinned: type: boolean required: - pinned UpsertConfigurationCommentDto: type: object properties: commentBody: type: string mentionedUserIds: type: array items: type: string properties: $ref: '#/components/schemas/ConfigurationCommentPropertiesDto' required: - commentBody - mentionedUserIds - properties BestPracticeResponseDto: type: object properties: id: type: string name: type: string severity: type: object text: type: string isSystem: type: boolean applicableDomain: enum: - MetadataMonitoring - BusinessProcess type: string applicableResourceType: type: string accountId: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - name - severity - text - isSystem - applicableDomain - applicableResourceType - accountId - createdAt - updatedAt CreateBestPracticeDto: type: object properties: name: type: string severity: type: object text: type: string applicableDomain: type: string enum: - MetadataMonitoring - BusinessProcess applicableResourceType: type: string required: - name - severity - text - applicableDomain - applicableResourceType UpdateBestPracticeDto: type: object properties: severity: type: object required: - severity PromptGroupResponseDto: type: object properties: id: type: string name: type: string description: type: string isPinned: type: boolean iconName: type: string accountId: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string createdById: type: string updatedById: type: string required: - id - name - isPinned - accountId - createdAt - updatedAt PromptResponseDto: type: object properties: id: type: string name: type: string promptText: type: string promptGroupId: type: string nullable: true accountId: type: string createdAt: format: date-time type: string updatedAt: format: date-time type: string createdById: type: string updatedById: type: string required: - id - name - promptText - accountId - createdAt - updatedAt CreatePromptGroupDto: type: object properties: name: type: string description: type: string isPinned: type: boolean iconName: type: string required: - name - isPinned UpdatePromptGroupDto: type: object properties: name: type: string description: type: string isPinned: type: boolean CreatePromptDto: type: object properties: name: type: string promptText: type: string promptGroupId: type: string required: - name - promptText UpdatePromptDto: type: object properties: name: type: string promptText: type: string promptGroupId: type: string OptimizePromptDto: type: object properties: promptText: type: string required: - promptText CreateUserSkillDto: type: object properties: name: type: string maxLength: 64 pattern: USER_SKILL_NAME_REGEX description: type: string maxLength: 1024 pattern: USER_SKILL_DESCRIPTION_NO_ANGLE_BRACKETS_REGEX instructions: type: string required: - name - description - instructions UpdateUserSkillDto: type: object properties: description: type: string maxLength: 1024 pattern: USER_SKILL_DESCRIPTION_NO_ANGLE_BRACKETS_REGEX instructions: type: string SetUserSkillEnabledDto: type: object properties: enabled: type: boolean required: - enabled CreateAccountDto: type: object properties: name: type: string maxLength: 100 required: - name ChatRetentionSettingsDto: type: object properties: enabled: type: boolean value: type: number minimum: 1 maximum: 999 unit: type: string enum: - days - months excludeFavorites: type: boolean required: - enabled - value - unit - excludeFavorites AgenticFeaturesSettingsDto: type: object properties: enableAggregateSoqlQueries: type: boolean enableDetailedSoqlQueries: type: boolean enableEventMonitoring: type: boolean enableAgenticRouting: type: boolean enableSweepExecutionLogs: type: boolean dataAccessMode: type: string enum: - integration_user - end_user chatRetentionSettings: $ref: '#/components/schemas/ChatRetentionSettingsDto' required: - enableAggregateSoqlQueries - enableDetailedSoqlQueries - enableEventMonitoring - enableAgenticRouting - enableSweepExecutionLogs - dataAccessMode - chatRetentionSettings OrgSettingsDto: type: object properties: crmOrgId: type: string name: type: string settings: $ref: '#/components/schemas/AgenticFeaturesSettingsDto' required: - crmOrgId - name - settings UpdateAgenticFeaturesSettingsDto: type: object properties: defaults: $ref: '#/components/schemas/AgenticFeaturesSettingsDto' orgSettings: type: array items: $ref: '#/components/schemas/OrgSettingsDto' required: - defaults - orgSettings RunSimulationDto: type: object properties: {} CreateData360OrgDto: type: object properties: name: type: string description: Org name example: Production Data 360 isSandbox: type: boolean description: Is sandbox org example: false required: - name - isSandbox Data360OrgResponseDto: type: object properties: id: type: string description: Org ID name: type: string description: Org name instanceUrl: type: string description: Salesforce instance URL tenantUrl: type: string description: Data 360 tenant URL isSandbox: type: boolean description: Is sandbox org isConnected: type: boolean description: Is org connected fetchStatus: enum: - fetching - initial_fetching - error - fetched - invalid_credentials type: string description: Fetch status lastFetchedAt: format: date-time type: string description: Last successful fetch timestamp createdAt: format: date-time type: string description: Creation timestamp updatedAt: format: date-time type: string description: Last update timestamp connectedUser: type: string description: Connected Salesforce username createdById: type: string description: User ID who created the org required: - id - name - isSandbox - isConnected - createdAt - updatedAt Data360OAuthDto: type: object properties: orgId: type: string description: Data 360 Org ID authCode: type: string description: OAuth authorization code isSandbox: type: boolean description: Is sandbox org example: false required: - orgId - authCode - isSandbox ClientCredentialsDto: type: object properties: clientId: type: string clientSecret: type: string required: - clientId RegisterServerDto: type: object properties: serverType: type: string maxLength: 255 pattern: /^[a-zA-Z0-9_-]+$/ serverUrl: type: string maxLength: 500 format: uri clientCredentials: $ref: '#/components/schemas/ClientCredentialsDto' required: - serverType OAuthCallbackDto: type: object properties: code: type: string required: - code ToolPolicyDto: type: object properties: name: type: string policy: type: string enum: - allowed - denied - needs_approval required: - name - policy UpdateToolPoliciesDto: type: object properties: toolPolicies: type: array items: $ref: '#/components/schemas/ToolPolicyDto' required: - toolPolicies LeadSubmissionDto: type: object properties: lead: type: object required: - lead BookSlotDto: type: object properties: startTime: type: string timezone: type: string required: - startTime - timezone UpdateIntegrationSettingsDto: type: object properties: calendarProvider: type: string enum: - google_calendar videoConferencingProvider: type: string enum: - zoom - google_meet SchedulingSubmissionLog: type: object properties: id: type: string crmOrgId: type: string crmOrg: $ref: '#/components/schemas/CrmOrg' sourceType: type: object sourceId: type: string email: type: string referrerUrl: type: string nullable: true status: type: object assignedToUserId: type: string nullable: true assignedToName: type: string nullable: true assignmentRuleType: type: string nullable: true crmRecordId: type: string nullable: true sessionToken: type: string nullable: true capturedData: type: object nullable: true errorMessage: type: string nullable: true createdAt: format: date-time type: string updatedAt: format: date-time type: string required: - id - crmOrgId - crmOrg - sourceType - sourceId - email - referrerUrl - status - assignedToUserId - assignedToName - assignmentRuleType - crmRecordId - sessionToken - capturedData - errorMessage - createdAt - updatedAt CreatePromptSectionDto: type: object properties: name: type: string prompts: type: array items: $ref: '#/components/schemas/CreatePromptDto' runMode: type: string enum: - individual - queue required: - name - prompts - runMode CreateArtifactSectionDto: type: object properties: name: type: string required: - name CreateTemplateFileRefDto: type: object properties: name: type: string extension: type: string enum: - txt - json - xml - csv - tsv - log - env - md - config - pdf - docx - png - jpg - jpeg - webp - avif fileName: type: string required: - name - extension - fileName CreateFileSectionDto: type: object properties: name: type: string files: maxItems: 20 type: array items: $ref: '#/components/schemas/CreateTemplateFileRefDto' required: - name CreateProjectDto: type: object properties: name: type: string description: type: string promptSections: type: array items: $ref: '#/components/schemas/CreatePromptSectionDto' artifactSections: type: array items: $ref: '#/components/schemas/CreateArtifactSectionDto' fileSections: type: array items: $ref: '#/components/schemas/CreateFileSectionDto' autonomyMode: type: string enum: - guided - balanced - autonomous originTemplateId: type: string enum: - blank - cpq-agentforce-revenue-management - process-builder-to-flow - profiles-permission-set-groups-migration - visualforce-aura-lwc-modernization - field-cleanup-hygiene - salesforce-winter-27-release-prep - ai-security-risk-remediation - product-catalog-rationalization - agentforce-readiness userInstructions: type: string systemInstructions: type: string required: - name DuplicateProjectDto: type: object properties: name: type: string mode: type: string enum: - playbook_only - with_conversations targetOrgId: type: string required: - name - mode UpdateProjectDto: type: object properties: name: type: string description: type: string visibility: type: string enum: - team - private autonomyMode: type: string nullable: true enum: - guided - balanced - autonomous ReorderSectionsDto: type: object properties: type: type: string enum: - prompts - artifacts - files sectionIds: maxItems: 100 type: array items: type: string format: uuid required: - type - sectionIds AddSectionDto: type: object properties: name: type: string type: type: string enum: - prompts - artifacts - files runMode: type: string enum: - individual - queue required: - name - type - runMode UpdateSectionDto: type: object properties: name: type: string runMode: type: string enum: - individual - queue AddSectionItemDto: type: object properties: promptTitle: type: string promptText: type: string mode: type: string enum: - none - artifactMode - researchMode - buildMode fileId: type: string format: uuid MoveItemDto: type: object properties: toSectionId: type: string format: uuid newIndex: type: number minimum: 0 required: - toSectionId - newIndex UpdateSectionItemDto: type: object properties: promptTitle: type: string promptText: type: string mode: type: string enum: - none - artifactMode - researchMode - buildMode ReorderItemsDto: type: object properties: itemIds: maxItems: 500 type: array items: type: string format: uuid required: - itemIds AddToMemoryDto: type: object properties: fileId: type: string format: uuid required: - fileId UpdateProjectToolsDto: type: object properties: name: type: string description: type: string instructions: type: string CreateProjectToolsSectionDto: type: object properties: name: type: string runMode: type: string enum: - individual - queue sortOrder: type: number minimum: 0 required: - name - runMode UpdateProjectToolsSectionDto: type: object properties: name: type: string sortOrder: type: number minimum: 0 CreateProjectToolsPromptDto: type: object properties: title: type: string body: type: string mode: type: string enum: - none - artifactMode - researchMode - buildMode sortOrder: type: number minimum: 0 required: - title - body - mode UpdateProjectToolsPromptDto: type: object properties: title: type: string body: type: string mode: type: string enum: - none - artifactMode - researchMode - buildMode ReorderProjectToolsPromptsDto: type: object properties: promptIds: maxItems: 500 type: array items: type: string format: uuid required: - promptIds UpdateFunnelMapMember: type: object properties: funnelId: type: string sectionId: type: string format: uuid row: type: number column: type: number required: - funnelId - sectionId - row - column UpdateRecordTypeMapMember: type: object properties: recordTypeName: type: string sectionId: type: string format: uuid objectName: type: string row: type: number column: type: number leadingFieldName: type: string required: - recordTypeName - sectionId - objectName - row - column - leadingFieldName UpdateHubspotFunnelMapMember: type: object properties: id: type: string sectionId: type: string format: uuid objectName: type: string leadingFieldName: type: string row: type: number column: type: number required: - id - sectionId - objectName - leadingFieldName - row - column UpdateThirdPartyFunnelMapMember: type: object properties: thirdPartyFunnelId: type: string sectionId: type: string format: uuid row: type: number column: type: number required: - thirdPartyFunnelId - sectionId - row - column UpdateMetadataElementMapMember: type: object properties: metadataId: type: string sectionId: type: string format: uuid crmOrgId: type: string row: type: number column: type: number funnelLinks: type: array items: $ref: '#/components/schemas/FunnelLinkDto' color: type: string icon: type: string required: - metadataId - sectionId - crmOrgId - row - column - funnelLinks FreePositionDto: type: object properties: x: type: number y: type: number required: - x - y UpdateStickyNote: type: object properties: stickyNoteId: type: string format: uuid sectionId: type: string format: uuid backgroundColor: type: string richText: type: string xyPosition: $ref: '#/components/schemas/FreePositionDto' width: type: number height: type: number textScale: type: number required: - stickyNoteId - sectionId - backgroundColor - richText - xyPosition - width - height - textScale UpdateText: type: object properties: textId: type: string format: uuid sectionId: type: string format: uuid richText: type: string xyPosition: $ref: '#/components/schemas/FreePositionDto' width: type: number height: type: number textScale: type: number required: - textId - sectionId - richText - xyPosition - width - height - textScale UpdateSection: type: object properties: sectionId: type: string format: uuid backgroundColor: type: string name: type: string xyPosition: $ref: '#/components/schemas/FreePositionDto' width: type: number height: type: number required: - sectionId - backgroundColor - name - xyPosition - width - height UpdateFunnelMapDto: type: object properties: version: type: number name: type: string defaultCrmOrgId: type: string funnels: type: array items: $ref: '#/components/schemas/UpdateFunnelMapMember' recordTypes: type: array items: $ref: '#/components/schemas/UpdateRecordTypeMapMember' hubspotFunnels: type: array items: $ref: '#/components/schemas/UpdateHubspotFunnelMapMember' thirdPartyFunnels: type: array items: $ref: '#/components/schemas/UpdateThirdPartyFunnelMapMember' metadataElements: type: array items: $ref: '#/components/schemas/UpdateMetadataElementMapMember' stickyNotes: type: array items: $ref: '#/components/schemas/UpdateStickyNote' texts: type: array items: $ref: '#/components/schemas/UpdateText' sections: type: array items: $ref: '#/components/schemas/UpdateSection' required: - version - name - defaultCrmOrgId - funnels CreateFunnelMapDto: type: object properties: name: type: string defaultCrmOrgId: type: string funnels: type: array items: $ref: '#/components/schemas/UpdateFunnelMapMember' recordTypes: type: array items: $ref: '#/components/schemas/UpdateRecordTypeMapMember' hubspotFunnels: type: array items: $ref: '#/components/schemas/UpdateHubspotFunnelMapMember' thirdPartyFunnels: type: array items: $ref: '#/components/schemas/UpdateThirdPartyFunnelMapMember' metadataElements: type: array items: $ref: '#/components/schemas/UpdateMetadataElementMapMember' stickyNotes: type: array items: $ref: '#/components/schemas/UpdateStickyNote' texts: type: array items: $ref: '#/components/schemas/UpdateText' sections: type: array items: $ref: '#/components/schemas/UpdateSection' required: - name - defaultCrmOrgId - funnels CreateAiProcessMiningFunnelsDto: type: object properties: objectName: type: string required: - objectName EnrichMetadataElementsRequestDto: type: object properties: targets: type: array items: type: object context: type: array items: type: object parentElementId: type: string commonChildId: type: string required: - targets PillStageDto: type: object properties: stageId: type: string stageName: type: string required: - stageId - stageName PillFunnelDto: type: object properties: id: type: string objectName: type: string leadingFieldName: type: string recordTypeId: type: string stages: type: array items: $ref: '#/components/schemas/PillStageDto' required: - id - objectName - leadingFieldName - recordTypeId - stages OrgPillFunnelsDto: type: object properties: crmOrgId: type: string funnels: type: array items: $ref: '#/components/schemas/PillFunnelDto' required: - crmOrgId - funnels CalculatePillsDto: type: object properties: items: type: array items: $ref: '#/components/schemas/OrgPillFunnelsDto' required: - items