Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.suprsend.com/llms.txt

Use this file to discover all available pages before exploring further.

AI Copilot lives on your SuprSend dashboard. Ask it to look up a user, trace a missing notification, configure tenant preferences, or seed test data — it calls the right APIs and shows you the result. It’s scoped to your workspace and SuprSend docs. Each thread retains full conversation history, so follow-ups work without re-explaining context.
Copilot is in beta. It’s currently free — no usage limits, no charges. We’ll announce pricing before moving to general availability.

Copilot capabilities

Ask anything

Search SuprSend documentation, ask how things work, understand concepts, or get help with integration — all without leaving the dashboard.

Set up test data

Seed your workspace for testing — create users with channels, set up tenants with branding, configure preferences, and wire up workflows in one conversation.

Manage translations

Update your English locale file and ask Copilot to translate it into all other configured languages. Fetch, review, and commit translation files without manual editing.

Design and test notifications (Coming soon)

Configure workflows, set up templates, define event schemas, and send test notifications to verify everything works end-to-end before going live.

Debug and inspect delivery (Coming soon)

Trace why a notification wasn’t delivered — check channel availability, preference opt-outs, tenant overrides, category defaults, and execution logs to pinpoint the issue.

Check analytics (Coming soon)

Pull delivery rates, engagement metrics, and channel performance to understand how your notifications are performing across segments and tenants.

Tool reference

Users

ToolExample prompt
get_userShow me the full profile of user jane@acme.com
create_userCreate user test-1 with email test@demo.com and name joe
update_userAdd email to user jane@acme.com and set her timezone to America/New_York
get_user_preferenceShow me the notification preferences for jane@acme.com
update_user_preference_categoryOpt user sarah@acme.com out of the product-updates category
update_user_preference_channelTurn off SMS notifications entirely for john@acme.com
get_user_list_subscriptionsWhat lists is john@acme.com part of?
get_user_object_subscriptionsWhat objects is john@acme.com subscribed to?

Tenants

ToolExample prompt
get_tenantShow me branding and config for tenant enterprise-client
upsert_tenantCreate tenant “Globex Corp” with logo https://globex.com/logo.png and primary color #1E40AF
get_tenant_preferenceWhat are the default preferences for tenant acme-corp?
update_tenant_preference_categoryFor tenant acme-corp, turn off WhatsApp for all categories and disable product-updates entirely

Objects

ToolExample prompt
get_objectShow me the project-atlas object and how many subscribers it has
create_objectCreate object design-reviews and subscribe user jane@acme.com to it
update_objectSet the description of project-atlas to “Atlas project notifications”
get_object_preferenceWhat are the notification preferences for the alerts-channel object?
update_object_preference_categoryTurn off push notifications for the alerts-channel object and opt it out of the marketing category
update_object_preference_channelDisable email for the alerts-channel object
get_object_subscriptionsWho is subscribed to the project-atlas object?
add_object_subscriptionSubscribe user jane@acme.com to design-reviews and set role project manager

Workflows and events

ToolExample prompt
get_workflowIs the payment-reminder workflow active? What category does it use?
list_workflowsWhat workflows do I have? Summarize each one
get_event_detailsShow me the schema for the user-signed-up event

Categories

ToolExample prompt
get_preference_categoriesWhat categories do I have and what are their defaults?
update_preference_categoryAdd a new product-updates category with default opt-in settings for email and inbox channels
commit_preference_categoryCommit the category changes to make them live

Translations

ToolExample promptPurpose
get_translationShow me the French translation fileFetch file by locale
update_translationAdd French translations for the weekly-digest category name and descriptionUpload or update file
commit_translationCommit the translation updatesCommit draft changes to make them live

Lists

ToolExample promptPurpose
add_user_to_listAdd user jane@acme.com to the beta-testers listAdd user to list
remove_user_from_listRemove john@acme.com from the inactive-users listRemove user from list

Multi-step prompts

Copilot handles multi-step tasks in a single conversation — chain actions together naturally.
Example prompt
Create user test-1 with email and SMS, add them to beta-testers, and subscribe them to project-updates
Give me a full audit of tenant enterprise-client — branding, preference overrides, and which categories are turned off
Move all subscribers from old-project object to new-project
Create a weekly-digest category under Promotional with opt-in default, then add French and Spanish translations
User john@acme.com says he’s not getting emails. What’s wrong?
Check if payment-reminder is active, what category it’s linked to, and what the default preference is

Coming soon
  • Create and update workflows and templates
  • Trigger test runs directly from Copilot
  • Generate event schemas and type definitions
  • Inspect execution logs, message logs, and request logs
  • View billing plan and usage
  • Multiple threads with shared context across conversations
  • Long-running background tasks
Want a new tool or have feedback? Let us know at product@suprsend.com.