Skip to content

frontline agent-channels

View channel integrations (WhatsApp, Instagram, Messenger) and bind them to agents

frontline agent-channels [options] [command]

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels list

List connected channel integrations and their agent bindings

frontline agent-channels list [options]

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels whatsapp

Manage connected WhatsApp numbers

frontline agent-channels whatsapp [options] [command]

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels whatsapp info

Get a WhatsApp number's live business profile

frontline agent-channels whatsapp info [options] <phoneNumberId>

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels whatsapp update

Update a WhatsApp number's profile and/or its assigned agent

frontline agent-channels whatsapp update [options] <integrationId> <phoneNumberId>

Options

FlagDescriptionDefault
--agent-id <agentId>Bind this number to an agent
--clearUnbind the assigned agent
--about <text>Business 'about' text
--description <text>Business description
--address <text>Business address
--email <email>Business email
--website <url>Primary website
--secondary-website <url>Secondary website
--category <category>WhatsApp business category
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels whatsapp register

Register a connected WhatsApp number with Meta

frontline agent-channels whatsapp register [options] <integrationId> <phoneNumberId>

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels whatsapp disconnect

Disconnect a single WhatsApp number

frontline agent-channels whatsapp disconnect [options] <integrationId> <phoneNumberId>

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels instagram

Manage connected Instagram accounts

frontline agent-channels instagram [options] [command]

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels instagram assign

Bind an Instagram account to an agent (or --clear to unbind)

frontline agent-channels instagram assign [options] <instagramAccountId>

Options

FlagDescriptionDefault
--agent-id <agentId>Agent ID to bind
--clearUnbind the assigned agent
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels messenger

Manage connected Messenger pages

frontline agent-channels messenger [options] [command]

Options

FlagDescriptionDefault
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)

frontline agent-channels messenger assign

Bind a Messenger page to an agent (or --clear to unbind)

frontline agent-channels messenger assign [options] <messengerPageId>

Options

FlagDescriptionDefault
--agent-id <agentId>Agent ID to bind
--clearUnbind the assigned agent
--api-key <key>Override API key for this run (else FRONTLINE_API_KEY env, else stored profile key)
--base-url <url>Advanced: override Public API base URL for this run
--profile <name>Credentials profile: uses that profile's saved API key and Public API base URL (see frontline auth profiles list)
--debugShow debug info on stderr (token is redacted)
--prettyPretty-print human-readable output (instead of default JSON)
--tableRender list results as a table (implies --pretty)
--jsonOutput raw JSON (default behavior — accepted as a no-op)