Can I use Courier as a CLI?

Yes. KosmoKrator exposes a Courier CLI through kosmo integrations:call and the provider shortcut command. Commands can return JSON for scripts, CI, and coding agents.

Can I expose Courier through MCP?

Yes. The KosmoKrator MCP gateway can expose selected Courier tools to clients such as Claude Code, Cursor, Codex, and other MCP-compatible tools.

Where are Courier credentials stored?

Courier credentials are configured in KosmoKrator's local integration settings and reused by CLI, Lua, and MCP gateway surfaces.

Can I deny write access for Courier MCP tools?

Yes. Start the gateway with --write=deny for read-only clients, or use ask/allow only for trusted workspaces.

productivity

Courier CLI for AI Agents

Use the Courier CLI from KosmoKrator to call Courier tools headlessly, return JSON, inspect schemas, and automate workflows from coding agents, scripts, and CI.

Courier CLI Setup

Courier can be configured headlessly with `kosmokrator integrations:configure courier`.

Install, configure, and verify

# Install KosmoKrator first if it is not available on PATH.
curl -fsSL https://raw.githubusercontent.com/OpenCompanyApp/kosmokrator/main/install.sh | bash

# Configure and verify this integration.
kosmokrator integrations:configure courier --set api_key="$COURIER_API_KEY" --enable --read allow --write ask --json
kosmokrator integrations:doctor courier --json
kosmokrator integrations:status --json

Credentials

Authentication type: API key api_key. Configure credentials once, then reuse the same stored profile from scripts, coding CLIs, Lua, and MCP.

Key	Env var	Type	Required	Label
`api_key`	`COURIER_API_KEY`	Secret `secret`	yes	API Key
`url`	`COURIER_URL`	URL `url`	no	Courier API URL

Command Patterns

The generic command is stable across every integration. The provider shortcut is shorter for humans.

Generic CLI call

kosmo integrations:call courier.courier_audiences_delete '{}' --json

Provider shortcut

kosmo integrations:courier courier_audiences_delete '{}' --json

Discovery

These commands return structured output for coding agents that need to inspect capabilities before choosing a function.

Discovery commands

kosmo integrations:docs courier --json
kosmo integrations:docs courier.courier_audiences_delete --json
kosmo integrations:schema courier.courier_audiences_delete --json
kosmo integrations:search "Courier" --json
kosmo integrations:list --json

Automation Contexts

The same configured command surface works in these environments. The command does not change unless the host wrapper, credentials, or permissions change.

CI Run integration calls from CI jobs with JSON output, explicit credentials, and predictable exit status. Cron Jobs Schedule repeatable integration workflows from cron while keeping credentials in KosmoKrator config. Shell Scripts Call integration functions from shell scripts with stable JSON input and output. Headless Automation Use KosmoKrator as a non-interactive integration runtime for local automations and wrappers. Coding Agents Let coding agents discover schemas and execute integration functions through CLI commands or MCP.

CLI Functions

Every function below can be called headlessly. Commands are highlighted, copyable, and scroll horizontally when payloads are long.

`courier.courier_audiences_delete`

Deletes the specified audience.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_audiences_delete '{}' --json

Shortcut

kosmo integrations:courier courier_audiences_delete '{}' --json

`courier.courier_audiences_get`

Returns the specified audience by id.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_audiences_get '{}' --json

Shortcut

kosmo integrations:courier courier_audiences_get '{}' --json

`courier.courier_audiences_list_audiences`

Get the audiences associated with the authorization token.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_audiences_list_audiences '{}' --json

Shortcut

kosmo integrations:courier courier_audiences_list_audiences '{}' --json

`courier.courier_audiences_list_members`

Get list of members of an audience.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_audiences_list_members '{}' --json

Shortcut

kosmo integrations:courier courier_audiences_list_members '{}' --json

`courier.courier_audiences_update`

Creates or updates audience.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_audiences_update '{}' --json

Shortcut

kosmo integrations:courier courier_audiences_update '{}' --json

`courier.courier_audit_events_get`

Fetch a specific audit event by ID.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_audit_events_get '{}' --json

Shortcut

kosmo integrations:courier courier_audit_events_get '{}' --json

`courier.courier_audit_events_list`

Fetch the list of audit events.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_audit_events_list '{}' --json

Shortcut

kosmo integrations:courier courier_audit_events_list '{}' --json

`courier.courier_auth_tokens_issue_token`

Returns a new access token.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_auth_tokens_issue_token '{}' --json

Shortcut

kosmo integrations:courier courier_auth_tokens_issue_token '{}' --json

`courier.courier_automations_invoke_ad_hoc_automation`

Invoke an ad hoc automation run.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_automations_invoke_ad_hoc_automation '{}' --json

Shortcut

kosmo integrations:courier courier_automations_invoke_ad_hoc_automation '{}' --json

`courier.courier_automations_invoke_automation_template`

Invoke an automation run from an automation template.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_automations_invoke_automation_template '{}' --json

Shortcut

kosmo integrations:courier courier_automations_invoke_automation_template '{}' --json

`courier.courier_automations_list`

Get the list of automations.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_automations_list '{}' --json

Shortcut

kosmo integrations:courier courier_automations_list '{}' --json

`courier.courier_brands_create`

Create a new brand.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_brands_create '{}' --json

Shortcut

kosmo integrations:courier courier_brands_create '{}' --json

`courier.courier_brands_delete`

Delete a brand by brand ID.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_brands_delete '{}' --json

Shortcut

kosmo integrations:courier courier_brands_delete '{}' --json

`courier.courier_brands_get`

Fetch a specific brand by brand ID.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_brands_get '{}' --json

Shortcut

kosmo integrations:courier courier_brands_get '{}' --json

`courier.courier_brands_list`

Get the list of brands.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_brands_list '{}' --json

Shortcut

kosmo integrations:courier courier_brands_list '{}' --json

`courier.courier_brands_replace`

Replace an existing brand with the supplied values.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_brands_replace '{}' --json

Shortcut

kosmo integrations:courier courier_brands_replace '{}' --json

`courier.courier_bulk_create_job`

Creates a new bulk job for sending messages to multiple recipients.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_bulk_create_job '{}' --json

Shortcut

kosmo integrations:courier courier_bulk_create_job '{}' --json

`courier.courier_bulk_get_job`

Get a bulk job.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_bulk_get_job '{}' --json

Shortcut

kosmo integrations:courier courier_bulk_get_job '{}' --json

`courier.courier_bulk_get_users`

Get Bulk Job Users.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_bulk_get_users '{}' --json

Shortcut

kosmo integrations:courier courier_bulk_get_users '{}' --json

`courier.courier_bulk_ingest_users`

Ingest user data into a Bulk Job.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_bulk_ingest_users '{}' --json

Shortcut

kosmo integrations:courier courier_bulk_ingest_users '{}' --json

`courier.courier_bulk_run_job`

Run a bulk job.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_bulk_run_job '{}' --json

Shortcut

kosmo integrations:courier courier_bulk_run_job '{}' --json

`courier.courier_inbound_track`

Courier Track Event.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_inbound_track '{}' --json

Shortcut

kosmo integrations:courier courier_inbound_track '{}' --json

`courier.courier_journeys_invoke`

Invoke a journey run from a journey template.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_journeys_invoke '{}' --json

Shortcut

kosmo integrations:courier courier_journeys_invoke '{}' --json

`courier.courier_journeys_list`

Get the list of journeys.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_journeys_list '{}' --json

Shortcut

kosmo integrations:courier courier_journeys_list '{}' --json

`courier.courier_lists_add_subscribers`

Subscribes additional users to the list, without modifying existing subscriptions.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_add_subscribers '{}' --json

Shortcut

kosmo integrations:courier courier_lists_add_subscribers '{}' --json

`courier.courier_lists_delete`

Delete a list by list ID.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_delete '{}' --json

Shortcut

kosmo integrations:courier courier_lists_delete '{}' --json

`courier.courier_lists_get`

Returns a list based on the list ID provided.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_get '{}' --json

Shortcut

kosmo integrations:courier courier_lists_get '{}' --json

`courier.courier_lists_get_subscribers`

Get the list's subscriptions.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_get_subscribers '{}' --json

Shortcut

kosmo integrations:courier courier_lists_get_subscribers '{}' --json

`courier.courier_lists_list`

Returns all of the lists, with the ability to filter based on a pattern.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_list '{}' --json

Shortcut

kosmo integrations:courier courier_lists_list '{}' --json

`courier.courier_lists_restore`

Restore a previously deleted list.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_restore '{}' --json

Shortcut

kosmo integrations:courier courier_lists_restore '{}' --json

`courier.courier_lists_subscribe`

Subscribe a user to an existing list (note: if the List does not exist, it will be automatically created).

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_subscribe '{}' --json

Shortcut

kosmo integrations:courier courier_lists_subscribe '{}' --json

`courier.courier_lists_unsubscribe`

Delete a subscription to a list by list ID and user ID.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_unsubscribe '{}' --json

Shortcut

kosmo integrations:courier courier_lists_unsubscribe '{}' --json

`courier.courier_lists_update`

Create or replace an existing list with the supplied values.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_update '{}' --json

Shortcut

kosmo integrations:courier courier_lists_update '{}' --json

`courier.courier_lists_update_subscribers`

Subscribes the users to the list, overwriting existing subscriptions.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_lists_update_subscribers '{}' --json

Shortcut

kosmo integrations:courier courier_lists_update_subscribers '{}' --json

`courier.courier_messages_archive`

Archive message.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_messages_archive '{}' --json

Shortcut

kosmo integrations:courier courier_messages_archive '{}' --json

`courier.courier_messages_cancel`

Cancel a message that is currently in the process of being delivered.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_messages_cancel '{}' --json

Shortcut

kosmo integrations:courier courier_messages_cancel '{}' --json

`courier.courier_messages_get`

Fetch the status of a message you've previously sent.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_messages_get '{}' --json

Shortcut

kosmo integrations:courier courier_messages_get '{}' --json

`courier.courier_messages_get_content`

Get message content.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_messages_get_content '{}' --json

Shortcut

kosmo integrations:courier courier_messages_get_content '{}' --json

`courier.courier_messages_get_history`

Fetch the array of events of a message you've previously sent.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_messages_get_history '{}' --json

Shortcut

kosmo integrations:courier courier_messages_get_history '{}' --json

`courier.courier_messages_list`

Fetch the statuses of messages you've previously sent.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_messages_list '{}' --json

Shortcut

kosmo integrations:courier courier_messages_list '{}' --json

`courier.courier_notifications_archive`

Archive a notification template.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_notifications_archive '{}' --json

Shortcut

kosmo integrations:courier courier_notifications_archive '{}' --json

`courier.courier_notifications_create`

Create a notification template.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_notifications_create '{}' --json

Shortcut

kosmo integrations:courier courier_notifications_create '{}' --json

`courier.courier_notifications_list`

List notification templates in your workspace.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_notifications_list '{}' --json

Shortcut

kosmo integrations:courier courier_notifications_list '{}' --json

`courier.courier_notifications_list_versions`

List versions of a notification template.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_notifications_list_versions '{}' --json

Shortcut

kosmo integrations:courier courier_notifications_list_versions '{}' --json

`courier.courier_notifications_publish`

Publish a notification template.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_notifications_publish '{}' --json

Shortcut

kosmo integrations:courier courier_notifications_publish '{}' --json

`courier.courier_notifications_replace`

Replace a notification template.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_notifications_replace '{}' --json

Shortcut

kosmo integrations:courier courier_notifications_replace '{}' --json

`courier.courier_notifications_retrieve`

Retrieve a notification template by ID.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_notifications_retrieve '{}' --json

Shortcut

kosmo integrations:courier courier_notifications_retrieve '{}' --json

`courier.courier_profiles_create`

Merge the supplied values with an existing profile or create a new profile if one doesn't already exist.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_create '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_create '{}' --json

`courier.courier_profiles_delete`

Deletes the specified user profile.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_delete '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_delete '{}' --json

`courier.courier_profiles_delete_list_subscription`

Removes all list subscriptions for given user.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_delete_list_subscription '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_delete_list_subscription '{}' --json

`courier.courier_profiles_get`

Returns the specified user profile.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_get '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_get '{}' --json

`courier.courier_profiles_get_list_subscriptions`

Returns the subscribed lists for a specified user.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_get_list_subscriptions '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_get_list_subscriptions '{}' --json

`courier.courier_profiles_merge_profile`

Update a profile.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_merge_profile '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_merge_profile '{}' --json

`courier.courier_profiles_replace`

When using PUT, be sure to include all the key-value pairs required by the recipient's profile.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_replace '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_replace '{}' --json

`courier.courier_profiles_subscribe_to_list`

Subscribes the given user to one or more lists.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_profiles_subscribe_to_list '{}' --json

Shortcut

kosmo integrations:courier courier_profiles_subscribe_to_list '{}' --json

`courier.courier_routing_strategies_archive`

Archive a routing strategy.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_routing_strategies_archive '{}' --json

Shortcut

kosmo integrations:courier courier_routing_strategies_archive '{}' --json

`courier.courier_routing_strategies_create`

Create a routing strategy.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_routing_strategies_create '{}' --json

Shortcut

kosmo integrations:courier courier_routing_strategies_create '{}' --json

`courier.courier_routing_strategies_list`

List routing strategies in your workspace.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_routing_strategies_list '{}' --json

Shortcut

kosmo integrations:courier courier_routing_strategies_list '{}' --json

`courier.courier_routing_strategies_replace`

Replace a routing strategy.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_routing_strategies_replace '{}' --json

Shortcut

kosmo integrations:courier courier_routing_strategies_replace '{}' --json

`courier.courier_routing_strategies_retrieve`

Retrieve a routing strategy by ID.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_routing_strategies_retrieve '{}' --json

Shortcut

kosmo integrations:courier courier_routing_strategies_retrieve '{}' --json

`courier.courier_send`

Send a message to one or more recipients.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_send '{}' --json

Shortcut

kosmo integrations:courier courier_send '{}' --json

`courier.courier_tenants_create_or_replace`

Create or Replace a Tenant.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_create_or_replace '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_create_or_replace '{}' --json

`courier.courier_tenants_create_or_replace_default_preferences_for_topic`

Create or Replace Default Preferences For Topic.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_create_or_replace_default_preferences_for_topic '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_create_or_replace_default_preferences_for_topic '{}' --json

`courier.courier_tenants_delete`

Delete a Tenant.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_delete '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_delete '{}' --json

`courier.courier_tenants_get`

Get a Tenant.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_get '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_get '{}' --json

`courier.courier_tenants_get_template_by_tenant`

Get a Template in Tenant.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_get_template_by_tenant '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_get_template_by_tenant '{}' --json

`courier.courier_tenants_get_template_list_by_tenant`

List Templates in Tenant.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_get_template_list_by_tenant '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_get_template_list_by_tenant '{}' --json

`courier.courier_tenants_get_template_version`

Fetches a specific version of a tenant template.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_get_template_version '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_get_template_version '{}' --json

`courier.courier_tenants_get_users_by_tenant`

Get Users in Tenant.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_get_users_by_tenant '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_get_users_by_tenant '{}' --json

`courier.courier_tenants_list`

Get a List of Tenants.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_list '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_list '{}' --json

`courier.courier_tenants_publish_template`

Publishes a specific version of a notification template for a tenant.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_publish_template '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_publish_template '{}' --json

`courier.courier_tenants_remove_default_preferences_for_topic`

Remove Default Preferences For Topic.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_remove_default_preferences_for_topic '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_remove_default_preferences_for_topic '{}' --json

`courier.courier_tenants_replace_template`

Creates or updates a notification template for a tenant.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_tenants_replace_template '{}' --json

Shortcut

kosmo integrations:courier courier_tenants_replace_template '{}' --json

`courier.courier_translations_get`

Get translations by locale.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_translations_get '{}' --json

Shortcut

kosmo integrations:courier courier_translations_get '{}' --json

`courier.courier_translations_update`

Update a translation.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_translations_update '{}' --json

Shortcut

kosmo integrations:courier courier_translations_update '{}' --json

`courier.courier_users_preferences_get`

Fetch user preferences for a specific subscription topic.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_preferences_get '{}' --json

Shortcut

kosmo integrations:courier courier_users_preferences_get '{}' --json

`courier.courier_users_preferences_list`

Fetch all user preferences.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_preferences_list '{}' --json

Shortcut

kosmo integrations:courier courier_users_preferences_list '{}' --json

`courier.courier_users_preferences_update`

Update or Create user preferences for a specific subscription topic.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_preferences_update '{}' --json

Shortcut

kosmo integrations:courier courier_users_preferences_update '{}' --json

`courier.courier_users_tenants_add`

This endpoint is used to add a single tenant.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tenants_add '{}' --json

Shortcut

kosmo integrations:courier courier_users_tenants_add '{}' --json

`courier.courier_users_tenants_add_multiple`

This endpoint is used to add a user to multiple tenants in one call.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tenants_add_multiple '{}' --json

Shortcut

kosmo integrations:courier courier_users_tenants_add_multiple '{}' --json

`courier.courier_users_tenants_list`

Returns a paginated list of user tenant associations.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tenants_list '{}' --json

Shortcut

kosmo integrations:courier courier_users_tenants_list '{}' --json

`courier.courier_users_tenants_remove`

Removes a user from the supplied tenant.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tenants_remove '{}' --json

Shortcut

kosmo integrations:courier courier_users_tenants_remove '{}' --json

`courier.courier_users_tenants_remove_all`

Removes a user from any tenants they may have been associated with.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tenants_remove_all '{}' --json

Shortcut

kosmo integrations:courier courier_users_tenants_remove_all '{}' --json

`courier.courier_users_tokens_add`

Adds a single token to a user and overwrites a matching existing token.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tokens_add '{}' --json

Shortcut

kosmo integrations:courier courier_users_tokens_add '{}' --json

`courier.courier_users_tokens_add_multiple`

Adds multiple tokens to a user and overwrites matching existing tokens.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tokens_add_multiple '{}' --json

Shortcut

kosmo integrations:courier courier_users_tokens_add_multiple '{}' --json

`courier.courier_users_tokens_delete`

Delete User Token.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tokens_delete '{}' --json

Shortcut

kosmo integrations:courier courier_users_tokens_delete '{}' --json

`courier.courier_users_tokens_get`

Get single token available for a :token.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tokens_get '{}' --json

Shortcut

kosmo integrations:courier courier_users_tokens_get '{}' --json

`courier.courier_users_tokens_list`

Gets all tokens available for a :user_id.

Read read

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tokens_list '{}' --json

Shortcut

kosmo integrations:courier courier_users_tokens_list '{}' --json

`courier.courier_users_tokens_update`

Apply a JSON Patch (RFC 6902) to the specified token.

Write write

Parameters: none

Generic call

kosmo integrations:call courier.courier_users_tokens_update '{}' --json

Shortcut

kosmo integrations:courier courier_users_tokens_update '{}' --json

Function Schemas

Use these parameter tables when building CLI payloads without calling integrations:schema first.

courier.courier_audiences_delete 0 parameters

Schema command

kosmo integrations:schema courier.courier_audiences_delete --json

Parameter	Type	Required	Description
No parameters.

courier.courier_audiences_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_audiences_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_audiences_list_audiences 0 parameters

Schema command

kosmo integrations:schema courier.courier_audiences_list_audiences --json

Parameter	Type	Required	Description
No parameters.

courier.courier_audiences_list_members 0 parameters

Schema command

kosmo integrations:schema courier.courier_audiences_list_members --json

Parameter	Type	Required	Description
No parameters.

courier.courier_audiences_update 0 parameters

Schema command

kosmo integrations:schema courier.courier_audiences_update --json

Parameter	Type	Required	Description
No parameters.

courier.courier_audit_events_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_audit_events_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_audit_events_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_audit_events_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_auth_tokens_issue_token 0 parameters

Schema command

kosmo integrations:schema courier.courier_auth_tokens_issue_token --json

Parameter	Type	Required	Description
No parameters.

courier.courier_automations_invoke_ad_hoc_automation 0 parameters

Schema command

kosmo integrations:schema courier.courier_automations_invoke_ad_hoc_automation --json

Parameter	Type	Required	Description
No parameters.

courier.courier_automations_invoke_automation_template 0 parameters

Schema command

kosmo integrations:schema courier.courier_automations_invoke_automation_template --json

Parameter	Type	Required	Description
No parameters.

courier.courier_automations_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_automations_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_brands_create 0 parameters

Schema command

kosmo integrations:schema courier.courier_brands_create --json

Parameter	Type	Required	Description
No parameters.

courier.courier_brands_delete 0 parameters

Schema command

kosmo integrations:schema courier.courier_brands_delete --json

Parameter	Type	Required	Description
No parameters.

courier.courier_brands_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_brands_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_brands_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_brands_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_brands_replace 0 parameters

Schema command

kosmo integrations:schema courier.courier_brands_replace --json

Parameter	Type	Required	Description
No parameters.

courier.courier_bulk_create_job 0 parameters

Schema command

kosmo integrations:schema courier.courier_bulk_create_job --json

Parameter	Type	Required	Description
No parameters.

courier.courier_bulk_get_job 0 parameters

Schema command

kosmo integrations:schema courier.courier_bulk_get_job --json

Parameter	Type	Required	Description
No parameters.

courier.courier_bulk_get_users 0 parameters

Schema command

kosmo integrations:schema courier.courier_bulk_get_users --json

Parameter	Type	Required	Description
No parameters.

courier.courier_bulk_ingest_users 0 parameters

Schema command

kosmo integrations:schema courier.courier_bulk_ingest_users --json

Parameter	Type	Required	Description
No parameters.

courier.courier_bulk_run_job 0 parameters

Schema command

kosmo integrations:schema courier.courier_bulk_run_job --json

Parameter	Type	Required	Description
No parameters.

courier.courier_inbound_track 0 parameters

Schema command

kosmo integrations:schema courier.courier_inbound_track --json

Parameter	Type	Required	Description
No parameters.

courier.courier_journeys_invoke 0 parameters

Schema command

kosmo integrations:schema courier.courier_journeys_invoke --json

Parameter	Type	Required	Description
No parameters.

courier.courier_journeys_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_journeys_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_add_subscribers 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_add_subscribers --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_delete 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_delete --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_get_subscribers 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_get_subscribers --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_restore 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_restore --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_subscribe 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_subscribe --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_unsubscribe 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_unsubscribe --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_update 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_update --json

Parameter	Type	Required	Description
No parameters.

courier.courier_lists_update_subscribers 0 parameters

Schema command

kosmo integrations:schema courier.courier_lists_update_subscribers --json

Parameter	Type	Required	Description
No parameters.

courier.courier_messages_archive 0 parameters

Schema command

kosmo integrations:schema courier.courier_messages_archive --json

Parameter	Type	Required	Description
No parameters.

courier.courier_messages_cancel 0 parameters

Schema command

kosmo integrations:schema courier.courier_messages_cancel --json

Parameter	Type	Required	Description
No parameters.

courier.courier_messages_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_messages_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_messages_get_content 0 parameters

Schema command

kosmo integrations:schema courier.courier_messages_get_content --json

Parameter	Type	Required	Description
No parameters.

courier.courier_messages_get_history 0 parameters

Schema command

kosmo integrations:schema courier.courier_messages_get_history --json

Parameter	Type	Required	Description
No parameters.

courier.courier_messages_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_messages_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_notifications_archive 0 parameters

Schema command

kosmo integrations:schema courier.courier_notifications_archive --json

Parameter	Type	Required	Description
No parameters.

courier.courier_notifications_create 0 parameters

Schema command

kosmo integrations:schema courier.courier_notifications_create --json

Parameter	Type	Required	Description
No parameters.

courier.courier_notifications_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_notifications_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_notifications_list_versions 0 parameters

Schema command

kosmo integrations:schema courier.courier_notifications_list_versions --json

Parameter	Type	Required	Description
No parameters.

courier.courier_notifications_publish 0 parameters

Schema command

kosmo integrations:schema courier.courier_notifications_publish --json

Parameter	Type	Required	Description
No parameters.

courier.courier_notifications_replace 0 parameters

Schema command

kosmo integrations:schema courier.courier_notifications_replace --json

Parameter	Type	Required	Description
No parameters.

courier.courier_notifications_retrieve 0 parameters

Schema command

kosmo integrations:schema courier.courier_notifications_retrieve --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_create 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_create --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_delete 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_delete --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_delete_list_subscription 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_delete_list_subscription --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_get_list_subscriptions 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_get_list_subscriptions --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_merge_profile 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_merge_profile --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_replace 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_replace --json

Parameter	Type	Required	Description
No parameters.

courier.courier_profiles_subscribe_to_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_profiles_subscribe_to_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_routing_strategies_archive 0 parameters

Schema command

kosmo integrations:schema courier.courier_routing_strategies_archive --json

Parameter	Type	Required	Description
No parameters.

courier.courier_routing_strategies_create 0 parameters

Schema command

kosmo integrations:schema courier.courier_routing_strategies_create --json

Parameter	Type	Required	Description
No parameters.

courier.courier_routing_strategies_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_routing_strategies_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_routing_strategies_replace 0 parameters

Schema command

kosmo integrations:schema courier.courier_routing_strategies_replace --json

Parameter	Type	Required	Description
No parameters.

courier.courier_routing_strategies_retrieve 0 parameters

Schema command

kosmo integrations:schema courier.courier_routing_strategies_retrieve --json

Parameter	Type	Required	Description
No parameters.

courier.courier_send 0 parameters

Schema command

kosmo integrations:schema courier.courier_send --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_create_or_replace 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_create_or_replace --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_create_or_replace_default_preferences_for_topic 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_create_or_replace_default_preferences_for_topic --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_delete 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_delete --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_get_template_by_tenant 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_get_template_by_tenant --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_get_template_list_by_tenant 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_get_template_list_by_tenant --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_get_template_version 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_get_template_version --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_get_users_by_tenant 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_get_users_by_tenant --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_publish_template 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_publish_template --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_remove_default_preferences_for_topic 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_remove_default_preferences_for_topic --json

Parameter	Type	Required	Description
No parameters.

courier.courier_tenants_replace_template 0 parameters

Schema command

kosmo integrations:schema courier.courier_tenants_replace_template --json

Parameter	Type	Required	Description
No parameters.

courier.courier_translations_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_translations_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_translations_update 0 parameters

Schema command

kosmo integrations:schema courier.courier_translations_update --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_preferences_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_preferences_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_preferences_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_preferences_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_preferences_update 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_preferences_update --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tenants_add 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tenants_add --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tenants_add_multiple 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tenants_add_multiple --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tenants_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tenants_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tenants_remove 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tenants_remove --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tenants_remove_all 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tenants_remove_all --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tokens_add 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tokens_add --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tokens_add_multiple 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tokens_add_multiple --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tokens_delete 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tokens_delete --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tokens_get 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tokens_get --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tokens_list 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tokens_list --json

Parameter	Type	Required	Description
No parameters.

courier.courier_users_tokens_update 0 parameters

Schema command

kosmo integrations:schema courier.courier_users_tokens_update --json

Parameter	Type	Required	Description
No parameters.

Permissions

Headless calls still follow the integration read/write permission policy. Configure read/write defaults with integrations:configure. Add --force only for trusted automation that should bypass that policy.