NudgeLink Campaigns API

The campaigns API from NudgeLink — 9 operation(s) for campaigns.

GitHub OpenAPI

Operations 11

GET /api/v1/campaigns List Campaigns #
POST /api/v1/campaigns Create Campaign #
GET /api/v1/campaigns/{campaign_id} Get Campaign #
PATCH /api/v1/campaigns/{campaign_id} Update Campaign #
GET /api/v1/campaigns/{campaign_id}/replies.csv Export Replies #
POST /api/v1/campaigns/{campaign_id}/assign-leads Assign Leads #
POST /api/v1/campaigns/{campaign_id}/unassign-leads Unassign Leads #
GET /api/v1/campaigns/{campaign_id}/start-preview Start Preview #
POST /api/v1/campaigns/{campaign_id}/start Start Campaign #
POST /api/v1/campaigns/{campaign_id}/pause Pause Campaign #
POST /api/v1/campaigns/{campaign_id}/resume Resume Campaign #

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/nudgelink-co:nudgelink-co-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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

OpenAPI Specification

nudgelink-co-campaigns-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Campaigns API
  version: 0.1.0
tags:
- name: Campaigns
paths:
  /api/v1/campaigns:
    get:
      tags:
      - Campaigns
      summary: List Campaigns
      operationId: list_campaigns_api_v1_campaigns_get
      security:
      - HTTPBearer: []
      parameters:
      - name: include_archived
        in: query
        required: false
        schema:
          type: boolean
          default: false
          title: Include Archived
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/CampaignOut'
                title: Response List Campaigns Api V1 Campaigns Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    post:
      tags:
      - Campaigns
      summary: Create Campaign
      operationId: create_campaign_api_v1_campaigns_post
      security:
      - HTTPBearer: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignCreate'
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}:
    get:
      tags:
      - Campaigns
      summary: Get Campaign
      operationId: get_campaign_api_v1_campaigns__campaign_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - Campaigns
      summary: Update Campaign
      operationId: update_campaign_api_v1_campaigns__campaign_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CampaignUpdate'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CampaignOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}/replies.csv:
    get:
      tags:
      - Campaigns
      summary: Export Replies
      description: 'Who replied in this campaign: name, LinkedIn link, sentiment, last reply.'
      operationId: export_replies_api_v1_campaigns__campaign_id__replies_csv_get
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}/assign-leads:
    post:
      tags:
      - Campaigns
      summary: Assign Leads
      description: 'Bulk-assign the client''s leads to this campaign. Leads already in

        another campaign are moved (one campaign per lead by design).'
      operationId: assign_leads_api_v1_campaigns__campaign_id__assign_leads_post
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignLeadsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignLeadsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}/unassign-leads:
    post:
      tags:
      - Campaigns
      summary: Unassign Leads
      operationId: unassign_leads_api_v1_campaigns__campaign_id__unassign_leads_post
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/AssignLeadsRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AssignLeadsResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}/start-preview:
    get:
      tags:
      - Campaigns
      summary: Start Preview
      operationId: start_preview_api_v1_campaigns__campaign_id__start_preview_get
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartPreviewResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}/start:
    post:
      tags:
      - Campaigns
      summary: Start Campaign
      description: 'Start outreach sequences for every campaign lead that doesn''t have one.


        Reuses the sequence-start machinery (api/sequences.start_sequences_for_leads)

        so mode selection, account pinning, and lead status transitions stay in one

        place. Paused campaigns are resumed implicitly on start (matches the UI''s

        single Start button semantics).'
      operationId: start_campaign_api_v1_campaigns__campaign_id__start_post
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/StartCampaignResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}/pause:
    post:
      tags:
      - Campaigns
      summary: Pause Campaign
      description: 'Pause the campaign and every ACTIVE sequence of its leads. Marked with

        a dedicated pause_reason so resume only touches what pause did.'
      operationId: pause_campaign_api_v1_campaigns__campaign_id__pause_post
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PauseCampaignResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/campaigns/{campaign_id}/resume:
    post:
      tags:
      - Campaigns
      summary: Resume Campaign
      description: 'Resume the campaign: un-pause ONLY the sequences the campaign pause

        itself paused (pause_reason marker) — a lead the client paused manually

        stays paused.'
      operationId: resume_campaign_api_v1_campaigns__campaign_id__resume_post
      security:
      - HTTPBearer: []
      parameters:
      - name: campaign_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Campaign Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResumeCampaignResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    CampaignCreate:
      properties:
        name:
          type: string
          maxLength: 255
          minLength: 1
          title: Name
        instruction_note:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Instruction Note
        icp_override:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Icp Override
        account_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Account Ids
        outreach_objective:
          anyOf:
          - $ref: '#/components/schemas/OutreachObjective'
          - type: 'null'
        style_profile:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Style Profile
        languages:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Languages
      type: object
      required:
      - name
      title: CampaignCreate
    StartCampaignResponse:
      properties:
        started:
          type: integer
          title: Started
        skipped_existing:
          type: integer
          title: Skipped Existing
        skipped_not_new:
          type: integer
          title: Skipped Not New
          default: 0
        skipped_already_contacted:
          type: integer
          title: Skipped Already Contacted
          default: 0
      type: object
      required:
      - started
      - skipped_existing
      title: StartCampaignResponse
    OutreachStats:
      properties:
        invites:
          $ref: '#/components/schemas/InviteStats'
        replies:
          $ref: '#/components/schemas/ReplyStats'
        comments_sent:
          type: integer
          title: Comments Sent
          default: 0
      type: object
      title: OutreachStats
    StartPreviewResponse:
      properties:
        to_start:
          items:
            $ref: '#/components/schemas/StartPreviewPerson'
          type: array
          title: To Start
        skipped_already_contacted:
          items:
            $ref: '#/components/schemas/StartPreviewPerson'
          type: array
          title: Skipped Already Contacted
        skipped_not_new:
          type: integer
          title: Skipped Not New
      type: object
      required:
      - to_start
      - skipped_already_contacted
      - skipped_not_new
      title: StartPreviewResponse
      description: 'Who "Start outreach" will start, and who it will skip and why — shown in a

        confirm step before anything is sent (Yarik 2026-10-03: a person who had

        said no was re-sequenced and nobody could see it coming).'
    OutreachObjective:
      type: string
      enum:
      - adaptive
      - conversation
      - problem_discovery
      - offer
      title: OutreachObjective
      description: 'The job the FIRST substantive message should accomplish

        (Outreach Objective Layer spec, 2026-07-20). A layer ABOVE the Voice

        Engine — it controls the message''s goal and CTA, never the voice.


        ``adaptive`` = NudgeLink resolves the concrete objective per lead from

        fit (relevance_score), intent (intent_score) and signals; the other three

        are the resolvable concrete objectives. Deliberately NOT a 1/2/3 scale —

        these are different jobs, not different aggressiveness levels. Member names

        equal their values (house convention) so SAEnum name/value storage agrees.'
    CampaignOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        name:
          type: string
          title: Name
        status:
          type: string
          title: Status
        instruction_note:
          anyOf:
          - type: string
          - type: 'null'
          title: Instruction Note
        icp_override:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Icp Override
        account_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Account Ids
        created_at:
          type: string
          format: date-time
          title: Created At
        stats:
          $ref: '#/components/schemas/CampaignStats'
        outreach_objective:
          anyOf:
          - $ref: '#/components/schemas/OutreachObjective'
          - type: 'null'
        resolved_outreach_objective:
          $ref: '#/components/schemas/OutreachObjective'
        outreach_objective_source:
          type: string
          title: Outreach Objective Source
        style_profile:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Style Profile
        languages:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Languages
        email_mode:
          type: string
          title: Email Mode
          default: 'off'
        mailbox_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Mailbox Id
      type: object
      required:
      - id
      - name
      - status
      - instruction_note
      - icp_override
      - account_ids
      - created_at
      - stats
      - outreach_objective
      - resolved_outreach_objective
      - outreach_objective_source
      - style_profile
      - languages
      title: CampaignOut
    AssignLeadsRequest:
      properties:
        lead_ids:
          items:
            type: string
            format: uuid
          type: array
          maxItems: 500
          minItems: 1
          title: Lead Ids
      type: object
      required:
      - lead_ids
      title: AssignLeadsRequest
    CampaignStats:
      properties:
        leads_total:
          type: integer
          title: Leads Total
        leads_by_status:
          additionalProperties:
            type: integer
          type: object
          title: Leads By Status
        active_sequences:
          type: integer
          title: Active Sequences
        replied:
          type: integer
          title: Replied
        startable:
          type: integer
          title: Startable
          default: 0
        pending_approvals:
          type: integer
          title: Pending Approvals
          default: 0
        outreach:
          anyOf:
          - $ref: '#/components/schemas/OutreachStats'
          - type: 'null'
      type: object
      required:
      - leads_total
      - leads_by_status
      - active_sequences
      - replied
      title: CampaignStats
    ReplyStats:
      properties:
        dms_sent:
          type: integer
          title: Dms Sent
          default: 0
        emails_sent:
          type: integer
          title: Emails Sent
          default: 0
        contacted:
          type: integer
          title: Contacted
          default: 0
        replied:
          type: integer
          title: Replied
          default: 0
        reply_rate_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Reply Rate Pct
        positive:
          type: integer
          title: Positive
          default: 0
        neutral:
          type: integer
          title: Neutral
          default: 0
        negative:
          type: integer
          title: Negative
          default: 0
        unclassified:
          type: integer
          title: Unclassified
          default: 0
        silent:
          type: integer
          title: Silent
          default: 0
      type: object
      title: ReplyStats
      description: 'Messages sent and what came back.


        ``contacted`` counts SEQUENCES (people) reached by any substantive step, not

        messages — an invite plus two follow-ups to one lead is one person.

        ``silent`` is the complement, so

        positive + neutral + negative + unclassified + silent == contacted.'
    InviteStats:
      properties:
        sent:
          type: integer
          title: Sent
          default: 0
        with_note:
          type: integer
          title: With Note
          default: 0
        without_note:
          type: integer
          title: Without Note
          default: 0
        accepted:
          type: integer
          title: Accepted
          default: 0
        accepted_with_note:
          type: integer
          title: Accepted With Note
          default: 0
        accepted_without_note:
          type: integer
          title: Accepted Without Note
          default: 0
        declined:
          type: integer
          title: Declined
          default: 0
        unknown:
          type: integer
          title: Unknown
          default: 0
        judged:
          type: integer
          title: Judged
          default: 0
        judged_with_note:
          type: integer
          title: Judged With Note
          default: 0
        judged_without_note:
          type: integer
          title: Judged Without Note
          default: 0
        accept_rate_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Accept Rate Pct
        accept_rate_with_note_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Accept Rate With Note Pct
        accept_rate_without_note_pct:
          anyOf:
          - type: number
          - type: 'null'
          title: Accept Rate Without Note Pct
      type: object
      title: InviteStats
      description: "Connection requests. ``*_pct`` are None (never 0.0) on an empty base.\n\nTHREE outcomes, not two (added 2026-08-07 after the first production\nbackfill). An invite we sent is in exactly one of:\n\n  * **accepted**  — ``invite_accepted_at`` is stamped.\n  * **declined**  — we looked AFTER inviting and they are still not a\n    connection. \"Declined\" is shorthand: it also covers ignored.\n  * **unknown**   — we have no observation since the invite went out.\n\nThat third bucket is not a technicality. Relationship distance is only\nrefreshed by the DM gate, which runs when a sequence reaches\n``linkedin_followup_1``; ``warmup_view``'s blob is written BEFORE the invite\nand carries no timestamp at all. So a lead whose follow-up is still sitting\nin the preview queue has never been re-checked, and folding those into the\ndenominator reports them as rejections.\n\nThe first prod run showed exactly that: 379 invites, 376 \"not 1st-degree\",\nan 0.8% accept rate. Real cold-invite accept rates are 15-40%. Nearly all of\nthat 376 was \"we never looked\", and dividing by it would have put a\ncatastrophic-looking number in front of clients.\n\nSo ``accept_rate_pct`` divides by **accepted + declined** — what we actually\nknow — and ``unknown`` is reported alongside so the number can be read with\nits own confidence attached. The bucket shrinks toward zero once PR 2's\n``relation.new`` webhook lands, which is the real fix."
    CampaignUpdate:
      properties:
        name:
          anyOf:
          - type: string
            maxLength: 255
            minLength: 1
          - type: 'null'
          title: Name
        instruction_note:
          anyOf:
          - type: string
            maxLength: 2000
          - type: 'null'
          title: Instruction Note
        icp_override:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Icp Override
        account_ids:
          anyOf:
          - items:
              type: string
              format: uuid
            type: array
          - type: 'null'
          title: Account Ids
        status:
          anyOf:
          - type: string
          - type: 'null'
          title: Status
        outreach_objective:
          anyOf:
          - $ref: '#/components/schemas/OutreachObjective'
          - type: 'null'
        style_profile:
          anyOf:
          - additionalProperties: true
            type: object
          - type: 'null'
          title: Style Profile
        languages:
          anyOf:
          - items:
              type: string
            type: array
          - type: 'null'
          title: Languages
        email_mode:
          anyOf:
          - type: string
            enum:
            - 'off'
            - first
            - parallel
            - after
          - type: 'null'
          title: Email Mode
        mailbox_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Mailbox Id
      type: object
      title: CampaignUpdate
    ResumeCampaignResponse:
      properties:
        resumed_sequences:
          type: integer
          title: Resumed Sequences
      type: object
      required:
      - resumed_sequences
      title: ResumeCampaignResponse
    AssignLeadsResponse:
      properties:
        assigned:
          type: integer
          title: Assigned
      type: object
      required:
      - assigned
      title: AssignLeadsResponse
    StartPreviewPerson:
      properties:
        lead_id:
          type: string
          format: uuid
          title: Lead Id
        name:
          type: string
          title: Name
        linkedin_url:
          type: string
          title: Linkedin Url
      type: object
      required:
      - lead_id
      - name
      - linkedin_url
      title: StartPreviewPerson
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    PauseCampaignResponse:
      properties:
        paused_sequences:
          type: integer
          title: Paused Sequences
      type: object
      required:
      - paused_sequences
      title: PauseCampaignResponse
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer