NudgeLink Messages API

The messages API from NudgeLink — 6 operation(s) for messages.

GitHub OpenAPI

Operations 6

GET /api/v1/messages/preview-queue Preview Queue #
POST /api/v1/messages/preview-queue/mark-seen Mark Preview Queue Seen #
GET /api/v1/messages/voice-metrics Voice Metrics #
GET /api/v1/messages/sequence/{sequence_id} List By Sequence #
POST /api/v1/messages/{message_id}/approve Approve Message #
POST /api/v1/messages/{message_id}/reject Reject Message #

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-messages-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-messages-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: NudgeLink Messages API
  version: 0.1.0
tags:
- name: Messages
paths:
  /api/v1/messages/preview-queue:
    get:
      tags:
      - Messages
      summary: Preview Queue
      operationId: preview_queue_api_v1_messages_preview_queue_get
      security:
      - HTTPBearer: []
      parameters:
      - name: limit
        in: query
        required: false
        schema:
          type: integer
          maximum: 200
          minimum: 1
          default: 50
          title: Limit
      - name: offset
        in: query
        required: false
        schema:
          type: integer
          minimum: 0
          default: 0
          title: Offset
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PreviewQueueResponse'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/messages/preview-queue/mark-seen:
    post:
      tags:
      - Messages
      summary: Mark Preview Queue Seen
      description: 'Bump the Preview-queue read cursor to now.


        Idempotent. Called by the frontend a few seconds after the page has

        rendered (debounced) — not on every 10s auto-refresh poll — so the "new"

        badge reflects messages the client hasn''t actually had a chance to see

        yet, the same way ``POST /inbox/conversations/{lead_id}/mark-read`` works

        for the inbox tab.'
      operationId: mark_preview_queue_seen_api_v1_messages_preview_queue_mark_seen_post
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MarkPreviewQueueSeenResponse'
      security:
      - HTTPBearer: []
  /api/v1/messages/voice-metrics:
    get:
      tags:
      - Messages
      summary: Voice Metrics
      description: 'Doc п.1 — positive-reply rate sliced by voice source.


        This is the metric the voice was previously tuned without. Heuristic: a

        sequence''s reply classification is attributed to every voice-tagged

        outbound message in that sequence — directional, not exact (a sequence has

        several touches), but enough to tell whether a voice moves replies.

        NULL-voice / legacy rows are excluded.'
      operationId: voice_metrics_api_v1_messages_voice_metrics_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                additionalProperties: true
                type: object
                title: Response Voice Metrics Api V1 Messages Voice Metrics Get
      security:
      - HTTPBearer: []
  /api/v1/messages/sequence/{sequence_id}:
    get:
      tags:
      - Messages
      summary: List By Sequence
      operationId: list_by_sequence_api_v1_messages_sequence__sequence_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: sequence_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Sequence Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessageOut'
                title: Response List By Sequence Api V1 Messages Sequence  Sequence Id  Get
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/messages/{message_id}/approve:
    post:
      tags:
      - Messages
      summary: Approve Message
      operationId: approve_message_api_v1_messages__message_id__approve_post
      security:
      - HTTPBearer: []
      parameters:
      - name: message_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Message Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ApproveMessageRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/messages/{message_id}/reject:
    post:
      tags:
      - Messages
      summary: Reject Message
      operationId: reject_message_api_v1_messages__message_id__reject_post
      security:
      - HTTPBearer: []
      parameters:
      - name: message_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Message Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/MessageOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    MessageOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        sequence_id:
          type: string
          format: uuid
          title: Sequence Id
        step:
          $ref: '#/components/schemas/OutreachStep'
        channel:
          $ref: '#/components/schemas/MessageChannel'
        direction:
          $ref: '#/components/schemas/MessageDirection'
        content:
          type: string
          title: Content
        subject:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject
        content_ai_original:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Ai Original
        message_angle:
          anyOf:
          - type: string
          - type: 'null'
          title: Message Angle
        classification:
          anyOf:
          - $ref: '#/components/schemas/MessageClassification'
          - type: 'null'
        preview_status:
          anyOf:
          - $ref: '#/components/schemas/MessagePreviewStatus'
          - type: 'null'
        preview_expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Preview Expires At
        sent_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Sent At
        sent_manually:
          type: boolean
          title: Sent Manually
        send_skipped:
          type: boolean
          title: Send Skipped
          default: false
        created_at:
          type: string
          format: date-time
          title: Created At
        external_url:
          anyOf:
          - type: string
          - type: 'null'
          title: External Url
        source_post_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Post Text
        source_post_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Post Url
      type: object
      required:
      - id
      - sequence_id
      - step
      - channel
      - direction
      - content
      - content_ai_original
      - message_angle
      - classification
      - preview_status
      - preview_expires_at
      - sent_at
      - sent_manually
      - created_at
      title: MessageOut
    OutreachStep:
      type: string
      enum:
      - pending
      - warmup_view
      - warmup_like
      - warmup_comment
      - linkedin_invite
      - linkedin_followup_1
      - linkedin_followup_2
      - email_1
      - email_2
      - completed
      title: OutreachStep
    MessageDirection:
      type: string
      enum:
      - outbound
      - inbound
      title: MessageDirection
    MarkPreviewQueueSeenResponse:
      properties:
        seen_at:
          type: string
          format: date-time
          title: Seen At
      type: object
      required:
      - seen_at
      title: MarkPreviewQueueSeenResponse
    MessageClassification:
      type: string
      enum:
      - positive
      - neutral
      - question
      - rejection
      - spam
      - unclassified
      title: MessageClassification
    MessageChannel:
      type: string
      enum:
      - linkedin
      - email
      title: MessageChannel
    ApproveMessageRequest:
      properties:
        edited_content:
          anyOf:
          - type: string
          - type: 'null'
          title: Edited Content
      type: object
      title: ApproveMessageRequest
    MessagePreviewStatus:
      type: string
      enum:
      - pending
      - approved
      - edited_and_approved
      - rejected
      - auto_sent
      - expired
      title: MessagePreviewStatus
    PreviewQueueResponse:
      properties:
        items:
          items:
            $ref: '#/components/schemas/PreviewMessageOut'
          type: array
          title: Items
        total:
          type: integer
          title: Total
        new_count:
          type: integer
          title: New Count
          default: 0
      type: object
      required:
      - items
      - total
      title: PreviewQueueResponse
    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
    PreviewMessageOut:
      properties:
        id:
          type: string
          format: uuid
          title: Id
        sequence_id:
          type: string
          format: uuid
          title: Sequence Id
        step:
          $ref: '#/components/schemas/OutreachStep'
        channel:
          $ref: '#/components/schemas/MessageChannel'
        direction:
          $ref: '#/components/schemas/MessageDirection'
        content:
          type: string
          title: Content
        subject:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject
        content_ai_original:
          anyOf:
          - type: string
          - type: 'null'
          title: Content Ai Original
        message_angle:
          anyOf:
          - type: string
          - type: 'null'
          title: Message Angle
        classification:
          anyOf:
          - $ref: '#/components/schemas/MessageClassification'
          - type: 'null'
        preview_status:
          anyOf:
          - $ref: '#/components/schemas/MessagePreviewStatus'
          - type: 'null'
        preview_expires_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Preview Expires At
        sent_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Sent At
        sent_manually:
          type: boolean
          title: Sent Manually
        send_skipped:
          type: boolean
          title: Send Skipped
          default: false
        created_at:
          type: string
          format: date-time
          title: Created At
        external_url:
          anyOf:
          - type: string
          - type: 'null'
          title: External Url
        source_post_text:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Post Text
        source_post_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Source Post Url
        lead_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Lead Id
        lead_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Lead Name
        lead_title:
          anyOf:
          - type: string
          - type: 'null'
          title: Lead Title
        lead_company:
          anyOf:
          - type: string
          - type: 'null'
          title: Lead Company
        lead_linkedin_url:
          anyOf:
          - type: string
          - type: 'null'
          title: Lead Linkedin Url
        campaign_id:
          anyOf:
          - type: string
            format: uuid
          - type: 'null'
          title: Campaign Id
        campaign_name:
          anyOf:
          - type: string
          - type: 'null'
          title: Campaign Name
      type: object
      required:
      - id
      - sequence_id
      - step
      - channel
      - direction
      - content
      - content_ai_original
      - message_angle
      - classification
      - preview_status
      - preview_expires_at
      - sent_at
      - sent_manually
      - created_at
      title: PreviewMessageOut
      description: 'A queue item plus who it is for (2026-10-12).


        The queue showed a draft with no recipient: the user was asked to approve a

        message to someone the page never named. These are read off the sequence''s

        lead (and the lead''s campaign), all optional so an older client ignores them.'
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer