NudgeLink Inbox API
The inbox API from NudgeLink — 5 operation(s) for inbox.
The inbox API from NudgeLink — 5 operation(s) for inbox.
Every API here is available over the APIs.io API and to AI agents over MCP.
One button, every client — Claude, Cursor, VS Code and the rest.
https://apis.io/mcp
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.curl "https://apis.io/api/v1/apis/nudgelink-co:nudgelink-co-inbox-api"
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.
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: 3.2.0
info:
title: NudgeLink Inbox API
version: 0.1.0
tags:
- name: inbox
paths:
/api/v1/inbox/conversations:
get:
tags:
- inbox
summary: List Conversations
description: 'List conversations for the current client.
A conversation = one lead with at least one INBOUND message. Sorted
by last-message timestamp, newest first.
A6 unread semantics:
* ``unread_total`` is GLOBAL (all conversations, not just this page).
* ``unread_only=true`` filters in SQL BEFORE pagination — pages can
no longer come back empty while unread conversations exist deeper.
* ``total`` = all conversations normally; = unread conversations when
``unread_only`` is set.
Implementation: one query pulls every inbound (lead_id, created_at) for
the client, and the per-lead cursor comparison happens in Python. Exact,
single round-trip, and fine at pilot scale (inbound volume is small); at
~thousands of inbound rows move the cursor map to a real table and do the
anti-join in SQL (see plan A6 "real fix").'
operationId: list_conversations_api_v1_inbox_conversations_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
- name: unread_only
in: query
required: false
schema:
type: boolean
default: false
title: Unread Only
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/InboxConversationListResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/inbox/conversations/{lead_id}:
get:
tags:
- inbox
summary: Get Conversation
description: 'Full message thread for a lead.
Does NOT mark the conversation as read - that''s a separate POST
so refreshing the page doesn''t silently swallow unread state. The
UI calls /mark-read explicitly on user interaction.'
operationId: get_conversation_api_v1_inbox_conversations__lead_id__get
security:
- HTTPBearer: []
parameters:
- name: lead_id
in: path
required: true
schema:
type: string
format: uuid
title: Lead Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/InboxThreadResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/inbox/conversations/{lead_id}/mark-read:
post:
tags:
- inbox
summary: Mark Conversation Read
description: 'Set the inbox read cursor for ``lead_id`` to ``now``.
Idempotent. Returns the new cursor + zero unread.'
operationId: mark_conversation_read_api_v1_inbox_conversations__lead_id__mark_read_post
security:
- HTTPBearer: []
parameters:
- name: lead_id
in: path
required: true
schema:
type: string
format: uuid
title: Lead Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/MarkReadResponse'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/inbox/conversations/{lead_id}/reply:
post:
tags:
- inbox
summary: Reply To Conversation
description: 'Send a manual reply via the LinkedIn adapter.
The outbound Message row is inserted regardless of adapter
success - if Unipile errors, ``sent_at`` stays NULL so the UI
can show "failed to send" and the user can retry.'
operationId: reply_to_conversation_api_v1_inbox_conversations__lead_id__reply_post
security:
- HTTPBearer: []
parameters:
- name: lead_id
in: path
required: true
schema:
type: string
format: uuid
title: Lead Id
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/ReplyRequest'
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/InboxMessageOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
/api/v1/inbox/conversations/{lead_id}/draft-reply:
post:
tags:
- inbox
summary: Draft Reply
description: 'Draft an answer to the lead''s latest positive/question reply.
Text only: no Message row is written and nothing is sent. The client edits
the draft in the composer and sends it through ``reply_to_conversation``.'
operationId: draft_reply_api_v1_inbox_conversations__lead_id__draft_reply_post
security:
- HTTPBearer: []
parameters:
- name: lead_id
in: path
required: true
schema:
type: string
format: uuid
title: Lead Id
responses:
'200':
description: Successful Response
content:
application/json:
schema:
$ref: '#/components/schemas/DraftReplyOut'
'422':
description: Validation Error
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
components:
schemas:
DraftReplyOut:
properties:
draft:
type: string
title: Draft
used_booking_link:
type: boolean
title: Used Booking Link
type: object
required:
- draft
- used_booking_link
title: DraftReplyOut
InboxConversationListResponse:
properties:
items:
items:
$ref: '#/components/schemas/InboxConversationRow'
type: array
title: Items
total:
type: integer
title: Total
unread_total:
type: integer
title: Unread Total
type: object
required:
- items
- total
- unread_total
title: InboxConversationListResponse
InboxMessageOut:
properties:
id:
type: string
format: uuid
title: Id
direction:
type: string
title: Direction
channel:
type: string
title: Channel
content:
type: string
title: Content
classification:
anyOf:
- type: string
- type: 'null'
title: Classification
sent_at:
anyOf:
- type: string
format: date-time
- type: 'null'
title: Sent At
created_at:
type: string
format: date-time
title: Created At
sent_manually:
type: boolean
title: Sent Manually
send_skipped:
type: boolean
title: Send Skipped
default: false
step:
anyOf:
- type: string
- type: 'null'
title: Step
delivery_status:
type: string
title: Delivery Status
default: pending
invite_note_rejected:
type: boolean
title: Invite Note Rejected
default: false
type: object
required:
- id
- direction
- channel
- content
- classification
- sent_at
- created_at
- sent_manually
title: InboxMessageOut
ReplyRequest:
properties:
content:
type: string
maxLength: 8000
minLength: 1
title: Content
type: object
required:
- content
title: ReplyRequest
InboxConversationRow:
properties:
lead_id:
type: string
format: uuid
title: Lead Id
name:
type: string
title: Name
title:
type: string
title: Title
company:
type: string
title: Company
linkedin_url:
type: string
title: Linkedin Url
lead_status:
type: string
title: Lead Status
last_message_preview:
type: string
title: Last Message Preview
last_message_direction:
type: string
title: Last Message Direction
last_message_at:
type: string
format: date-time
title: Last Message At
unread_count:
type: integer
title: Unread Count
total_inbound:
type: integer
title: Total Inbound
last_inbound_classification:
anyOf:
- type: string
- type: 'null'
title: Last Inbound Classification
type: object
required:
- lead_id
- name
- title
- company
- linkedin_url
- lead_status
- last_message_preview
- last_message_direction
- last_message_at
- unread_count
- total_inbound
- last_inbound_classification
title: InboxConversationRow
description: One row in the conversation list (sidebar).
InboxThreadResponse:
properties:
lead_id:
type: string
format: uuid
title: Lead Id
name:
type: string
title: Name
title:
type: string
title: Title
company:
type: string
title: Company
location:
type: string
title: Location
linkedin_url:
type: string
title: Linkedin Url
lead_status:
type: string
title: Lead Status
sequence_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Sequence Id
sequence_status:
anyOf:
- type: string
- type: 'null'
title: Sequence Status
sent_from_account:
anyOf:
- type: string
- type: 'null'
title: Sent From Account
sent_from_account_id:
anyOf:
- type: string
format: uuid
- type: 'null'
title: Sent From Account Id
messages:
items:
$ref: '#/components/schemas/InboxMessageOut'
type: array
title: Messages
type: object
required:
- lead_id
- name
- title
- company
- location
- linkedin_url
- lead_status
- sequence_id
- sequence_status
- sent_from_account
- sent_from_account_id
- messages
title: InboxThreadResponse
MarkReadResponse:
properties:
lead_id:
type: string
format: uuid
title: Lead Id
read_cursor:
type: string
format: date-time
title: Read Cursor
unread_count:
type: integer
title: Unread Count
type: object
required:
- lead_id
- read_cursor
- unread_count
title: MarkReadResponse
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
securitySchemes:
HTTPBearer:
type: http
scheme: bearer