How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
Sweep

Sweep Automations API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

Sweep Automations API is one of 70 APIs that Sweep publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Automations. The published artifact set on APIs.io includes an OpenAPI specification, an API reference, and authentication docs.

This API exposes 48 operations across 43 paths, and defines 24 schemas. It is described by OpenAPI 3.2.0, at version 0.1.

Requests are made against a single base URL, https://api.sweep.io.

48 operations 43 paths 24 schemas 6 DELETE6 GET10 PATCH20 POST6 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
0.1
Base URL
https://api.sweep.io
Authentication
HTTP Bearer
Resource Areas
1

Authentication & Security 1

Sweep Automations API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (JWT) (bearer).

Paths & Operations 48

Across 43 paths, the API surfaces 48 operations — 6 DELETE, 6 GET, 10 PATCH, 20 POST, 6 PUT. Each is listed below with its method, path, parameters, and response codes.

Automations 48
GET
/automations
AutomationController_getAutomations 2 params → 200
POST
/automations
AutomationController_createAutomation body → 201
GET
/automations/{automationId}
AutomationController_getAutomationById 3 params → 200
DELETE
/automations/{automationId}
AutomationController_deleteAutomation 1 param → 200
GET
/automations/{automationId}/history
AutomationController_getVersionHistory 1 param → 200
POST
/automations/read-only
AutomationController_createReadOnlyAutomation body → 201
POST
/automations/alerts
AutomationController_createAlert body → 201
POST
/automations/marketing-attributions
AutomationController_createMarketingAttribution body → 201
POST
/automations/marketing-attributions/templates
AutomationController_createMarketingAttributionTemplates body → 201
POST
/automations/assignments
AutomationController_createAssignment body → 201
POST
/automations/dedupe-matching
AutomationController_createDedupeOrMatching body → 201
POST
/automations/ai-create
AutomationController_createAutomationWithAi body → 201
PUT
/automations/{automationId}/{versionId}
AutomationController_editAutomation 2 params body → 200
PUT
/automations/alerts/{automationId}/{versionId}
AutomationController_editAlert 2 params body → 200
PUT
/automations/marketing-attributions/{automationId}/{versionId}
AutomationController_editMarketingAttribution 2 params body → 200
PUT
/automations/assignments/{automationId}/{versionId}
AutomationController_editAssignment 2 params body → 200
PUT
/automations/dedupe-matching/{automationId}/{versionId}
AutomationController_editDedupeOrMatching 2 params body → 200
POST
/automations/deployment/{automationId}/{versionId}
AutomationController_deployAutomation 2 params body → 201
POST
/automations/alerts/deployment/{automationId}/{versionId}
AutomationController_deployAlert 2 params body → 201
POST
/automations/marketing-attributions/deployment/{automationId}/{versionId}
AutomationController_deployMarketingAttribution 2 params body → 201
POST
/automations/assignments/deployment/{automationId}/{versionId}
AutomationController_deployAssignment 2 params body → 201
POST
/automations/dedupe-matching/deployment/{automationId}/{versionId}
AutomationController_deployDedupeOrMatching 2 params body → 201
POST
/automations/ai-impact-analysis-chat
AutomationController_createAutomationAiImpactAnalysisChat body → 201
POST
/automations/assignments/ai-impact-analysis-chat
AutomationController_createAssignmentAiImpactAnalysisChat body → 201
PATCH
/automations/activation/{automationId}/{versionId}
AutomationController_toggleActivation 2 params body → 200
PATCH
/automations/alerts/activation/{automationId}/{versionId}
AutomationController_toggleAlertActivation 2 params body → 200
PATCH
/automations/assignments/activation/{automationId}/{versionId}
AutomationController_toggleAssignmentActivation 2 params body → 200
PATCH
/automations/dedupe-matching/activation/{automationId}/{versionId}
AutomationController_toggleDedupeOrMatchingActivation 2 params body → 200
PATCH
/automations/admin-notification/{automationId}/{versionId}
AutomationController_notifyAdminOnAutomation 2 params body → 200
PATCH
/automations/alerts/admin-notification/{automationId}/{versionId}
AutomationController_notifyAdminOnAlert 2 params body → 200
PATCH
/automations/assignments/admin-notification/{automationId}/{versionId}
AutomationController_notifyAdminOnAssignment 2 params body → 200
PATCH
/automations/dedupe-matching/admin-notification/{automationId}/{versionId}
AutomationController_notifyAdminOnDedupeOrMatching 2 params body → 200
DELETE
/automations/alerts/{automationId}
AutomationController_deleteAlert 1 param → 200
DELETE
/automations/assignments/{automationId}
AutomationController_deleteAssignment 1 param → 200
DELETE
/automations/marketing-attributions/{automationId}
AutomationController_deleteMarketingAttribution 1 param → 200
DELETE
/automations/dedupe-matching/{automationId}
AutomationController_deleteDedupeOrMatching 1 param → 200
POST
/automations/booking
AutomationController_createBooking body → 201
PUT
/automations/booking/{automationId}/{versionId}
AutomationController_editBooking 2 params body → 200
POST
/automations/booking/deployment/{automationId}/{versionId}
AutomationController_deployBooking 2 params body → 201
PATCH
/automations/booking/activation/{automationId}/{versionId}
AutomationController_toggleBookingActivation 2 params body → 200
DELETE
/automations/booking/{automationId}
AutomationController_deleteBooking 1 param → 200
PATCH
/automations/booking/admin-notification/{automationId}/{versionId}
AutomationController_notifyAdminOnBooking 2 params body → 200
GET
/automations/order/Default
AutomationController_listAutomationsExecutionOrder 6 params → 200
POST
/automations/order/Default
AutomationController_deployAutomationsExecutionOrder body → 201
GET
/automations/order/Alert
AutomationController_listAlertsExecutionOrder 6 params → 200
POST
/automations/order/Alert
AutomationController_deployAlertsExecutionOrder body → 201
GET
/automations/order/Assignment
AutomationController_listAssignmentsExecutionOrder 6 params → 200
POST
/automations/order/Assignment
AutomationController_deployAssignmentsExecutionOrder body → 201

Schemas 24

The contract defines 24 schemas that model the data the API accepts and returns. The most detailed are AutomationDto (19 properties), AutomationDetailsWithFunnelIdDto (9 properties), AutomationParams (6 properties), AutomationSchedule (5 properties). Each schema is shown below with its type and property counts.

AutomationTriggerDateArrives
object
4 properties 2 required
FunnelRecordTypeDto
object
4 properties 4 required
AutomationImmediateFieldReference
object
2 properties 2 required
AutomationSchedule
object
5 properties 3 required
AutomationParamsFieldUpdate
object
5 properties 3 required
CreateAutomationDto
object
5 properties 3 required
UpdateAutomationDto
object
2 properties 2 required
AdminNotificationDto
object
1 property
AutomationRecordTypeRef
object
2 properties 2 required
CreateAutomationOrderHintDto
object
2 properties 1 required
AutomationTriggerTimeInStep
object
3 properties 3 required
AutomationActivationDto
object
3 properties 2 required
DelayActionsParams
object
3 properties 2 required
AutomationTriggerStageTransitionParams
object
2 properties
AutomationDto
object
19 properties 16 required
AutoTemplatesStructDto
object
2 properties 2 required
AutomationParams
object
6 properties
SweepCondition
object
2 properties 2 required
AutomationDetailsWithFunnelIdDto
object
9 properties 3 required
DeployAutomationDto
object
2 properties 1 required
OptionalCondition
object
2 properties
AutomationParamsStageReference
object
2 properties 2 required
AiChatDto
object
4 properties 4 required
CreateAutomationWithAiDto
object
1 property 1 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

sweep-automations-api-openapi.yml Raw ↑

Other APIs Sweep publishes across the network.

Sweep MCP Server
AE Profile APIs.io
Sweep Account Selection API
AE Profile APIs.io
Sweep Agentic Features API
AE Profile APIs.io
Sweep Ai Agents API
AE Profile APIs.io
Sweep AI Artifacts (unauthenticated) API
AE Profile APIs.io
Sweep AI Attachments API
AE Profile APIs.io
Sweep AI Prompts API
AE Profile APIs.io
Sweep AI Retrievers API
AE Profile APIs.io
Sweep AI Session API
AE Profile APIs.io
Sweep AI Stream API
AE Profile APIs.io
Sweep AI User Skills API
AE Profile APIs.io
Sweep Assignment Groups API
AE Profile APIs.io
#Automations
← Back to S APIs
API Details
ID
sweep:sweep-automations-api
Base URL
https://api.sweep.io
Docs
https://api.sweep.io/api
Provider
Sweep
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=sweep-automations-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/sweep-automations-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

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

Where this information came from

This is an independent, third-party profile of Sweep Automations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.