marketing
Freshmarketer CLI for CI
Use the Freshmarketer CLI for CI with headless JSON commands, schema discovery, credentials, and permission controls.
7 functions 6 read 1 write Bearer token auth
Freshmarketer CLI for CI
Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status.
Use this shape when a pipeline needs to read or update an external service. The Freshmarketer CLI uses the same integration registry as the TUI, Lua runtime, and MCP gateway, but returns predictable command output for automation.
Command Shape
# Freshmarketer CLI for CI
kosmokrator integrations:configure freshmarketer --set access_token="$FRESHMARKETER_ACCESS_TOKEN" --set domain="$FRESHMARKETER_DOMAIN" --enable --read allow --write ask --json
kosmo integrations:call freshmarketer.freshmarketer_list_campaigns '{"page":1,"limit":1,"status":"example_status"}' --json Discovery Before Execution
Agents and scripts can inspect Freshmarketer docs and schemas before choosing a function.
kosmo integrations:docs freshmarketer --json
kosmo integrations:docs freshmarketer.freshmarketer_list_campaigns --json
kosmo integrations:schema freshmarketer.freshmarketer_list_campaigns --json
kosmo integrations:search "Freshmarketer" --json
kosmo integrations:list --json Useful Freshmarketer CLI Functions
| Function | Type | Parameters | Description |
|---|---|---|---|
freshmarketer.freshmarketer_list_campaigns | Read | page, limit, status | List marketing campaigns from Freshmarketer. Supports pagination and filtering by status (e.g., "active", "completed", "draft"). |
freshmarketer.freshmarketer_get_campaign | Read | id | Get detailed information about a specific marketing campaign by its ID. |
freshmarketer.freshmarketer_create_campaign | Write | name, channel_list, schedule | Create a new marketing campaign in Freshmarketer. Specify the campaign name, channels (e.g., "email"), and an optional schedule. |
freshmarketer.freshmarketer_list_segments | Read | page, limit | List contact segments in Freshmarketer. Supports pagination to browse through all segments. |
freshmarketer.freshmarketer_get_segment | Read | id | Get detailed information about a specific contact segment by its ID. |
freshmarketer.freshmarketer_list_users | Read | none | List all users in the Freshmarketer account. |
freshmarketer.freshmarketer_get_current_user | Read | none | Get the profile of the currently authenticated Freshmarketer user. |
Automation Notes
- Use
--jsonfor machine-readable output. - Keep credentials out of argv by using environment variables or stored KosmoKrator configuration.
- Configure read/write policy before unattended runs; use
--forceonly for trusted automation. - Use the MCP gateway instead when the agent needs dynamic tool discovery inside a conversation.