Snakk AI - Voice Agent Platform API
    • HubSpot setup guide
    • Partner Developer Documentation
    • Lime CRM setup guide
    • System
      • Simple health check
        GET
      • Detailed health check with dependency status
        GET
    • Tenants
      • Create a new account
        POST
    • Agents
      • List agents
        GET
      • Create agent
        POST
      • Get agent
        GET
      • Update agent
        PATCH
      • Delete agent
        DELETE
      • Duplicate agent
        POST
      • Activate or deactivate agent
        POST
      • List trashed agents
        GET
      • Restore a trashed agent
        POST
      • Portal identity key status
        GET
      • Create or rotate portal identity key
        POST
      • Remove portal identity key
        DELETE
    • Tools
      • List tools/webhooks for agent
        GET
      • List tools
        GET
      • Add tool/webhook to agent
        POST
      • Create tool
        POST
      • Update tool
        PATCH
      • Delete tool
        DELETE
      • Copy tool to another agent
        POST
    • Calls
      • List calls
      • Start an outbound call
      • Start an outbound call with an ad-hoc agent
      • Usage statistics
      • Detailed call statistics
      • Export all data for a data subject
      • Call statistics
      • Erase all calls for a data subject
      • Get call details
      • Erase a single call
      • Mark a call completed
      • Download a call transcript
      • Get a call recording URL
      • Get the function/tool execution log
      • Repair recording metadata
      • Diagnose recording availability
    • Phone Numbers
      • List your phone numbers
      • List numbers in the platform pool
      • Assign number to agent
      • Claim a number from the pool
      • Unassign number from agent
      • Release a number back to the pool
    • Statistics
      • Get dashboard overview statistics
      • Get daily call breakdown
      • Get monthly usage breakdown
      • Get per-agent statistics
      • Sync stored recordings to calls
      • List orphaned recordings
      • List call recordings
    • Subscription
      • Get current subscription and usage
      • List available subscription plans
      • Upgrade subscription (deprecated)
    • Web Access
      • Create a web voice session token
    • AI Tools
      • Generate an agent prompt from a description
    • Account
      • Get current account
      • Update current account
      • Regenerate API key
      • Check platform-admin status by email
    • Platform Admin
      • Platform-wide overview (legacy)
    • Knowledge Base
      • List knowledge base files
      • Upload document to knowledge base
      • Delete knowledge base file
      • Re-index an agent's knowledge base
    • Chat Widget
      • Get public widget config
      • Start a chat session
      • Send a chat message
      • Get chat history
      • Poll session status
      • Poll session status (POST)
      • Get full widget config
      • Update widget config
      • Upload chat avatar
      • Delete chat avatar
      • List all chat sessions
      • Get session with messages
      • Close a chat session
      • Close inactive sessions
      • Get chat stats
    • Version History
      • List agent versions
      • Get a specific agent version
      • Compare two agent versions
      • Restore an agent to a version
    • Workflows
      • List workflows
      • Create workflow
      • Get workflow
      • Update workflow
      • Delete workflow
      • Publish workflow version
      • List workflow versions
      • Roll back workflow to a previous version
      • Assign workflow to an agent
      • Unassign workflow from an agent
    • Chat Operator
      • Create a contact request
      • Get operator queue
      • Get operator's active chats
      • Claim a chat
      • Release a chat
      • Send message as operator
      • Update operator status
      • Operator real-time events
      • Get session messages (operator)
      • Update session customer info
      • List contact requests
      • Update a contact request
      • Get operator statistics
    • Chat Verification
      • Get chat verification status
      • Initiate chat verification
      • Check if verification is required
    • Tool Logs
      • List tool call logs
      • Tool usage statistics
      • Get a single tool call log
    • Admin (internal)
      • Trigger synthetic error
      • List customers without a payment provider
      • List all customers with details
      • Manually set a customer's plan
      • Detailed platform statistics
      • List all tenants
      • Get tenant details
      • Update a tenant
      • Purge a tenant
      • List all agents
      • Edit any agent
      • List all calls
      • Platform-wide statistics
      • Revenue breakdown by month
      • Bulk-purchase phone numbers
      • List all phone numbers (pool)
      • Import owned numbers from telephony connection
      • Reset a tenant's monthly usage
      • Retrieve a tenant's API key
      • List call routing rules
      • Sync call routing rules
      • List subscription upgrade requests
      • Approve a subscription request
      • Reject a subscription request
      • Update a customer's subscription
      • Get a customer's monthly usage history
      • Run the retention sweep now
      • List deletion certificates
      • List resellers
      • Create a reseller
      • Cross-reseller billing overview
      • Update a reseller
      • Import a number series into inventory
      • List number inventory
      • Bulk-allocate a number range to a reseller
      • Allocate a single number
      • List reseller admins
      • Add or invite a reseller admin
      • Revoke a reseller admin
      • Attach a tenant to a reseller
      • Set and attach a reseller domain
      • Get reseller domain status
      • Sync authentication redirect allow-list
      • Get a reseller's billing basis
      • List trashed customers (platform)
      • Restore a trashed customer (platform)
      • Permanently delete a customer (platform)
      • SIP trunk status
      • Sync numbers to the SIP trunk
    • Agent builder
      • Store a generated agent configuration
      • Retrieve a stored agent configuration
      • Mark a configuration as claimed
    • AI assist
      • Refine an existing agent prompt
      • Crawl a website and generate an agent prompt
      • Generate an agent via the guided wizard
      • Crawl a website and extract structured business data
      • Generate a comprehensive agent from detailed inputs
    • Auth & onboarding
      • Lazily migrate a legacy password
      • Sign up a new user
      • Log in
      • Refresh session
      • Current user
      • Log out
      • Request password reset
      • Update password
    • Billing
      • List subscription plans
      • Create a checkout session
      • Create a billing portal session
      • Get current subscription and usage
      • Create a payment link (admin)
      • Create a custom invoice (admin)
    • Branding
      • Resolve white-label branding for a host
      • Check TLS for a custom domain
    • Calendar
      • Google calendar OAuth callback
      • Outlook calendar OAuth callback
      • Get Google calendar authorization URL
      • Get Outlook calendar authorization URL
      • List calendar connections
      • Disconnect a calendar
      • List calendars within a connection
      • Get an agent's calendar configurations
      • Attach a calendar to an agent
      • Update an agent calendar configuration
      • Remove a calendar from an agent
      • Check available appointment slots
      • List a customer's bookings
      • Book an appointment
      • Cancel an appointment
    • Chat
      • List sessions for an agent
      • Get operator status
      • Puzzel handoff configuration
      • Update Puzzel handoff configuration
      • Verify Puzzel connection
    • Privacy & GDPR
      • List deletion certificates
    • Identity verification
      • List service connections
      • Create or update a service connection
      • Delete a service connection
      • Update test user settings on a connection
      • Test a service connection
      • Initiate BankID/eID caller verification
      • Check BankID/eID verification status
      • Check BankID/eID verification status by room
      • List all available verification methods
      • Initiate Vipps caller verification
      • Check Vipps verification status
      • Check Vipps verification status by room
      • List verification logs
      • Get verification statistics
      • Anonymize a verification record (GDPR)
      • Get verification retention policy
      • List marketplace tools
      • List an agent's marketplace tools
      • Add a marketplace tool to an agent
      • Update an agent's tool settings
      • Remove a tool from an agent
      • Get enabled eID methods for the tenant
    • Integrations
      • List available integration providers
      • List tenant connections
      • Create an API-key connection
      • Delete (disconnect) a connection
      • Get a fresh access token for a connection
      • Start an OAuth2 authorization flow
      • OAuth2 redirect callback
      • List actions for a provider
      • List an agent's integrations
      • Add an integration to an agent
      • Update an agent integration's config
      • Remove an integration from an agent
      • Execute an integration action during a call
      • Dispatch end-of-call integrations
      • Bedriftsnett connection status
      • Test the connection
      • Store connection credentials
      • Remove connection credentials
      • Update integration settings
      • List queues
      • List the company directory
      • Search the directory
      • Directory facets
      • Preview what the agent will see
      • Sync the directory now
      • Suggested transfer target
      • Real-time availability
      • List synced transfer tools
      • Add a transfer tool
      • Remove a transfer tool
      • Connection session state
      • Pre-call CRM lookup for an agent
      • Remove Salesforce from an agent
      • Apply the Salesforce logging preset to an agent
      • Remove Lime CRM from an agent
      • Apply the Lime CRM logging preset to an agent
    • Invites
      • Get invitation details
      • Accept an invitation
    • Knowledge base
      • List knowledge base files for an agent
      • Upload a knowledge base file for an agent
      • Delete a knowledge base file
    • Organizations
      • List my organizations
      • Create an organization
      • Delete an organization
      • List organization members
      • Remove a member
      • Invite a member
      • List pending invites
      • Revoke a pending invite
      • Remove a pending member
    • Partner
      • Submit a new integration
      • List my integrations
      • Update an integration
      • Get integration stats
      • Review and approve or reject an integration
      • List pending reviews
    • Phone numbers
      • List all pool numbers with summary
      • Search numbers available to purchase
      • Purchase a phone number
      • Assign a number to an agent
      • Unassign a number from its agent
      • Release a number from your account
    • Wholesale
      • Reseller
        • Get the current reseller
        • List resellers the admin belongs to
        • Get portal domain and DNS status
        • Upload a branding image
        • Delete a package
        • List customers
        • Create a customer
        • Update a customer
        • Update reseller branding and settings
        • Permanently delete a customer
        • List a customer's members and invites
        • Invite a user into a customer org
        • Revoke a pending invite
        • List packages
        • Remove a member from a customer org
        • Create a package
        • Get act-on-behalf access for a customer
        • Update a package
        • Portfolio call analytics for a month
        • Top conversation topics for a month
        • List the number pool
        • Add a number to the pool
        • Assign or release a number
        • Remove a number from the pool
        • List reseller staff
        • Add a reseller staff member
        • Change a staff member's role
        • Remove a staff member
        • Portfolio usage and billing for a month
        • List a customer's topups for a month
        • Add a topup on a customer's behalf
        • Export billing basis as CSV
        • List email templates
        • Override an email template
        • Send a test email template
        • Preview an email template
        • Upload an email image asset
        • Count newsletter recipients
        • List past newsletters
        • Send a newsletter
        • Preview a newsletter
        • List deletion certificates
        • Export a data subject for a customer
        • Erase a data subject for a customer
        • Get sending domain status
        • Register a sending domain
        • Remove the sending domain
        • Re-verify sending domain DNS
        • Send a test email from the sending domain
        • List integration OAuth providers
        • Set integration OAuth credentials
        • Remove integration OAuth credentials
        • Read the audit log
        • Access review
        • Search customers
        • List trashed customers
        • Restore a trashed customer
        • Permanently delete a customer
        • Import a number series
        • Send a password reset to a team member
        • List usage alerts
        • Acknowledge an alert
        • Resume automatic top-up
    • Support
      • Look up a customer by email
      • List a customer's agents
      • Get a customer's current-month usage
      • Get full agent detail
    • Tool logs
      • Create a tool call log
    • Top-ups
      • Get this month's minute balance
      • List available top-up packages
      • Order a top-up package
    • Users
      • List team members
      • Invite team member
      • Update user role
      • Remove team member
    • Web access
      • Get agent avatar preview info
    • Webhooks
      • Agent call-ended notification
      • Look up agent by phone number
      • Log a tool call from the agent
    • End-of-call webhooks
      • List end-of-call webhooks
      • Create end-of-call webhook
      • Update end-of-call webhook
      • Delete end-of-call webhook
    • Salesforce
      • List agents for the Salesforce package
      • Start an outbound call from Salesforce
      • Recent conversations for a phone number
      • Short-lived signed recording link
    • Customer
      • List your API keys
      • Create an API key
      • Revoke an API key
    • Reseller
      • List named API keys
      • Create a named API key
      • Revoke a named API key
      • Get the reseller's own API key
      • Rotate the reseller's API key
    • Schemas
      • Tenant
      • Error
      • Agent
      • AgentCreate
      • ToolLog
      • AgentUpdate
      • Call
      • AgentTool
      • Tool
      • CreateToolRequest
      • UpdateToolRequest
      • EndOfCallWebhook
      • CreateEndOfCallWebhookRequest
      • UpdateEndOfCallWebhookRequest
      • Workflow
      • WorkflowDefinition
      • KnowledgeBaseFile
      • ToolCallLog
      • AgentCalendar
      • ResellerBranding
      • ResellerModules
      • WholesalePriceTiers

    Lime CRM setup guide

    Snakk for Lime CRM — Setup Guide#

    Connect Snakk's AI phone and chat agents to Lime CRM. Callers are recognised
    by phone number before the agent says a word, every conversation is logged in
    the Lime history, tickets are created in Helpdesk when something needs a
    human, and new prospects become leads. Everything runs on Snakk's platform in
    the EU.

    What the integration does#

    MomentWhat happens in Lime CRM
    Before the callThe caller's number is looked up on Person (mobile and phone) and Lead. The agent greets the customer by name and knows about open tickets. Names are only used to confirm identity, never to search.
    During the callThe agent can look up and create persons, leads, deals and tickets, list the customer's tickets, and add notes. It never lists records that do not belong to the recognised customer.
    After the callA history entry of type phone is written on the person (and company, lead or ticket) with summary, duration, outcome and a link to the recording. A Helpdesk ticket is created for every conversation, or only for unresolved ones, as you choose. Optionally a lead is created when a new prospect shows buying interest.
    Supported languages for the agent: Norwegian, Swedish, Danish, English and
    more than 90 others. Supported Lime CRM: cloud and on-premise installations
    with the REST API enabled.

    Prerequisites#

    A Lime CRM application with the REST API enabled.
    A Lime CRM API key with read and write access to the limetypes
    person, company, helpdesk, history, lead and deal.
    Create it in Lime Admin → API Keys. A key that only covers helpdesk
    will create tickets but cannot recognise callers.
    A Snakk account with at least one agent. Sign up at snakk.ai.

    Step 1: Connect Lime CRM in Snakk#

    1.
    Log in to the Snakk dashboard and open Integrations.
    2.
    Choose Lime CRM and enter:
    API Key — the key from Lime Admin.
    Domain — your Lime host, for example yourcompany.lime-crm.com.
    Application name — the application segment of your Lime URL, for
    example yourcompany in https://yourcompany.lime-crm.com/yourcompany/.
    3.
    Save. Snakk verifies the key against GET /api/v1/ and shows the
    application name when the connection works.

    Step 2: Set up an agent in one click#

    1.
    Open the agent and choose Add integration → Lime CRM → Snakk setup for
    Lime CRM
    .
    2.
    A Lime CRM card appears at the top of the page with two switches:
    Recognise caller before the call — looks up the number before the
    first word. Without a match the agent greets as usual.
    Log all conversations in Lime CRM — choose what becomes a ticket:
    every conversation, only unresolved and transferred ones, or none
    (history entry only). Tick Create lead to register new prospects.
    3.
    Click Set up. Run it again at any time to change the mode.
    Advanced: every Lime action can also be added individually under
    Add integration and combined with your own webhooks and tools.

    Step 3: Test#

    Call your agent's number from a phone that is registered on a person in
    Lime CRM. The agent should greet you by name. After the call, open the person
    in Lime CRM: the history shows the conversation, and Helpdesk shows the
    ticket if the mode creates one.

    What is written where#

    Lime objectFields set by Snakk
    historynote (summary, duration, outcome, phone, link to the conversation), type = phone (or comment for chat), relations person, company, lead, helpdesk
    helpdesksubject, description, phone, email, person, company, source = phone/web, helpdeskstatus = new, priority
    leadfirstname, lastname, companyname, email, phone, description, source, leadstatus = new. An existing open lead with the same phone or e-mail is updated instead of duplicated.
    personCreated only when no match exists on phone or e-mail.
    dealname, value, probability, person, company, dealstatus, source
    Option keys (source, helpdeskstatus, priority, leadstatus,
    history.type) follow the Lime standard solution. If your application uses
    different keys, Lime rejects the value and Snakk writes the record without
    that field, so nothing is lost. Closed tickets are assumed to have the status
    key done.

    Security#

    The API key is encrypted with AES-256-GCM before it is stored and is never
    written to logs.
    All traffic to Lime CRM is HTTPS from Snakk's servers in the EU. No data is
    processed outside the EU.
    The agent never searches by name and never reads ticket details to an
    unverified caller. The caller's phone number is used for recognition only.
    The integration only touches the limetypes listed above.

    Troubleshooting#

    ProblemCause and fix
    "API key lacks access to persons in Lime CRM"The key is missing the person limetype. Add it in Lime Admin → API Keys.
    Caller not recognisedThe number is stored in a different format than E.164. Snakk searches +47…, 47…, 0047… and the national 8-digit form; other formats need to be normalised in Lime.
    Ticket created without status or priorityYour application uses other option keys. Contact Snakk support with the keys and we map them.
    Nothing is logged after the callThe "Log all conversations" preset is not applied to this agent, or the connection was removed. Open the agent's Lime CRM card and click Set up.

    Support#

    E-mail: support@snakk.ai
    Documentation: doc.snakk.ai
    Status: status.snakk.ai
    Modified at 2026-09-13 16:36:15
    Previous
    Partner Developer Documentation
    Next
    Simple health check
    Built with