KosmoKrator

productivity

Courier Lua API for KosmoKrator Agents

Agent-facing Lua documentation and function reference for the Courier KosmoKrator integration.

Lua Namespace

Agents call this integration through app.integrations.courier.*. Use lua_read_doc("integrations.courier") inside KosmoKrator to discover the same reference at runtime.

Call Lua from the Headless CLI

Use kosmo integrations:lua when a shell script, CI job, cron job, or another coding CLI should run a deterministic Courier workflow without starting an interactive agent session.

Inline Lua call 
kosmo integrations:lua --eval 'dump(app.integrations.courier.delete_audience({}))' --json
Read Lua docs headlessly 
kosmo integrations:lua --eval 'print(docs.read("courier"))' --json
kosmo integrations:lua --eval 'print(docs.read("courier.delete_audience"))' --json

Workflow file

Put repeatable logic in a Lua file, then execute it with JSON output for the calling process.

workflow.lua 
local courier = app.integrations.courier
local result = courier.delete_audience({})

dump(result)
Run the workflow 
kosmo integrations:lua workflow.lua --json
kosmo integrations:lua workflow.lua --force --json
Namespace note. integrations:lua exposes app.integrations.courier, app.mcp.*, docs.*, json.*, and regex.*. Use app.integrations.courier.default.* or app.integrations.courier.work.* when you configured named credential accounts.

MCP-only Lua

If the script only needs configured MCP servers and does not need Courier, use the narrower mcp:lua command.

MCP Lua command 
# Use mcp:lua for MCP-only scripts; use integrations:lua for this integration namespace.
kosmo mcp:lua --eval 'dump(mcp.servers())' --json

Agent-Facing Lua Docs

This is the rendered version of the full Lua documentation exposed to agents when they inspect the integration namespace.

Courier Integration

Namespace: app.integrations.courier.

This integration follows the official Courier API reference linked from https://www.courier.com/docs/llms.txt. Use top-level snake_case arguments for path and query parameters. Use payload for JSON request bodies.

Important behavior notes from Courier docs: use profile merge operations for partial profile updates, use profile replace only for full replacement, and run bulk sends as create job, add users, then run job.

Tools

courier_audiences_delete

Deletes the specified audience.

  • Method/path: DELETE /audiences/{audience_id}
  • Parameters: audience_id required

courier_audiences_get

Returns the specified audience by id.

  • Method/path: GET /audiences/{audience_id}
  • Parameters: audience_id required

courier_audiences_list_audiences

Get the audiences associated with the authorization token.

  • Method/path: GET /audiences
  • Parameters: cursor

courier_audiences_list_members

Get list of members of an audience.

  • Method/path: GET /audiences/{audience_id}/members
  • Parameters: audience_id required, cursor

courier_audiences_update

Creates or updates audience.

  • Method/path: PUT /audiences/{audience_id}
  • Parameters: audience_id required
  • Body: payload required

courier_audit_events_get

Fetch a specific audit event by ID.

  • Method/path: GET /audit-events/{audit-event-id}
  • Parameters: audit_event_id required

courier_audit_events_list

Fetch the list of audit events.

  • Method/path: GET /audit-events
  • Parameters: cursor

courier_auth_tokens_issue_token

Returns a new access token.

  • Method/path: POST /auth/issue-token
  • Parameters: none
  • Body: payload required

courier_automations_invoke_ad_hoc_automation

Invoke an ad hoc automation run.

  • Method/path: POST /automations/invoke
  • Parameters: none
  • Body: payload required

courier_automations_invoke_automation_template

Invoke an automation run from an automation template.

  • Method/path: POST /automations/{templateId}/invoke
  • Parameters: template_id required
  • Body: payload required

courier_automations_list

Get the list of automations.

  • Method/path: GET /automations
  • Parameters: cursor, version

courier_brands_create

Create a new brand.

  • Method/path: POST /brands
  • Parameters: none
  • Body: payload required

courier_brands_delete

Delete a brand by brand ID.

  • Method/path: DELETE /brands/{brand_id}
  • Parameters: brand_id required

courier_brands_get

Fetch a specific brand by brand ID.

  • Method/path: GET /brands/{brand_id}
  • Parameters: brand_id required

courier_brands_list

Get the list of brands.

  • Method/path: GET /brands
  • Parameters: cursor

courier_brands_replace

Replace an existing brand with the supplied values.

  • Method/path: PUT /brands/{brand_id}
  • Parameters: brand_id required
  • Body: payload required

courier_bulk_create_job

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

  • Method/path: POST /bulk
  • Parameters: none
  • Body: payload required

courier_bulk_get_job

Get a bulk job.

  • Method/path: GET /bulk/{job_id}
  • Parameters: job_id required

courier_bulk_get_users

Get Bulk Job Users.

  • Method/path: GET /bulk/{job_id}/users
  • Parameters: job_id required, cursor

courier_bulk_ingest_users

Ingest user data into a Bulk Job.

  • Method/path: POST /bulk/{job_id}
  • Parameters: job_id required
  • Body: payload required

courier_bulk_run_job

Run a bulk job.

  • Method/path: POST /bulk/{job_id}/run
  • Parameters: job_id required

courier_inbound_track

Courier Track Event.

  • Method/path: POST /inbound/courier
  • Parameters: none
  • Body: payload required

courier_journeys_invoke

Invoke a journey run from a journey template.

  • Method/path: POST /journeys/{templateId}/invoke
  • Parameters: template_id required
  • Body: payload required

courier_journeys_list

Get the list of journeys.

  • Method/path: GET /journeys
  • Parameters: cursor, version

courier_lists_add_subscribers

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

  • Method/path: POST /lists/{list_id}/subscriptions
  • Parameters: list_id required
  • Body: payload required

courier_lists_delete

Delete a list by list ID.

  • Method/path: DELETE /lists/{list_id}
  • Parameters: list_id required

courier_lists_get

Returns a list based on the list ID provided.

  • Method/path: GET /lists/{list_id}
  • Parameters: list_id required

courier_lists_get_subscribers

Get the list’s subscriptions.

  • Method/path: GET /lists/{list_id}/subscriptions
  • Parameters: list_id required, cursor

courier_lists_list

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

  • Method/path: GET /lists
  • Parameters: cursor, pattern

courier_lists_restore

Restore a previously deleted list.

  • Method/path: PUT /lists/{list_id}/restore
  • Parameters: list_id required
  • Body: payload required

courier_lists_subscribe

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

  • Method/path: PUT /lists/{list_id}/subscriptions/{user_id}
  • Parameters: list_id required, user_id required
  • Body: payload required

courier_lists_unsubscribe

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

  • Method/path: DELETE /lists/{list_id}/subscriptions/{user_id}
  • Parameters: list_id required, user_id required

courier_lists_update

Create or replace an existing list with the supplied values.

  • Method/path: PUT /lists/{list_id}
  • Parameters: list_id required
  • Body: payload required

courier_lists_update_subscribers

Subscribes the users to the list, overwriting existing subscriptions.

  • Method/path: PUT /lists/{list_id}/subscriptions
  • Parameters: list_id required
  • Body: payload required

courier_messages_archive

Archive message.

  • Method/path: PUT /requests/{request_id}/archive
  • Parameters: request_id required

courier_messages_cancel

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

  • Method/path: POST /messages/{message_id}/cancel
  • Parameters: message_id required

courier_messages_get

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

  • Method/path: GET /messages/{message_id}
  • Parameters: message_id required

courier_messages_get_content

Get message content.

  • Method/path: GET /messages/{message_id}/output
  • Parameters: message_id required

courier_messages_get_history

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

  • Method/path: GET /messages/{message_id}/history
  • Parameters: message_id required, type

courier_messages_list

Fetch the statuses of messages you’ve previously sent.

  • Method/path: GET /messages
  • Parameters: archived, cursor, event, list, message_id, notification, provider, recipient, status, tag, tags, tenant_id, enqueued_after, trace_id

courier_notifications_archive

Archive a notification template.

  • Method/path: DELETE /notifications/{id}
  • Parameters: id required

courier_notifications_create

Create a notification template.

  • Method/path: POST /notifications
  • Parameters: none
  • Body: payload required

courier_notifications_list

List notification templates in your workspace.

  • Method/path: GET /notifications
  • Parameters: cursor, notes, event_id

courier_notifications_list_versions

List versions of a notification template.

  • Method/path: GET /notifications/{id}/versions
  • Parameters: id required, cursor, limit

courier_notifications_publish

Publish a notification template.

  • Method/path: POST /notifications/{id}/publish
  • Parameters: id required
  • Body: payload

courier_notifications_replace

Replace a notification template.

  • Method/path: PUT /notifications/{id}
  • Parameters: id required
  • Body: payload required

courier_notifications_retrieve

Retrieve a notification template by ID.

  • Method/path: GET /notifications/{id}
  • Parameters: id required, version

courier_profiles_create

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

  • Method/path: POST /profiles/{user_id}
  • Parameters: user_id required
  • Body: payload required

courier_profiles_delete

Deletes the specified user profile.

  • Method/path: DELETE /profiles/{user_id}
  • Parameters: user_id required

courier_profiles_delete_list_subscription

Removes all list subscriptions for given user.

  • Method/path: DELETE /profiles/{user_id}/lists
  • Parameters: user_id required

courier_profiles_get

Returns the specified user profile.

  • Method/path: GET /profiles/{user_id}
  • Parameters: user_id required

courier_profiles_get_list_subscriptions

Returns the subscribed lists for a specified user.

  • Method/path: GET /profiles/{user_id}/lists
  • Parameters: user_id required, cursor

courier_profiles_merge_profile

Update a profile.

  • Method/path: PATCH /profiles/{user_id}
  • Parameters: user_id required
  • Body: payload required

courier_profiles_replace

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

  • Method/path: PUT /profiles/{user_id}
  • Parameters: user_id required
  • Body: payload required

courier_profiles_subscribe_to_list

Subscribes the given user to one or more lists.

  • Method/path: POST /profiles/{user_id}/lists
  • Parameters: user_id required
  • Body: payload required

courier_routing_strategies_archive

Archive a routing strategy.

  • Method/path: DELETE /routing-strategies/{id}
  • Parameters: id required

courier_routing_strategies_create

Create a routing strategy.

  • Method/path: POST /routing-strategies
  • Parameters: none
  • Body: payload required

courier_routing_strategies_list

List routing strategies in your workspace.

  • Method/path: GET /routing-strategies
  • Parameters: cursor, limit

courier_routing_strategies_replace

Replace a routing strategy.

  • Method/path: PUT /routing-strategies/{id}
  • Parameters: id required
  • Body: payload required

courier_routing_strategies_retrieve

Retrieve a routing strategy by ID.

  • Method/path: GET /routing-strategies/{id}
  • Parameters: id required

courier_send

Send a message to one or more recipients.

  • Method/path: POST /send
  • Parameters: none
  • Body: payload required

courier_tenants_create_or_replace

Create or Replace a Tenant.

  • Method/path: PUT /tenants/{tenant_id}
  • Parameters: tenant_id required
  • Body: payload required

courier_tenants_create_or_replace_default_preferences_for_topic

Create or Replace Default Preferences For Topic.

  • Method/path: PUT /tenants/{tenant_id}/default_preferences/items/{topic_id}
  • Parameters: tenant_id required, topic_id required
  • Body: payload required

courier_tenants_delete

Delete a Tenant.

  • Method/path: DELETE /tenants/{tenant_id}
  • Parameters: tenant_id required

courier_tenants_get

Get a Tenant.

  • Method/path: GET /tenants/{tenant_id}
  • Parameters: tenant_id required

courier_tenants_get_template_by_tenant

Get a Template in Tenant.

  • Method/path: GET /tenants/{tenant_id}/templates/{template_id}
  • Parameters: tenant_id required, template_id required

courier_tenants_get_template_list_by_tenant

List Templates in Tenant.

  • Method/path: GET /tenants/{tenant_id}/templates
  • Parameters: tenant_id required, limit, cursor

courier_tenants_get_template_version

Fetches a specific version of a tenant template.

  • Method/path: GET /tenants/{tenant_id}/templates/{template_id}/versions/{version}
  • Parameters: tenant_id required, template_id required, version required

courier_tenants_get_users_by_tenant

Get Users in Tenant.

  • Method/path: GET /tenants/{tenant_id}/users
  • Parameters: tenant_id required, limit, cursor

courier_tenants_list

Get a List of Tenants.

  • Method/path: GET /tenants
  • Parameters: parent_tenant_id, limit, cursor

courier_tenants_publish_template

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

  • Method/path: POST /tenants/{tenant_id}/templates/{template_id}/publish
  • Parameters: tenant_id required, template_id required
  • Body: payload

courier_tenants_remove_default_preferences_for_topic

Remove Default Preferences For Topic.

  • Method/path: DELETE /tenants/{tenant_id}/default_preferences/items/{topic_id}
  • Parameters: tenant_id required, topic_id required

courier_tenants_replace_template

Creates or updates a notification template for a tenant.

  • Method/path: PUT /tenants/{tenant_id}/templates/{template_id}
  • Parameters: tenant_id required, template_id required
  • Body: payload required

courier_translations_get

Get translations by locale.

  • Method/path: GET /translations/{domain}/{locale}
  • Parameters: domain required, locale required

courier_translations_update

Update a translation.

  • Method/path: PUT /translations/{domain}/{locale}
  • Parameters: domain required, locale required
  • Body: payload required

courier_users_preferences_get

Fetch user preferences for a specific subscription topic.

  • Method/path: GET /users/{user_id}/preferences/{topic_id}
  • Parameters: user_id required, topic_id required, tenant_id

courier_users_preferences_list

Fetch all user preferences.

  • Method/path: GET /users/{user_id}/preferences
  • Parameters: user_id required, tenant_id

courier_users_preferences_update

Update or Create user preferences for a specific subscription topic.

  • Method/path: PUT /users/{user_id}/preferences/{topic_id}
  • Parameters: user_id required, topic_id required, tenant_id
  • Body: payload required

courier_users_tenants_add

This endpoint is used to add a single tenant.

  • Method/path: PUT /users/{user_id}/tenants/{tenant_id}
  • Parameters: user_id required, tenant_id required
  • Body: payload required

courier_users_tenants_add_multiple

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

  • Method/path: PUT /users/{user_id}/tenants
  • Parameters: user_id required
  • Body: payload required

courier_users_tenants_list

Returns a paginated list of user tenant associations.

  • Method/path: GET /users/{user_id}/tenants
  • Parameters: user_id required, limit, cursor

courier_users_tenants_remove

Removes a user from the supplied tenant.

  • Method/path: DELETE /users/{user_id}/tenants/{tenant_id}
  • Parameters: user_id required, tenant_id required

courier_users_tenants_remove_all

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

  • Method/path: DELETE /users/{user_id}/tenants
  • Parameters: user_id required

courier_users_tokens_add

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

  • Method/path: PUT /users/{user_id}/tokens/{token}
  • Parameters: user_id required, token required
  • Body: payload required

courier_users_tokens_add_multiple

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

  • Method/path: PUT /users/{user_id}/tokens
  • Parameters: user_id required

courier_users_tokens_delete

Delete User Token.

  • Method/path: DELETE /users/{user_id}/tokens/{token}
  • Parameters: user_id required, token required

courier_users_tokens_get

Get single token available for a :token.

  • Method/path: GET /users/{user_id}/tokens/{token}
  • Parameters: user_id required, token required

courier_users_tokens_list

Gets all tokens available for a :user_id.

  • Method/path: GET /users/{user_id}/tokens
  • Parameters: user_id required

courier_users_tokens_update

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

  • Method/path: PATCH /users/{user_id}/tokens/{token}
  • Parameters: user_id required, token required
  • Body: payload required

Example

local sent = app.integrations.courier.send({
  payload = {
    message = {
      to = { user_id = "user_123" },
      template = "template_id",
      data = { name = "Ada" }
    }
  }
})

local profile = app.integrations.courier.profiles_create({
  user_id = "user_123",
  payload = { profile = { email = "ada@example.test" } }
})
Raw agent markdown 
# Courier Integration

Namespace: `app.integrations.courier`.

This integration follows the official Courier API reference linked from `https://www.courier.com/docs/llms.txt`. Use top-level snake_case arguments for path and query parameters. Use `payload` for JSON request bodies.

Important behavior notes from Courier docs: use profile merge operations for partial profile updates, use profile replace only for full replacement, and run bulk sends as create job, add users, then run job.

## Tools

### courier_audiences_delete
Deletes the specified audience.

- Method/path: `DELETE /audiences/{audience_id}`
- Parameters: `audience_id` required

### courier_audiences_get
Returns the specified audience by id.

- Method/path: `GET /audiences/{audience_id}`
- Parameters: `audience_id` required

### courier_audiences_list_audiences
Get the audiences associated with the authorization token.

- Method/path: `GET /audiences`
- Parameters: `cursor`

### courier_audiences_list_members
Get list of members of an audience.

- Method/path: `GET /audiences/{audience_id}/members`
- Parameters: `audience_id` required, `cursor`

### courier_audiences_update
Creates or updates audience.

- Method/path: `PUT /audiences/{audience_id}`
- Parameters: `audience_id` required
- Body: `payload` required

### courier_audit_events_get
Fetch a specific audit event by ID.

- Method/path: `GET /audit-events/{audit-event-id}`
- Parameters: `audit_event_id` required

### courier_audit_events_list
Fetch the list of audit events.

- Method/path: `GET /audit-events`
- Parameters: `cursor`

### courier_auth_tokens_issue_token
Returns a new access token.

- Method/path: `POST /auth/issue-token`
- Parameters: none
- Body: `payload` required

### courier_automations_invoke_ad_hoc_automation
Invoke an ad hoc automation run.

- Method/path: `POST /automations/invoke`
- Parameters: none
- Body: `payload` required

### courier_automations_invoke_automation_template
Invoke an automation run from an automation template.

- Method/path: `POST /automations/{templateId}/invoke`
- Parameters: `template_id` required
- Body: `payload` required

### courier_automations_list
Get the list of automations.

- Method/path: `GET /automations`
- Parameters: `cursor`, `version`

### courier_brands_create
Create a new brand.

- Method/path: `POST /brands`
- Parameters: none
- Body: `payload` required

### courier_brands_delete
Delete a brand by brand ID.

- Method/path: `DELETE /brands/{brand_id}`
- Parameters: `brand_id` required

### courier_brands_get
Fetch a specific brand by brand ID.

- Method/path: `GET /brands/{brand_id}`
- Parameters: `brand_id` required

### courier_brands_list
Get the list of brands.

- Method/path: `GET /brands`
- Parameters: `cursor`

### courier_brands_replace
Replace an existing brand with the supplied values.

- Method/path: `PUT /brands/{brand_id}`
- Parameters: `brand_id` required
- Body: `payload` required

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

- Method/path: `POST /bulk`
- Parameters: none
- Body: `payload` required

### courier_bulk_get_job
Get a bulk job.

- Method/path: `GET /bulk/{job_id}`
- Parameters: `job_id` required

### courier_bulk_get_users
Get Bulk Job Users.

- Method/path: `GET /bulk/{job_id}/users`
- Parameters: `job_id` required, `cursor`

### courier_bulk_ingest_users
Ingest user data into a Bulk Job.

- Method/path: `POST /bulk/{job_id}`
- Parameters: `job_id` required
- Body: `payload` required

### courier_bulk_run_job
Run a bulk job.

- Method/path: `POST /bulk/{job_id}/run`
- Parameters: `job_id` required

### courier_inbound_track
Courier Track Event.

- Method/path: `POST /inbound/courier`
- Parameters: none
- Body: `payload` required

### courier_journeys_invoke
Invoke a journey run from a journey template.

- Method/path: `POST /journeys/{templateId}/invoke`
- Parameters: `template_id` required
- Body: `payload` required

### courier_journeys_list
Get the list of journeys.

- Method/path: `GET /journeys`
- Parameters: `cursor`, `version`

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

- Method/path: `POST /lists/{list_id}/subscriptions`
- Parameters: `list_id` required
- Body: `payload` required

### courier_lists_delete
Delete a list by list ID.

- Method/path: `DELETE /lists/{list_id}`
- Parameters: `list_id` required

### courier_lists_get
Returns a list based on the list ID provided.

- Method/path: `GET /lists/{list_id}`
- Parameters: `list_id` required

### courier_lists_get_subscribers
Get the list's subscriptions.

- Method/path: `GET /lists/{list_id}/subscriptions`
- Parameters: `list_id` required, `cursor`

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

- Method/path: `GET /lists`
- Parameters: `cursor`, `pattern`

### courier_lists_restore
Restore a previously deleted list.

- Method/path: `PUT /lists/{list_id}/restore`
- Parameters: `list_id` required
- Body: `payload` required

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

- Method/path: `PUT /lists/{list_id}/subscriptions/{user_id}`
- Parameters: `list_id` required, `user_id` required
- Body: `payload` required

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

- Method/path: `DELETE /lists/{list_id}/subscriptions/{user_id}`
- Parameters: `list_id` required, `user_id` required

### courier_lists_update
Create or replace an existing list with the supplied values.

- Method/path: `PUT /lists/{list_id}`
- Parameters: `list_id` required
- Body: `payload` required

### courier_lists_update_subscribers
Subscribes the users to the list, overwriting existing subscriptions.

- Method/path: `PUT /lists/{list_id}/subscriptions`
- Parameters: `list_id` required
- Body: `payload` required

### courier_messages_archive
Archive message.

- Method/path: `PUT /requests/{request_id}/archive`
- Parameters: `request_id` required

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

- Method/path: `POST /messages/{message_id}/cancel`
- Parameters: `message_id` required

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

- Method/path: `GET /messages/{message_id}`
- Parameters: `message_id` required

### courier_messages_get_content
Get message content.

- Method/path: `GET /messages/{message_id}/output`
- Parameters: `message_id` required

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

- Method/path: `GET /messages/{message_id}/history`
- Parameters: `message_id` required, `type`

### courier_messages_list
Fetch the statuses of messages you've previously sent.

- Method/path: `GET /messages`
- Parameters: `archived`, `cursor`, `event`, `list`, `message_id`, `notification`, `provider`, `recipient`, `status`, `tag`, `tags`, `tenant_id`, `enqueued_after`, `trace_id`

### courier_notifications_archive
Archive a notification template.

- Method/path: `DELETE /notifications/{id}`
- Parameters: `id` required

### courier_notifications_create
Create a notification template.

- Method/path: `POST /notifications`
- Parameters: none
- Body: `payload` required

### courier_notifications_list
List notification templates in your workspace.

- Method/path: `GET /notifications`
- Parameters: `cursor`, `notes`, `event_id`

### courier_notifications_list_versions
List versions of a notification template.

- Method/path: `GET /notifications/{id}/versions`
- Parameters: `id` required, `cursor`, `limit`

### courier_notifications_publish
Publish a notification template.

- Method/path: `POST /notifications/{id}/publish`
- Parameters: `id` required
- Body: `payload`

### courier_notifications_replace
Replace a notification template.

- Method/path: `PUT /notifications/{id}`
- Parameters: `id` required
- Body: `payload` required

### courier_notifications_retrieve
Retrieve a notification template by ID.

- Method/path: `GET /notifications/{id}`
- Parameters: `id` required, `version`

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

- Method/path: `POST /profiles/{user_id}`
- Parameters: `user_id` required
- Body: `payload` required

### courier_profiles_delete
Deletes the specified user profile.

- Method/path: `DELETE /profiles/{user_id}`
- Parameters: `user_id` required

### courier_profiles_delete_list_subscription
Removes all list subscriptions for given user.

- Method/path: `DELETE /profiles/{user_id}/lists`
- Parameters: `user_id` required

### courier_profiles_get
Returns the specified user profile.

- Method/path: `GET /profiles/{user_id}`
- Parameters: `user_id` required

### courier_profiles_get_list_subscriptions
Returns the subscribed lists for a specified user.

- Method/path: `GET /profiles/{user_id}/lists`
- Parameters: `user_id` required, `cursor`

### courier_profiles_merge_profile
Update a profile.

- Method/path: `PATCH /profiles/{user_id}`
- Parameters: `user_id` required
- Body: `payload` required

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

- Method/path: `PUT /profiles/{user_id}`
- Parameters: `user_id` required
- Body: `payload` required

### courier_profiles_subscribe_to_list
Subscribes the given user to one or more lists.

- Method/path: `POST /profiles/{user_id}/lists`
- Parameters: `user_id` required
- Body: `payload` required

### courier_routing_strategies_archive
Archive a routing strategy.

- Method/path: `DELETE /routing-strategies/{id}`
- Parameters: `id` required

### courier_routing_strategies_create
Create a routing strategy.

- Method/path: `POST /routing-strategies`
- Parameters: none
- Body: `payload` required

### courier_routing_strategies_list
List routing strategies in your workspace.

- Method/path: `GET /routing-strategies`
- Parameters: `cursor`, `limit`

### courier_routing_strategies_replace
Replace a routing strategy.

- Method/path: `PUT /routing-strategies/{id}`
- Parameters: `id` required
- Body: `payload` required

### courier_routing_strategies_retrieve
Retrieve a routing strategy by ID.

- Method/path: `GET /routing-strategies/{id}`
- Parameters: `id` required

### courier_send
Send a message to one or more recipients.

- Method/path: `POST /send`
- Parameters: none
- Body: `payload` required

### courier_tenants_create_or_replace
Create or Replace a Tenant.

- Method/path: `PUT /tenants/{tenant_id}`
- Parameters: `tenant_id` required
- Body: `payload` required

### courier_tenants_create_or_replace_default_preferences_for_topic
Create or Replace Default Preferences For Topic.

- Method/path: `PUT /tenants/{tenant_id}/default_preferences/items/{topic_id}`
- Parameters: `tenant_id` required, `topic_id` required
- Body: `payload` required

### courier_tenants_delete
Delete a Tenant.

- Method/path: `DELETE /tenants/{tenant_id}`
- Parameters: `tenant_id` required

### courier_tenants_get
Get a Tenant.

- Method/path: `GET /tenants/{tenant_id}`
- Parameters: `tenant_id` required

### courier_tenants_get_template_by_tenant
Get a Template in Tenant.

- Method/path: `GET /tenants/{tenant_id}/templates/{template_id}`
- Parameters: `tenant_id` required, `template_id` required

### courier_tenants_get_template_list_by_tenant
List Templates in Tenant.

- Method/path: `GET /tenants/{tenant_id}/templates`
- Parameters: `tenant_id` required, `limit`, `cursor`

### courier_tenants_get_template_version
Fetches a specific version of a tenant template.

- Method/path: `GET /tenants/{tenant_id}/templates/{template_id}/versions/{version}`
- Parameters: `tenant_id` required, `template_id` required, `version` required

### courier_tenants_get_users_by_tenant
Get Users in Tenant.

- Method/path: `GET /tenants/{tenant_id}/users`
- Parameters: `tenant_id` required, `limit`, `cursor`

### courier_tenants_list
Get a List of Tenants.

- Method/path: `GET /tenants`
- Parameters: `parent_tenant_id`, `limit`, `cursor`

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

- Method/path: `POST /tenants/{tenant_id}/templates/{template_id}/publish`
- Parameters: `tenant_id` required, `template_id` required
- Body: `payload`

### courier_tenants_remove_default_preferences_for_topic
Remove Default Preferences For Topic.

- Method/path: `DELETE /tenants/{tenant_id}/default_preferences/items/{topic_id}`
- Parameters: `tenant_id` required, `topic_id` required

### courier_tenants_replace_template
Creates or updates a notification template for a tenant.

- Method/path: `PUT /tenants/{tenant_id}/templates/{template_id}`
- Parameters: `tenant_id` required, `template_id` required
- Body: `payload` required

### courier_translations_get
Get translations by locale.

- Method/path: `GET /translations/{domain}/{locale}`
- Parameters: `domain` required, `locale` required

### courier_translations_update
Update a translation.

- Method/path: `PUT /translations/{domain}/{locale}`
- Parameters: `domain` required, `locale` required
- Body: `payload` required

### courier_users_preferences_get
Fetch user preferences for a specific subscription topic.

- Method/path: `GET /users/{user_id}/preferences/{topic_id}`
- Parameters: `user_id` required, `topic_id` required, `tenant_id`

### courier_users_preferences_list
Fetch all user preferences.

- Method/path: `GET /users/{user_id}/preferences`
- Parameters: `user_id` required, `tenant_id`

### courier_users_preferences_update
Update or Create user preferences for a specific subscription topic.

- Method/path: `PUT /users/{user_id}/preferences/{topic_id}`
- Parameters: `user_id` required, `topic_id` required, `tenant_id`
- Body: `payload` required

### courier_users_tenants_add
This endpoint is used to add a single tenant.

- Method/path: `PUT /users/{user_id}/tenants/{tenant_id}`
- Parameters: `user_id` required, `tenant_id` required
- Body: `payload` required

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

- Method/path: `PUT /users/{user_id}/tenants`
- Parameters: `user_id` required
- Body: `payload` required

### courier_users_tenants_list
Returns a paginated list of user tenant associations.

- Method/path: `GET /users/{user_id}/tenants`
- Parameters: `user_id` required, `limit`, `cursor`

### courier_users_tenants_remove
Removes a user from the supplied tenant.

- Method/path: `DELETE /users/{user_id}/tenants/{tenant_id}`
- Parameters: `user_id` required, `tenant_id` required

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

- Method/path: `DELETE /users/{user_id}/tenants`
- Parameters: `user_id` required

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

- Method/path: `PUT /users/{user_id}/tokens/{token}`
- Parameters: `user_id` required, `token` required
- Body: `payload` required

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

- Method/path: `PUT /users/{user_id}/tokens`
- Parameters: `user_id` required

### courier_users_tokens_delete
Delete User Token.

- Method/path: `DELETE /users/{user_id}/tokens/{token}`
- Parameters: `user_id` required, `token` required

### courier_users_tokens_get
Get single token available for a :token.

- Method/path: `GET /users/{user_id}/tokens/{token}`
- Parameters: `user_id` required, `token` required

### courier_users_tokens_list
Gets all tokens available for a :user_id.

- Method/path: `GET /users/{user_id}/tokens`
- Parameters: `user_id` required

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

- Method/path: `PATCH /users/{user_id}/tokens/{token}`
- Parameters: `user_id` required, `token` required
- Body: `payload` required

## Example

```lua
local sent = app.integrations.courier.send({
  payload = {
    message = {
      to = { user_id = "user_123" },
      template = "template_id",
      data = { name = "Ada" }
    }
  }
})

local profile = app.integrations.courier.profiles_create({
  user_id = "user_123",
  payload = { profile = { email = "ada@example.test" } }
})
```
Metadata-derived Lua example 
local result = app.integrations.courier.delete_audience({})
print(result)

Functions

delete_audience Write

Deletes the specified audience.

Lua path
app.integrations.courier.delete_audience
Full name
courier.courier_audiences_delete
ParameterTypeRequiredDescription
No parameters.
get_audience Read

Returns the specified audience by id.

Lua path
app.integrations.courier.get_audience
Full name
courier.courier_audiences_get
ParameterTypeRequiredDescription
No parameters.
list_all_audiences Read

Get the audiences associated with the authorization token.

Lua path
app.integrations.courier.list_all_audiences
Full name
courier.courier_audiences_list_audiences
ParameterTypeRequiredDescription
No parameters.
list_audience_members Read

Get list of members of an audience.

Lua path
app.integrations.courier.list_audience_members
Full name
courier.courier_audiences_list_members
ParameterTypeRequiredDescription
No parameters.
update_audience Write

Creates or updates audience.

Lua path
app.integrations.courier.update_audience
Full name
courier.courier_audiences_update
ParameterTypeRequiredDescription
No parameters.
get_audit_event Read

Fetch a specific audit event by ID.

Lua path
app.integrations.courier.get_audit_event
Full name
courier.courier_audit_events_get
ParameterTypeRequiredDescription
No parameters.
get_all_audit_events Read

Fetch the list of audit events.

Lua path
app.integrations.courier.get_all_audit_events
Full name
courier.courier_audit_events_list
ParameterTypeRequiredDescription
No parameters.
create_jwt Write

Returns a new access token.

Lua path
app.integrations.courier.create_jwt
Full name
courier.courier_auth_tokens_issue_token
ParameterTypeRequiredDescription
No parameters.
invoke_ad_hoc_automation Write

Invoke an ad hoc automation run.

Lua path
app.integrations.courier.invoke_ad_hoc_automation
Full name
courier.courier_automations_invoke_ad_hoc_automation
ParameterTypeRequiredDescription
No parameters.
invoke_automation Write

Invoke an automation run from an automation template.

Lua path
app.integrations.courier.invoke_automation
Full name
courier.courier_automations_invoke_automation_template
ParameterTypeRequiredDescription
No parameters.
list_automations Read

Get the list of automations.

Lua path
app.integrations.courier.list_automations
Full name
courier.courier_automations_list
ParameterTypeRequiredDescription
No parameters.
create_new_brand Write

Create a new brand.

Lua path
app.integrations.courier.create_new_brand
Full name
courier.courier_brands_create
ParameterTypeRequiredDescription
No parameters.
delete_brand Write

Delete a brand by brand ID.

Lua path
app.integrations.courier.delete_brand
Full name
courier.courier_brands_delete
ParameterTypeRequiredDescription
No parameters.
get_brand Read

Fetch a specific brand by brand ID.

Lua path
app.integrations.courier.get_brand
Full name
courier.courier_brands_get
ParameterTypeRequiredDescription
No parameters.
list_brands Read

Get the list of brands.

Lua path
app.integrations.courier.list_brands
Full name
courier.courier_brands_list
ParameterTypeRequiredDescription
No parameters.
replace_brand Write

Replace an existing brand with the supplied values.

Lua path
app.integrations.courier.replace_brand
Full name
courier.courier_brands_replace
ParameterTypeRequiredDescription
No parameters.
create_bulk_job Write

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

Lua path
app.integrations.courier.create_bulk_job
Full name
courier.courier_bulk_create_job
ParameterTypeRequiredDescription
No parameters.
get_job Read

Get a bulk job.

Lua path
app.integrations.courier.get_job
Full name
courier.courier_bulk_get_job
ParameterTypeRequiredDescription
No parameters.
get_users Read

Get Bulk Job Users.

Lua path
app.integrations.courier.get_users
Full name
courier.courier_bulk_get_users
ParameterTypeRequiredDescription
No parameters.
add_users Write

Ingest user data into a Bulk Job.

Lua path
app.integrations.courier.add_users
Full name
courier.courier_bulk_ingest_users
ParameterTypeRequiredDescription
No parameters.
run_job Write

Run a bulk job.

Lua path
app.integrations.courier.run_job
Full name
courier.courier_bulk_run_job
ParameterTypeRequiredDescription
No parameters.
track_event Write

Courier Track Event.

Lua path
app.integrations.courier.track_event
Full name
courier.courier_inbound_track
ParameterTypeRequiredDescription
No parameters.
invoke_journey Write

Invoke a journey run from a journey template.

Lua path
app.integrations.courier.invoke_journey
Full name
courier.courier_journeys_invoke
ParameterTypeRequiredDescription
No parameters.
list_journeys Read

Get the list of journeys.

Lua path
app.integrations.courier.list_journeys
Full name
courier.courier_journeys_list
ParameterTypeRequiredDescription
No parameters.
add_subscribers_list Write

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

Lua path
app.integrations.courier.add_subscribers_list
Full name
courier.courier_lists_add_subscribers
ParameterTypeRequiredDescription
No parameters.
delete_list Write

Delete a list by list ID.

Lua path
app.integrations.courier.delete_list
Full name
courier.courier_lists_delete
ParameterTypeRequiredDescription
No parameters.
get_list Read

Returns a list based on the list ID provided.

Lua path
app.integrations.courier.get_list
Full name
courier.courier_lists_get
ParameterTypeRequiredDescription
No parameters.
get_subscriptions_list Read

Get the list's subscriptions.

Lua path
app.integrations.courier.get_subscriptions_list
Full name
courier.courier_lists_get_subscribers
ParameterTypeRequiredDescription
No parameters.
get_all_lists Read

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

Lua path
app.integrations.courier.get_all_lists
Full name
courier.courier_lists_list
ParameterTypeRequiredDescription
No parameters.
restore_list Write

Restore a previously deleted list.

Lua path
app.integrations.courier.restore_list
Full name
courier.courier_lists_restore
ParameterTypeRequiredDescription
No parameters.
subscribe_single_user_profile_list Write

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

Lua path
app.integrations.courier.subscribe_single_user_profile_list
Full name
courier.courier_lists_subscribe
ParameterTypeRequiredDescription
No parameters.
unsubscribe_user_profile_from_list Write

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

Lua path
app.integrations.courier.unsubscribe_user_profile_from_list
Full name
courier.courier_lists_unsubscribe
ParameterTypeRequiredDescription
No parameters.
update_list Write

Create or replace an existing list with the supplied values.

Lua path
app.integrations.courier.update_list
Full name
courier.courier_lists_update
ParameterTypeRequiredDescription
No parameters.
subscribe_users_list Write

Subscribes the users to the list, overwriting existing subscriptions.

Lua path
app.integrations.courier.subscribe_users_list
Full name
courier.courier_lists_update_subscribers
ParameterTypeRequiredDescription
No parameters.
archive_message Write

Archive message.

Lua path
app.integrations.courier.archive_message
Full name
courier.courier_messages_archive
ParameterTypeRequiredDescription
No parameters.
cancel_message Write

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

Lua path
app.integrations.courier.cancel_message
Full name
courier.courier_messages_cancel
ParameterTypeRequiredDescription
No parameters.
get_message Read

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

Lua path
app.integrations.courier.get_message
Full name
courier.courier_messages_get
ParameterTypeRequiredDescription
No parameters.
get_message_content Read

Get message content.

Lua path
app.integrations.courier.get_message_content
Full name
courier.courier_messages_get_content
ParameterTypeRequiredDescription
No parameters.
get_message_history Read

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

Lua path
app.integrations.courier.get_message_history
Full name
courier.courier_messages_get_history
ParameterTypeRequiredDescription
No parameters.
list_messages Read

Fetch the statuses of messages you've previously sent.

Lua path
app.integrations.courier.list_messages
Full name
courier.courier_messages_list
ParameterTypeRequiredDescription
No parameters.
archive_notification_template Write

Archive a notification template.

Lua path
app.integrations.courier.archive_notification_template
Full name
courier.courier_notifications_archive
ParameterTypeRequiredDescription
No parameters.
create_notification_template Write

Create a notification template.

Lua path
app.integrations.courier.create_notification_template
Full name
courier.courier_notifications_create
ParameterTypeRequiredDescription
No parameters.
list_notification_templates Read

List notification templates in your workspace.

Lua path
app.integrations.courier.list_notification_templates
Full name
courier.courier_notifications_list
ParameterTypeRequiredDescription
No parameters.
list_notification_template_versions Read

List versions of a notification template.

Lua path
app.integrations.courier.list_notification_template_versions
Full name
courier.courier_notifications_list_versions
ParameterTypeRequiredDescription
No parameters.
publish_notification_template Write

Publish a notification template.

Lua path
app.integrations.courier.publish_notification_template
Full name
courier.courier_notifications_publish
ParameterTypeRequiredDescription
No parameters.
replace_notification_template Write

Replace a notification template.

Lua path
app.integrations.courier.replace_notification_template
Full name
courier.courier_notifications_replace
ParameterTypeRequiredDescription
No parameters.
get_notification_template Read

Retrieve a notification template by ID.

Lua path
app.integrations.courier.get_notification_template
Full name
courier.courier_notifications_retrieve
ParameterTypeRequiredDescription
No parameters.
create_profile Write

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

Lua path
app.integrations.courier.create_profile
Full name
courier.courier_profiles_create
ParameterTypeRequiredDescription
No parameters.
delete_profile Write

Deletes the specified user profile.

Lua path
app.integrations.courier.delete_profile
Full name
courier.courier_profiles_delete
ParameterTypeRequiredDescription
No parameters.
delete_list_subscriptions Write

Removes all list subscriptions for given user.

Lua path
app.integrations.courier.delete_list_subscriptions
Full name
courier.courier_profiles_delete_list_subscription
ParameterTypeRequiredDescription
No parameters.
get_profile Read

Returns the specified user profile.

Lua path
app.integrations.courier.get_profile
Full name
courier.courier_profiles_get
ParameterTypeRequiredDescription
No parameters.
get_list_subscriptions Read

Returns the subscribed lists for a specified user.

Lua path
app.integrations.courier.get_list_subscriptions
Full name
courier.courier_profiles_get_list_subscriptions
ParameterTypeRequiredDescription
No parameters.
update_profile Write

Update a profile.

Lua path
app.integrations.courier.update_profile
Full name
courier.courier_profiles_merge_profile
ParameterTypeRequiredDescription
No parameters.
replace_profile Write

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

Lua path
app.integrations.courier.replace_profile
Full name
courier.courier_profiles_replace
ParameterTypeRequiredDescription
No parameters.
subscribe_one_or_more_lists Write

Subscribes the given user to one or more lists.

Lua path
app.integrations.courier.subscribe_one_or_more_lists
Full name
courier.courier_profiles_subscribe_to_list
ParameterTypeRequiredDescription
No parameters.
archive_routing_strategy Write

Archive a routing strategy.

Lua path
app.integrations.courier.archive_routing_strategy
Full name
courier.courier_routing_strategies_archive
ParameterTypeRequiredDescription
No parameters.
create_routing_strategy Write

Create a routing strategy.

Lua path
app.integrations.courier.create_routing_strategy
Full name
courier.courier_routing_strategies_create
ParameterTypeRequiredDescription
No parameters.
list_routing_strategies Read

List routing strategies in your workspace.

Lua path
app.integrations.courier.list_routing_strategies
Full name
courier.courier_routing_strategies_list
ParameterTypeRequiredDescription
No parameters.
replace_routing_strategy Write

Replace a routing strategy.

Lua path
app.integrations.courier.replace_routing_strategy
Full name
courier.courier_routing_strategies_replace
ParameterTypeRequiredDescription
No parameters.
get_routing_strategy Read

Retrieve a routing strategy by ID.

Lua path
app.integrations.courier.get_routing_strategy
Full name
courier.courier_routing_strategies_retrieve
ParameterTypeRequiredDescription
No parameters.
send_message Write

Send a message to one or more recipients.

Lua path
app.integrations.courier.send_message
Full name
courier.courier_send
ParameterTypeRequiredDescription
No parameters.
create_or_replace_tenant Write

Create or Replace a Tenant.

Lua path
app.integrations.courier.create_or_replace_tenant
Full name
courier.courier_tenants_create_or_replace
ParameterTypeRequiredDescription
No parameters.
create_or_replace_default_preferences_topic Write

Create or Replace Default Preferences For Topic.

Lua path
app.integrations.courier.create_or_replace_default_preferences_topic
Full name
courier.courier_tenants_create_or_replace_default_preferences_for_topic
ParameterTypeRequiredDescription
No parameters.
delete_tenant Write

Delete a Tenant.

Lua path
app.integrations.courier.delete_tenant
Full name
courier.courier_tenants_delete
ParameterTypeRequiredDescription
No parameters.
get_tenant Read

Get a Tenant.

Lua path
app.integrations.courier.get_tenant
Full name
courier.courier_tenants_get
ParameterTypeRequiredDescription
No parameters.
get_template_tenant Read

Get a Template in Tenant.

Lua path
app.integrations.courier.get_template_tenant
Full name
courier.courier_tenants_get_template_by_tenant
ParameterTypeRequiredDescription
No parameters.
list_templates_tenant Read

List Templates in Tenant.

Lua path
app.integrations.courier.list_templates_tenant
Full name
courier.courier_tenants_get_template_list_by_tenant
ParameterTypeRequiredDescription
No parameters.
get_specific_template_version Read

Fetches a specific version of a tenant template.

Lua path
app.integrations.courier.get_specific_template_version
Full name
courier.courier_tenants_get_template_version
ParameterTypeRequiredDescription
No parameters.
get_users_tenant Read

Get Users in Tenant.

Lua path
app.integrations.courier.get_users_tenant
Full name
courier.courier_tenants_get_users_by_tenant
ParameterTypeRequiredDescription
No parameters.
get_list_tenants Read

Get a List of Tenants.

Lua path
app.integrations.courier.get_list_tenants
Full name
courier.courier_tenants_list
ParameterTypeRequiredDescription
No parameters.
publish_tenant_template Write

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

Lua path
app.integrations.courier.publish_tenant_template
Full name
courier.courier_tenants_publish_template
ParameterTypeRequiredDescription
No parameters.
remove_default_preferences_topic Write

Remove Default Preferences For Topic.

Lua path
app.integrations.courier.remove_default_preferences_topic
Full name
courier.courier_tenants_remove_default_preferences_for_topic
ParameterTypeRequiredDescription
No parameters.
create_or_update_tenant_template Write

Creates or updates a notification template for a tenant.

Lua path
app.integrations.courier.create_or_update_tenant_template
Full name
courier.courier_tenants_replace_template
ParameterTypeRequiredDescription
No parameters.
get_translation Read

Get translations by locale.

Lua path
app.integrations.courier.get_translation
Full name
courier.courier_translations_get
ParameterTypeRequiredDescription
No parameters.
update_translations_by_locale Write

Update a translation.

Lua path
app.integrations.courier.update_translations_by_locale
Full name
courier.courier_translations_update
ParameterTypeRequiredDescription
No parameters.
get_user_subscription_topic Read

Fetch user preferences for a specific subscription topic.

Lua path
app.integrations.courier.get_user_subscription_topic
Full name
courier.courier_users_preferences_get
ParameterTypeRequiredDescription
No parameters.
get_user_preferences Read

Fetch all user preferences.

Lua path
app.integrations.courier.get_user_preferences
Full name
courier.courier_users_preferences_list
ParameterTypeRequiredDescription
No parameters.
update_or_create_user_preferences_specific_subscription_topic Write

Update or Create user preferences for a specific subscription topic.

Lua path
app.integrations.courier.update_or_create_user_preferences_specific_subscription_topic
Full name
courier.courier_users_preferences_update
ParameterTypeRequiredDescription
No parameters.
add_user_single_tenant Write

This endpoint is used to add a single tenant.

Lua path
app.integrations.courier.add_user_single_tenant
Full name
courier.courier_users_tenants_add
ParameterTypeRequiredDescription
No parameters.
add_user_multiple_tenants Write

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

Lua path
app.integrations.courier.add_user_multiple_tenants
Full name
courier.courier_users_tenants_add_multiple
ParameterTypeRequiredDescription
No parameters.
get_tenants_associated_with_given_user Read

Returns a paginated list of user tenant associations.

Lua path
app.integrations.courier.get_tenants_associated_with_given_user
Full name
courier.courier_users_tenants_list
ParameterTypeRequiredDescription
No parameters.
remove_user_from_tenant Write

Removes a user from the supplied tenant.

Lua path
app.integrations.courier.remove_user_from_tenant
Full name
courier.courier_users_tenants_remove
ParameterTypeRequiredDescription
No parameters.
remove_user_from_all_associated_tenants Write

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

Lua path
app.integrations.courier.remove_user_from_all_associated_tenants
Full name
courier.courier_users_tenants_remove_all
ParameterTypeRequiredDescription
No parameters.
add_single_token_user Write

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

Lua path
app.integrations.courier.add_single_token_user
Full name
courier.courier_users_tokens_add
ParameterTypeRequiredDescription
No parameters.
add_multiple_tokens_user Write

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

Lua path
app.integrations.courier.add_multiple_tokens_user
Full name
courier.courier_users_tokens_add_multiple
ParameterTypeRequiredDescription
No parameters.
delete_user_token Write

Delete User Token.

Lua path
app.integrations.courier.delete_user_token
Full name
courier.courier_users_tokens_delete
ParameterTypeRequiredDescription
No parameters.
get_single_token Read

Get single token available for a :token.

Lua path
app.integrations.courier.get_single_token
Full name
courier.courier_users_tokens_get
ParameterTypeRequiredDescription
No parameters.
get_all_tokens Read

Gets all tokens available for a :user_id.

Lua path
app.integrations.courier.get_all_tokens
Full name
courier.courier_users_tokens_list
ParameterTypeRequiredDescription
No parameters.
update_token Write

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

Lua path
app.integrations.courier.update_token
Full name
courier.courier_users_tokens_update
ParameterTypeRequiredDescription
No parameters.