Skip to main content
ChatbotX CLI commands follow the same resources you manage in the Workspace: Contacts, Tags, Custom Fields, Bot Fields, Conversations, Broadcasts, Flows, Sequences, and system tools.

​
Global Options

OptionWhen to Use It
--apiKeyUse a different API key for one command
--apiUrlUse a different API URL for one command
--allowSelfSignedCertConnect to a server with a self-signed certificate
--refresh-specRe-fetch the OpenAPI spec after new APIs are added
--jsonReturn raw JSON output instead of formatted text (useful for scripting with jq)

​
Contact Identifiers

For any command in the contacts group, the <identifier> parameter supports three look-up formats. Use an explicit prefix format so the CLI finds the correct Contact:
FormatExampleLookup By
id:<value>id:123456789Contact ID
email:<value>email:user@example.comEmail address
phone:<value>phone:+84708123123Phone number

​
Examples

# Get contact by email
chatbotx contacts get email:user@example.com

# Get contact by phone
chatbotx contacts get phone:+84708123123

# Get contact by internal ID
chatbotx contacts get id:123456789

​
Command Groups

GroupCommon CommandsUse It For
Workspaceworkspaces getCheck Workspace connection and metadata
Members, Channels, Teamsmembers list, channels list, teams listInspect users, channels, and inbox teams
Tagstags list, tags create, tags updateManage Contact labels
Custom Fieldscustom-fields list, custom-fields createManage Contact data fields
Bot Fieldsbot-fields list, bot-fields bulk-updateManage bot-level variables
Contactscontacts list, contacts get, contacts upsertFind, create, update, import, and block Contacts
Contact Actionscontacts tag add, contacts message send, contacts flow addRun actions on a specific Contact
Conversationsconversations listInspect Inbox activity
Broadcastsbroadcasts list, broadcasts getCheck campaigns and audiences
Automationflows list, sequences list, keywords list, triggers listInspect automation assets
System Toolssaved-replies list, template-messages list, error-logs listReview reusable content and logs

​
Workspace, Members, Channels, and Teams

chatbotx workspaces get
chatbotx members list                      # [--page --perPage --sort --keyword]
chatbotx members get <memberId>
chatbotx channels list                     # [--includes --page --perPage]
chatbotx teams list

​
Tags

chatbotx tags list
chatbotx tags create --name <name>
chatbotx tags get <idOrName>
chatbotx tags update <id> --name <name>
chatbotx tags delete <id>

​
Custom Fields

chatbotx custom-fields list
chatbotx custom-fields create --name <name> --type <type>
chatbotx custom-fields get <idOrName>
chatbotx custom-fields update <id> --name <name>     # [--description --folderId]
chatbotx custom-fields delete <id>

​
Bot Fields

chatbotx bot-fields list
chatbotx bot-fields create --name <name> --type <type> --value <value> --description <description>
chatbotx bot-fields update --fields <fields>
chatbotx bot-fields bulk-update --fields <fields>
chatbotx bot-fields get <idOrName>
chatbotx bot-fields update <idOrName> --value <value>
chatbotx bot-fields delete <idOrName>

​
Contacts

chatbotx contacts list                     # [--page --perPage --sort --keyword ...]
chatbotx contacts create --phoneNumber <phoneNumber> --email <email> --gender <gender>
chatbotx contacts get <identifier>
chatbotx contacts upsert <identifier>      # [--firstName --lastName --email --phoneNumber --avatar --gender]
chatbotx contacts update <identifier>
chatbotx contacts delete <identifier>
chatbotx contacts find-by-custom-field     # [--customFieldId --value]
chatbotx contacts import --fileId <fileId> --channel <channel> --inboxId <inboxId>

​
Contact Tags

chatbotx contacts tags list <identifier>
chatbotx contacts tag add <identifier> --tagIds <tagIds>
chatbotx contacts tag delete <identifier> --tagIds <tagIds>

​
Contact Custom Fields

chatbotx contacts custom-fields list <identifier>
chatbotx contacts custom-fields update <identifier> --fields <fields>
chatbotx contacts custom-field get <identifier> <customFieldId>
chatbotx contacts custom-field add <identifier> <customFieldId> --value <value>
chatbotx contacts custom-field delete <identifier> <idOrName>

​
Contact Actions

chatbotx contacts block <identifier>
chatbotx contacts unblock <identifier>
chatbotx contacts messages list <identifier>         # [--perPage --cursor]
chatbotx contacts message get <identifier> <messageId>
chatbotx contacts message send <identifier>          # [--text --files --flowId --nodeId --inboxId]
chatbotx contacts flow add <identifier> --flowId <flowId>  # [--inboxId]
chatbotx contacts auto-replies add <identifier> --keyword <keyword>  # [--inboxId]

​
Conversations, Broadcasts, Flows, Sequences, and System Tools

chatbotx conversations list                # [--botCategory --assignedId --channel --status --keyword ...]
chatbotx broadcasts list
chatbotx broadcasts get <idOrName>
chatbotx broadcasts audience get <idOrName>           # [--page --perPage]
chatbotx flows list
chatbotx sequences list                    # [--page --perPage --sort]
chatbotx sequences get <id>
chatbotx saved-replies list
chatbotx template-messages list            # [--inboxId --integrationWhatsappId --status]
chatbotx ai-agents list
chatbotx integrations list
chatbotx keywords list
chatbotx triggers list
chatbotx webhooks list
chatbotx error-logs list                   # [--page --perPage --sort --keyword]