Neuron Scheduled Messages API
Schedule messages for future delivery, update, and cancel
Schedule messages for future delivery, update, and cancel
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/neuron-ng:neuron-ng-scheduled-messages-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: Neuron Scheduled Messages API
version: 1.0.0
description: 'API reference for Neuron — the AI-powered WhatsApp chatbot platform.
Neuron lets you build intelligent chatbots with tool integrations, knowledge bases, and human-in-the-loop monitoring.
## Authentication
Most endpoints require a JWT bearer token obtained from `POST /auth/login`.
Bot API endpoints use API keys prefixed with `nrn_`.
The **Social API** (`/social`) is organization-scoped — authenticate with an **account token** (`nrn_acc_`, from Dashboard → Settings → Account Tokens). Bot API keys are also accepted for backward compatibility but are legacy for this API.
## Response Format
All responses follow the envelope: `{ success: boolean, data?: any, error?: { message, code } }`'
servers:
- url: /api/v1
description: API v1
tags:
- name: Scheduled Messages
description: Schedule messages for future delivery, update, and cancel
paths:
/scheduled-messages:
post:
tags:
- Scheduled Messages
summary: Create a scheduled message
security:
- BearerAuth: []
requestBody:
content:
application/json:
schema:
type: object
required:
- to
- message
- sendAt
properties:
botId:
type: string
format: uuid
channelId:
type: string
format: uuid
to:
type: string
message:
type: string
messageType:
type: string
enum:
- text
- image
- audio
- video
- document
mediaUrl:
type: string
format: uri
contactName:
type: string
sendAt:
type: string
format: date-time
description: ISO 8601 future date-time for delivery
required: true
responses:
'201':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: '#/components/schemas/ScheduledMessage'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: postScheduledMessages
x-operation-id-source: derived
get:
tags:
- Scheduled Messages
summary: List scheduled messages
security:
- BearerAuth: []
parameters:
- name: status
in: query
schema:
type: string
description: Filter by status (scheduled, sent, failed, cancelled)
- name: page
in: query
schema:
type: string
description: Page
- name: limit
in: query
schema:
type: string
description: Limit
responses:
'200':
description: Paginated list
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/ScheduledMessage'
total:
type: integer
page:
type: integer
limit:
type: integer
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: getScheduledMessages
x-operation-id-source: derived
/scheduled-messages/{id}:
get:
tags:
- Scheduled Messages
summary: Get a scheduled message
security:
- BearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: ''
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: '#/components/schemas/ScheduledMessage'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: getScheduledMessagesById
x-operation-id-source: derived
put:
tags:
- Scheduled Messages
summary: Update a scheduled message
security:
- BearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: ''
description: Update message content or send time. Only messages with status 'scheduled' can be updated.
requestBody:
content:
application/json:
schema:
type: object
properties:
message:
type: string
messageType:
type: string
mediaUrl:
type:
- string
- 'null'
format: uri
contactName:
type: string
sendAt:
type: string
format: date-time
required: true
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: '#/components/schemas/ScheduledMessage'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: putScheduledMessagesById
x-operation-id-source: derived
delete:
tags:
- Scheduled Messages
summary: Cancel a scheduled message
security:
- BearerAuth: []
parameters:
- name: id
in: path
required: true
schema:
type: string
format: uuid
description: ''
description: Cancel a scheduled message (sets status to 'cancelled'). Only messages with status 'scheduled' can be cancelled.
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
success:
type: boolean
example: true
data:
$ref: '#/components/schemas/ScheduledMessage'
'400':
description: Validation error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
operationId: deleteScheduledMessagesById
x-operation-id-source: derived
components:
schemas:
ScheduledMessage:
type: object
properties:
id:
type: string
format: uuid
orgId:
type: string
format: uuid
botId:
type:
- string
- 'null'
format: uuid
channelId:
type:
- string
- 'null'
format: uuid
to:
type: string
message:
type: string
messageType:
type: string
enum:
- text
- image
- audio
- video
- document
mediaUrl:
type:
- string
- 'null'
contactName:
type:
- string
- 'null'
status:
type: string
enum:
- scheduled
- sent
- failed
- cancelled
sendAt:
type: string
format: date-time
sentAt:
type:
- string
- 'null'
format: date-time
error:
type:
- string
- 'null'
createdBy:
type:
- string
- 'null'
format: uuid
createdAt:
type: string
format: date-time
updatedAt:
type: string
format: date-time
ErrorResponse:
type: object
properties:
success:
type: boolean
example: false
error:
type: object
properties:
message:
type: string
code:
type: string
securitySchemes:
BearerAuth:
type: http
scheme: bearer
bearerFormat: JWT
description: JWT access token from POST /auth/login
ApiKeyAuth:
type: http
scheme: bearer
description: Bot API key (nrn_xxx) from bot API keys management
AccountTokenAuth:
type: http
scheme: bearer
description: Account token (nrn_acc_xxx) from Dashboard > Settings > Account Tokens