Sweep

Sweep Automations API

The Automations API from Sweep — 43 operation(s) for automations.

GitHub OpenAPI

Operations 48

GET /automations #
POST /automations #
GET /automations/{automationId} #
DELETE /automations/{automationId} #
GET /automations/{automationId}/history #
POST /automations/read-only #
POST /automations/alerts #
POST /automations/marketing-attributions #
POST /automations/marketing-attributions/templates #
POST /automations/assignments #
POST /automations/dedupe-matching #
POST /automations/ai-create #
PUT /automations/{automationId}/{versionId} #
PUT /automations/alerts/{automationId}/{versionId} #
PUT /automations/marketing-attributions/{automationId}/{versionId} #
PUT /automations/assignments/{automationId}/{versionId} #
PUT /automations/dedupe-matching/{automationId}/{versionId} #
POST /automations/deployment/{automationId}/{versionId} #
POST /automations/alerts/deployment/{automationId}/{versionId} #
POST /automations/marketing-attributions/deployment/{automationId}/{versionId} #
POST /automations/assignments/deployment/{automationId}/{versionId} #
POST /automations/dedupe-matching/deployment/{automationId}/{versionId} #
POST /automations/ai-impact-analysis-chat #
POST /automations/assignments/ai-impact-analysis-chat #
PATCH /automations/activation/{automationId}/{versionId} #
PATCH /automations/alerts/activation/{automationId}/{versionId} #
PATCH /automations/assignments/activation/{automationId}/{versionId} #
PATCH /automations/dedupe-matching/activation/{automationId}/{versionId} #
PATCH /automations/admin-notification/{automationId}/{versionId} #
PATCH /automations/alerts/admin-notification/{automationId}/{versionId} #
PATCH /automations/assignments/admin-notification/{automationId}/{versionId} #
PATCH /automations/dedupe-matching/admin-notification/{automationId}/{versionId} #
DELETE /automations/alerts/{automationId} #
DELETE /automations/assignments/{automationId} #
DELETE /automations/marketing-attributions/{automationId} #
DELETE /automations/dedupe-matching/{automationId} #
POST /automations/booking #
PUT /automations/booking/{automationId}/{versionId} #
POST /automations/booking/deployment/{automationId}/{versionId} #
PATCH /automations/booking/activation/{automationId}/{versionId} #
DELETE /automations/booking/{automationId} #
PATCH /automations/booking/admin-notification/{automationId}/{versionId} #
GET /automations/order/Default #
POST /automations/order/Default #
GET /automations/order/Alert #
POST /automations/order/Alert #
GET /automations/order/Assignment #
POST /automations/order/Assignment #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-automations-api-openapi.yml

Other Resources

🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/conventions/sweep-conventions.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/errors/sweep-problem-types.yml

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/sweep-automations-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no email required.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sweep-automations-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Automations 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
tags:
- name: Automations
paths:
  /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
components:
  schemas:
    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
    FunnelRecordTypeDto:
      type: object
      properties:
        name:
          type: string
        objectName:
          type: string
        label:
          type: string
        description:
          type: string
      required:
      - name
      - objectName
      - label
      - description
    AutomationImmediateFieldReference:
      type: object
      properties:
        _leadingFieldId:
          type: string
        _leadingFieldLabels:
          type: array
          items:
            type: string
      required:
      - _leadingFieldId
      - _leadingFieldLabels
    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
    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
    CreateAutomationDto:
      type: object
      properties:
        name:
          type: string
        automationDetails:
          $ref: '#/components/schemas/AutomationDetailsWithFunnelIdDto'
        objectName:
          type: string
        type:
          enum:
          - Default
          - Assignment
          - Alert
          - Dedupe
          - Matching
          - Sched

# --- truncated at 32 KB (39 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/sweep/refs/heads/main/openapi/sweep-automations-api-openapi.yml