A command's flags are the operation's fields: see them with kirora <resource> <action> --help, or on its API reference page. Signing in, the flags every command takes and the output are on the CLI page.
assets
Images uploaded for template image blocks, served from a public URL.
| Command | What it does |
|---|---|
kirora assets list | List uploaded imagestemplates:read |
kirora assets upload | Upload an imagetemplates:write |
attributes
The attribute keys your contacts carry and their values, for rule and merge-tag pickers.
| Command | What it does |
|---|---|
kirora attributes list | List contact attribute keysattributes:read |
kirora attributes list-merge-tag-fallbacks | List remembered merge tag fallbacksattributes:read |
kirora attributes list-values <key> | List the values of an attributeattributes:read |
brand-theme
Retrieve the workspace brand theme
| Command | What it does |
|---|---|
kirora brand-theme get | Retrieve the workspace brand themetemplates:read |
campaigns
One-off sends to a group or segment.
| Command | What it does |
|---|---|
kirora campaigns archive <id> | Archive a campaigncampaigns:write |
kirora campaigns cancel <id> | Cancel a campaign that is still sendingcampaigns:write |
kirora campaigns check-unsaved-eligibility | Check who a campaign would reach before saving itcampaigns:read |
kirora campaigns create | Create a campaigncampaigns:write |
kirora campaigns delete <id> | Delete a draft campaigncampaigns:write |
kirora campaigns duplicate <id> | Duplicate a campaigncampaigns:write |
kirora campaigns get <id> | Retrieve a campaigncampaigns:read |
kirora campaigns get-eligibility <id> | Check whether a campaign can sendcampaigns:read |
kirora campaigns get-series <id> | Chart campaign performance over timecampaigns:read |
kirora campaigns get-stats <id> | Retrieve campaign statisticscampaigns:read |
kirora campaigns list | List campaignscampaigns:read |
kirora campaigns list-links <id> | List a campaign's most clicked linkscampaigns:read |
kirora campaigns list-messages <id> | List campaign messagescampaigns:read |
kirora campaigns preview <id> | Preview campaign contentcampaigns:read |
kirora campaigns schedule <id> | Schedule a campaigncampaigns:send |
kirora campaigns send <id> | Send a campaigncampaigns:send |
kirora campaigns trigger <id> | Send a campaign to the people you listcampaigns:send |
kirora campaigns unarchive <id> | Unarchive a campaigncampaigns:write |
kirora campaigns unschedule <id> | Unschedule a campaigncampaigns:write |
kirora campaigns update <id> | Update a campaigncampaigns:write |
contacts
People you can message, their attributes and their consent.
| Command | What it does |
|---|---|
kirora contacts disable-push-installation <id> <installationId> | Disable a push installationcontacts:write |
kirora contacts erase | Erase contactscontacts:delete |
kirora contacts export-data <id> | Export a contact's datacontacts:read |
kirora contacts get <id> | Retrieve a contactcontacts:read |
kirora contacts identify | Create or update a contactcontacts:write |
kirora contacts identify-batch | Create or update contacts in a batchcontacts:write |
kirora contacts list | List contactscontacts:read |
kirora contacts list-consent-history <id> | List a contact's consent historycontacts:read |
kirora contacts list-events <id> | List a contact's eventscontacts:read |
kirora contacts list-groups <id> | List a contact's groupscontacts:read |
kirora contacts list-journeys <id> | List a contact's journey runscontacts:read |
kirora contacts list-messages <id> | List a contact's messagesmessages:read |
kirora contacts list-push-installations <id> | List a contact's push installationscontacts:read |
kirora contacts list-segments <id> | List saved segments currently matching this contactcontacts:read |
kirora contacts list-topics <id> | List a contact's topicscontacts:read |
kirora contacts register-push-installation <id> | Register a push installationcontacts:write |
kirora contacts set-topic <id> <topicId> | Set a contact's topic choicecontacts:write |
kirora contacts update <id> | Update a contactcontacts:write |
embed-sessions
Mint a builder session for a browser
| Command | What it does |
|---|---|
kirora embed-sessions create | Mint a builder session for a browserworkspaces:manage |
events
Behavioural event ingestion.
| Command | What it does |
|---|---|
kirora events cancel <id> | Cancel what an event set offevents:write |
kirora events delete-name <name> | Delete an event nameevents:write |
kirora events get-name <name> | Retrieve an event nameevents:read |
kirora events list-names | List event namesevents:read |
kirora events track | Track an eventevents:write |
kirora events track-batch | Track events in a batchevents:write |
forms
Hosted signup forms that create contacts and record consent.
| Command | What it does |
|---|---|
kirora forms archive <id> | Archive a formforms:write |
kirora forms create | Create a formforms:write |
kirora forms delete <id> | Delete a formforms:write |
kirora forms get <id> | Retrieve a formforms:read |
kirora forms get-stats <id> | Retrieve form statisticsforms:read |
kirora forms list | List formsforms:read |
kirora forms list-submissions <id> | List a form's submissionscontacts:read |
kirora forms unarchive <id> | Unarchive a formforms:write |
kirora forms update <id> | Update a formforms:write |
groups
Static audiences with explicit membership.
| Command | What it does |
|---|---|
kirora groups add-members <id> | Add contacts to a groupgroups:write |
kirora groups create | Create a groupgroups:write |
kirora groups delete <id> | Delete a groupgroups:write |
kirora groups get <id> | Retrieve a groupgroups:read |
kirora groups get-usage <id> | List what uses a groupgroups:read |
kirora groups list | List groupsgroups:read |
kirora groups remove-members <id> | Remove contacts from a groupgroups:write |
kirora groups update <id> | Update a groupgroups:write |
journeys
Multi-step automations that contacts enter and move through over time.
| Command | What it does |
|---|---|
kirora journeys activate <id> | Activate a journeyjourneys:activate |
kirora journeys create | Create a journeyjourneys:write |
kirora journeys delete <id> | Delete a journeyjourneys:write |
kirora journeys duplicate <id> | Duplicate a journeyjourneys:write |
kirora journeys end <id> | End a journeyjourneys:write |
kirora journeys get <id> | Retrieve a journeyjourneys:read |
kirora journeys get-stats <id> | Retrieve journey statisticsjourneys:read |
kirora journeys get-step-stats <id> | Retrieve per-step journey statisticsjourneys:read |
kirora journeys list | List journeysjourneys:read |
kirora journeys list-definitions <id> | List journey definition versionsjourneys:read |
kirora journeys pause <id> | Pause a journeyjourneys:write |
kirora journeys simulate <id> | Preview a contact's journey step path without sendingjourneys:read |
kirora journeys update <id> | Update a journeyjourneys:write |
me
The calling API key and its workspace, as a connection test.
| Command | What it does |
|---|---|
kirora me get | Check an API keyAny key |
messages
The send log: every message from any source, and what became of it.
| Command | What it does |
|---|---|
kirora messages create-export | Export sent messages as CSVmessages:read |
kirora messages download-export <id> | Download a message exportmessages:read |
kirora messages get-export <id> | Retrieve a message exportmessages:read |
kirora messages get-sent <id> | Retrieve a sent messagemessages:read |
kirora messages list-sent | List sent messages across every sourcemessages:read |
onboarding
Retrieve the setup checklist
| Command | What it does |
|---|---|
kirora onboarding get | Retrieve the setup checklistAny key |
push
Direct push sends to a contact's installations.
| Command | What it does |
|---|---|
kirora push list-deliveries <id> | List a push message's deliveriesmessages:read |
kirora push send | Send a push messagepush:send |
push-projects
The products whose apps receive push, and whether each can send.
| Command | What it does |
|---|---|
kirora push-projects list | List push projectspush:read |
reports
How sending is performing: the overview and a per-campaign comparison, by calendar day in the workspace's timezone.
| Command | What it does |
|---|---|
kirora reports get-funnel | Report a conversion funnel over eventsreports:read |
kirora reports get-overview | Retrieve the performance overviewreports:read |
kirora reports get-transactional | Retrieve transactional email deliveryreports:read |
kirora reports list-campaign-performance | Compare campaignsreports:read |
segments
Rule-based audiences, evaluated when used rather than stored as a fixed list.
| Command | What it does |
|---|---|
kirora segments create | Create a segmentsegments:write |
kirora segments delete <id> | Delete a segmentsegments:write |
kirora segments get <id> | Retrieve a segmentsegments:read |
kirora segments get-count <id> | Count contacts in a segmentsegments:read |
kirora segments get-usage <id> | List what uses a segmentsegments:read |
kirora segments list | List segmentssegments:read |
kirora segments list-contacts <id> | List contacts in a segmentcontacts:read |
kirora segments preview | Preview segment rulessegments:read |
kirora segments update <id> | Update a segmentsegments:write |
sending-domains
Domains you send from, and their DNS verification state.
| Command | What it does |
|---|---|
kirora sending-domains check <id> | Check domain verificationdomains:write |
kirora sending-domains create | Add a sending domaindomains:write |
kirora sending-domains delete <id> | Remove a sending domaindomains:write |
kirora sending-domains get <id> | Retrieve a sending domaindomains:read |
kirora sending-domains get-usage <id> | List what sends from a domaindomains:read |
kirora sending-domains list | List sending domainsdomains:read |
shared-blocks
Blocks kept once and placed in many emails, such as a footer or a product card; editing one updates every template that uses it.
| Command | What it does |
|---|---|
kirora shared-blocks create | Create a shared blocktemplates:write |
kirora shared-blocks delete <id> | Delete a shared blocktemplates:write |
kirora shared-blocks get <id> | Retrieve a shared blocktemplates:read |
kirora shared-blocks get-usage <id> | List where a shared block is placedtemplates:read |
kirora shared-blocks list | List shared blockstemplates:read |
kirora shared-blocks update <id> | Update a shared blocktemplates:write |
suppressions
Addresses nothing is sent to: bounces, complaints, unsubscribes and blocks you add.
| Command | What it does |
|---|---|
kirora suppressions import | Import suppressed email addressessuppressions:write |
kirora suppressions list | List suppressed email addressessuppressions:read |
kirora suppressions remove <id> | Unblock a suppressed email addresssuppressions:write |
templates
Reusable block trees and themes.
| Command | What it does |
|---|---|
kirora templates create | Create a templatetemplates:write |
kirora templates delete <id> | Delete a templatetemplates:write |
kirora templates duplicate <id> | Duplicate a templatetemplates:write |
kirora templates get <id> | Retrieve a templatetemplates:read |
kirora templates get-gallery | List sample emails and theme presetstemplates:read |
kirora templates get-version <id> <version> | Retrieve a template versiontemplates:read |
kirora templates list | List templatestemplates:read |
kirora templates list-versions <id> | List a template's versionstemplates:read |
kirora templates publish <id> | Publish a templatetemplates:write |
kirora templates render | Render blocks to email HTMLtemplates:read |
kirora templates restore-version <id> <version> | Roll back to a template versiontemplates:write |
kirora templates update <id> | Update a templatetemplates:write |
topics
Subscription topics a contact can opt in or out of, and each contact's choices.
| Command | What it does |
|---|---|
kirora topics create | Create a topictopics:write |
kirora topics delete <id> | Delete a topictopics:write |
kirora topics list | List topicstopics:read |
kirora topics update <id> | Update a topictopics:write |
transactional
One-off messages to a single recipient — receipts, password resets — outside campaigns, with idempotency keys for safe retries.
| Command | What it does |
|---|---|
kirora transactional cancel-scheduled <id> | Cancel a timed sendtransactional:send |
kirora transactional get <id> | Retrieve a transactional messagemessages:read |
kirora transactional get-content <id> | Retrieve what a transactional message sentmessages:read |
kirora transactional list | List transactional messagesmessages:read |
kirora transactional send | Send a transactional messagetransactional:send |
kirora transactional send-batch | Send up to 100 transactional messagestransactional:send |
webhooks
Endpoints that receive our events, signed and retried: subscribe, list, pause, test, rotate secrets and resend deliveries.
| Command | What it does |
|---|---|
kirora webhooks create | Subscribe a URL to eventswebhooks:write |
kirora webhooks delete <id> | Unsubscribe a webhookwebhooks:write |
kirora webhooks list | List webhookswebhooks:write |
kirora webhooks list-deliveries | List webhook deliverieswebhooks:write |
kirora webhooks list-events | List webhook eventsAny key |
kirora webhooks redeliver-delivery <deliveryId> | Send a failed delivery againwebhooks:write |
kirora webhooks rotate-secret <id> | Rotate a webhook signing secretwebhooks:write |
kirora webhooks test <id> | Send a test eventwebhooks:write |
kirora webhooks update <id> | Update a webhookwebhooks:write |
workspaces
For platforms that resell messaging to their own customers: one workspace per tenant, driven with a partner key and the `Kirora-Workspace` header, and short-lived sessions for the embedded builders.
| Command | What it does |
|---|---|
kirora workspaces cancel-deletion <externalId> | Cancel a tenant workspace's deletionworkspaces:manage |
kirora workspaces create | Create a workspace for one of your tenantsworkspaces:manage |
kirora workspaces delete <externalId> | Delete a tenant's workspaceworkspaces:manage |
kirora workspaces get <externalId> | Retrieve a tenant workspaceworkspaces:manage |
kirora workspaces list | List your tenant workspacesworkspaces:manage |
kirora workspaces resume <externalId> | Resume a tenant's sendingworkspaces:manage |
kirora workspaces suspend <externalId> | Suspend a tenant's sendingworkspaces:manage |
kirora workspaces update <externalId> | Update a tenant workspaceworkspaces:manage |