Authentication

Endpoints

Welcome to the Clerk Chat API Documentation

Introduction

Clerk Chat

How to embed the Clerk Chat App into your own app

Embedded App

Find messages

Send a message

Search for a contact

Create a contact

Update a contact

Create multiple contacts for the active team

Create multiple contacts

Create and trigger a Campaign for a Cohort

Create and trigger a Campaign

Assigns a phone number to a specific user

Assign phone to user

Lists all phone numbers that are not assigned to users

List unassigned phones

Gets a single Clerk Chat User

Search Clerk Chat Users

Add Clerk chat user

Removes a user from the Clerk chat system

Remove Clerk chat user

Automatically assigns available phone numbers to users

Auto-assign users

Get all teams for a reseller

Create a new team

Get information about a team

Update a new team

Remove a team from the reseller

Create a new inboxes and users for a team

Create new inboxes and users for a team

Get all users on a team

Add a user to a team

Remove users from a team

Gets all inboxes for a team

Create a new inbox for a team. Also can assign a user to the inbox

Create a new inbox for a team

Remove inboxes from a team

Assign multiple Users to an Inbox. Also can assign a user to the inbox

Assign multiple Users to an Inbox

Remove users from an inbox

Return the whitelist domains for the reseller team

Create a new whitelisted domain for a team

Remove a whitelisted domain from the team

Get Resellers under a Platform

Create a new Reseller

Get tiers available for current reseller.

Get Started

​Authentication

​Endpoints

Authentication

Endpoints