Sweep

Sweep Campaigns API

The Campaigns API from Sweep — 7 operation(s) for campaigns.

GitHub OpenAPI
Business capability
Demand Generation Management BC-400.40

Operations 10

GET /campaigns Campaigns controller get campaigns #
POST /campaigns Campaigns controller write campaign #
GET /campaigns/campaign-member-status/{campaignId} Campaigns controller get campaign member status of campaign #
DELETE /campaigns/campaign-member-status/{campaignId} Campaigns controller delete campaign member status #
PATCH /campaigns/campaign/{campaignId} Campaigns controller upsert campaign #
DELETE /campaigns/campaign/{campaignId} Campaigns controller delete campaign #
GET /campaigns/all-campaign-member-status Campaigns controller get all campaign member status #
POST /campaigns/campaign-member-status Campaigns controller add campaign member status to campaign #
PATCH /campaigns/campaign-member-status/{campaignMemberStatusId} Campaigns controller update campaign member status #
GET /campaigns/fields Campaigns controller get field names for campaigns #

Documentation

📖
APIReference
https://api.sweep.io/api
📖
Authentication
https://artifacts.apis.io/sweep/authentication/sweep-authentication.yml

Specifications

⚙
OpenAPI
https://artifacts.apis.io/sweep/openapi/sweep-campaigns-api-openapi.yml

Other Resources

🔗
Conventions
https://artifacts.apis.io/sweep/conventions/sweep-conventions.yml
🔗
DataModel
https://artifacts.apis.io/sweep/data-model/sweep-data-model.yml
🔗
ErrorCatalog
https://artifacts.apis.io/sweep/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:sweep-campaigns-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

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

OpenAPI Specification

sweep-campaigns-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Sweep Campaigns 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: Campaigns
paths:
  /campaigns:
    get:
      operationId: CampaignsController_getCampaigns
      parameters: []
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
      security:
      - bearer: []
      tags:
      - Campaigns
      summary: Campaigns controller get campaigns
      x-summary-source: derived
    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
      summary: Campaigns controller write campaign
      x-summary-source: derived
  /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
      summary: Campaigns controller get campaign member status of campaign
      x-summary-source: derived
    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
      summary: Campaigns controller delete campaign member status
      x-summary-source: derived
  /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
      summary: Campaigns controller upsert campaign
      x-summary-source: derived
    delete:
      operationId: CampaignsController_deleteCampaign
      parameters:
      - name: campaignId
        required: true
        in: path
        schema:
          type: string
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Campaigns
      summary: Campaigns controller delete campaign
      x-summary-source: derived
  /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
      summary: Campaigns controller get all campaign member status
      x-summary-source: derived
  /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
      summary: Campaigns controller add campaign member status to campaign
      x-summary-source: derived
  /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
      summary: Campaigns controller update campaign member status
      x-summary-source: derived
  /campaigns/fields:
    get:
      operationId: CampaignsController_getFieldNamesForCampaigns
      parameters: []
      responses:
        '200':
          description: ''
      security:
      - bearer: []
      tags:
      - Campaigns
      summary: Campaigns controller get field names for campaigns
      x-summary-source: derived
components:
  schemas:
    WriteCampaignDto:
      type: object
      properties: {}
    CampaignDto:
      type: object
      properties: {}
    WriteCampaignMemberStatusDto:
      type: object
      properties: {}
    ReplaceStatusDto:
      type: object
      properties: {}
    CampaignMemberStatus:
      type: object
      properties: {}
    UpdateCampaignMemberStatusDto:
      type: object
      properties: {}
  securitySchemes:
    bearer:
      scheme: bearer
      bearerFormat: JWT
      type: http