Command Palette

Search for a command to run...

IntelliPortalDOCS

Start here

  • Overview
  • Quickstart
  • Test in the sandbox

Build

  • Authentication
  • Clients
  • Hosted onboarding
  • Webhooks

API reference

  • Messages
  • Usage
  • Status & observability

Reliability

  • WhatsApp limits
  • Errors & debugging

Resources

  • Changelog
  • OpenAPI 3.1
  • Postman collection
Developer support
IntelliPortalDOCS
Developer documentation/API v1

© 2026 Intelli Holdings Inc.

PrivacyContact

Need a hand?

Share a request ID when you contact us so we can trace the call quickly.

Open developer support
  1. Docs
  3. Clients

API reference

clients

Clients

A client is an end-business you message on behalf of. Your client_ref is the stable key that connects your data model, a channel account, outbound sends, and inbound events.

Choose a durable client_ref

Use an immutable identifier from your own database, not a business name or phone number. A single business with both WhatsApp and Instagram should use distinct references for each channel connection.

client_ref is an idempotency boundary

Creating another session with a reference that is already connected returns 409 conflict. Look up the existing client instead of generating random references on every retry.

Create a hosted connection session

The key needs clients:write. Create the session from your backend, then pass only the returned URL to your frontend.

Create session
POST /v1/embedded-signup/sessions
Authorization: Bearer ik_live_...
Content-Type: application/json

{
  "client_ref": "customer_42"
}
PropertyTypeDescription
session_idstringOpaque identifier for support and hosted-flow correlation. Do not parse it.
urlURLIntelli-hosted onboarding page to open for the client business.
expires_inintegerSeconds until the single-use session expires; currently 600.
JSON · 201
{
  "session_id": "a7jBeKh4uW97sypQ...",
  "url": "https://www.intelliconcierge.dev/embed/whatsapp?session=...",
  "expires_in": 600
}

Channel-specific behavior

WhatsApp

Connects a WhatsApp Business Account and phone number.

Supports the full free-form message set and approved templates.

Instagram

Connects an Instagram professional account through OAuth.

Sends text replies to the Instagram-scoped user ID received in a webhook.

GET/clients

List connected clients

Use a key with clients:read. Paginate with limit and offset; the default page size is 20.

cURL
curl "https://api.intelliconcierge.dev/v1/clients?limit=20&offset=0" \
  -H "Authorization: Bearer $INTELLI_API_KEY"
GET/clients/{client_ref}

Confirm one client

Call this endpoint after the hosted window reports completion. Your backend should trust this server response rather than the browser message when deciding whether to enable sends.

cURL
curl https://api.intelliconcierge.dev/v1/clients/customer_42 \
  -H "Authorization: Bearer $INTELLI_API_KEY"

Implement the browser handoff

The hosted onboarding guide covers popup handling, allowed origins, completion messages, expiry, and the advanced AI-assistant integration prompt.

Hosted onboarding guide
PreviousAuthentication
NextHosted onboarding