io.github.conquext/neuron

Create a new WhatsApp group and seed its members from any combination of sources: other groups (combine/copy), contact lists, individual contacts, pasted phone numbers, or the whole address book. Optionally pass a unique `slug` to address the group later without its JID. Members blocked by privacy come back in the failed list. Uses the org's default connected session unless `channelId` is given.

Add a new entry (note, document, or information piece) to a knowledge base.

Create a new knowledge base to store and organize information, documents, and entries.

Create a lead source. `config` depends on type: text_paste {text}; web_scrape {url|urls[]}; document {mediaUrl,mimeType}; tool_output {toolId,args?}; instagram/x {channelId, query?|hashtag?, limit?}; csv {rows[]}; stream {triggerTaskId?} (fed by the ingest endpoint). Set scheduleKind cron/interval/once for recurring (schedule: cron {time,days?} / interval {everyMinutes} / once {runAt}).

Create a paced campaign that messages the next N un-reached members of a contact list on a schedule. The cursor follows the LIVE list — as members are added or removed, only current members get reached, and nobody is messaged twice per cycle. Multiple campaigns can run on the same or different lists concurrently. On exhaust, either stop or loop (start over after a cooldown).

Create a new WhatsApp Channel newsletter for one-way broadcast updates. Requires a connected Baileys session on the specified channel.

Register a new outbound webhook that sends HTTP POST requests to an external URL when specified bot events occur. Supported events: message.created, message.assistant, conversation.created, conversation.escalated, conversation.closed, bot.paused, bot.resumed.

Create a digital product/service with a public checkout link. Amount in kobo (minor units): ₦1 = 100. Minimum ₦500 = 50000. For 'file' delivery, upload the file first (neuron_upload_media) and pass its URL as deliveryFileUrl. On payment, Neuron confirms it and delivers the product to the buyer's WhatsApp automatically.

Create a draft SMS campaign. Choose the audience via sourceType: 'all_contacts' or 'contact_list' (your own contacts), 'phones' (bring your own list — raw numbers you pass in), 'platform' (the wider Neuron audience — budget required, sent over the bulk campaign route), or 'curated' (SMS-opted-in marketplace lists via poolEntryIds; the list owner earns ₦2/contact). After creating, call neuron_estimate_sms_campaign to price it, then neuron_send_sms_campaign. Requires SMS to be enabled by an admin and a configured provider.

Create a new social media channel with platform credentials. Supports Instagram and Twitter/X. Credentials should be the full session JSON including account, cookies, headers, and platform-specific tokens.

Create a scheduled autonomous task for a bot. The instruction is a self-contained, natural-language directive the bot executes with its tools (find stale conversations, message contacts, schedule follow-ups, etc.). Sends are always screened against Do-Not-Contact, a per-run cap, and a no-repeat window.

Create a custom API tool that the bot can invoke during conversations to fetch external data or trigger actions.

Register a new inbound webhook endpoint that triggers bot actions when called by an external service.

Permanently delete a draft ad request. Only ad requests in draft status can be deleted.

Permanently delete a blog post by its ID. This action cannot be undone.

Permanently delete a bot and all its associated data. This action cannot be undone.

Permanently delete a broadcast and its recipient data. This action cannot be undone.

Permanently delete a calendar and all its event types, bookings, and availability data.

Permanently delete a campaign that is in 'draft' status. Active or funded campaigns cannot be deleted.

Permanently delete a WhatsApp channel and disconnect any active sessions. This action cannot be undone.

Permanently delete a contact and remove them from all contact lists. This action cannot be undone.

Permanently delete a contact list. System-protected lists (e.g., 'Do Not Contact') cannot be deleted.

Delete a host-created event. For recurring events, use scope to control what gets deleted: 'single' (just this one), 'future' (this and all future), or 'all' (entire series).

Permanently delete an event type and all its bookings.

Soft-delete a flow. It stops running but can be restored. Running executions are not cancelled.

Permanently delete a completed, failed, or cancelled flow run and all its step data.

Permanently delete a specific entry from a knowledge base.

Permanently delete a knowledge base and all its associated entries and documents.

Permanently delete a paced list campaign and its reached-set. Does not delete the contacts or the list.

Permanently delete a specific message from a conversation. This action cannot be undone.

Permanently delete a WhatsApp Channel newsletter and remove it from WhatsApp. This action cannot be undone.

Permanently remove an outbound webhook. The external endpoint will no longer receive event notifications from this bot.

Remove a date-specific availability override, reverting to the default weekly hours.

Delete a voice persona.

Permanently delete a product. Existing orders are retained.

Delete a draft SMS campaign. Only draft campaigns can be deleted.

Permanently delete a social media channel and disconnect any active sessions. This action cannot be undone.

Delete a scheduled task. This is a soft delete — the task stops running immediately.

Permanently remove a custom API tool integration from a bot. The bot will no longer be able to invoke this tool in conversations.

Permanently remove an inbound webhook from a bot. External services will no longer be able to trigger this endpoint.

Re-send a paid-but-undelivered order to the buyer over WhatsApp/email. Use when a sale settled while no WhatsApp session was connected; connect one first, then deliver.

Remove a knowledge base from a bot. The bot will no longer reference this knowledge base when generating responses.

Turn a plain-English description into a structured task spec (title, instruction, scheduleKind, schedule, timezone, config) WITHOUT creating it. Use the returned draft as input to neuron_create_task after any edits.

Clone an existing product into a hidden draft copy (new checkout link, '(copy)' title, reset counters). A 'pool' code product is cloned with an empty pool — restock codes before enabling. Edit the copy with neuron_update_product, then set enabled: true to publish.

Edit the content of a previously sent message in a conversation. Only the message sender can edit their messages.

Manually enroll existing / off-platform people into a membership product WITHOUT a payment. Use this to backfill members who were already in the WhatsApp group before you switched membership on, so the renewal + eviction cycle applies to them too. No order or revenue is booked. Each enrolled member gets a free first period (firstPeriodDays, or one normal interval by default), then renews like everyone else — reminder-only until they connect a Neuron account (no auto-charge). Existing members are left untouched (counted as skipped). Returns { enrolled, skipped, total }.

Price a draft SMS campaign before sending: returns recipient count, SMS provider cost, curated owner payout (₦2/contact), and the total in kobo. Call this before neuron_send_sms_campaign.

Export all contacts as a downloadable dataset for the current organization.

Run a one-off extraction WITHOUT creating a persistent source, saving the results to the lead pool. Great for pasted text or a web page. `type` + `config` as in neuron_create_lead_source (e.g. type='text_paste', config={text}).

Retrieve all contact lists that a specific contact belongs to.