CLI Reference

Global Options

--format: Change the output format to one of csv, json, or text. Defaults to text for human-readable output.
--tz: Force the timezone to use for all date and time values. Defaults to the local timezone ($TZ on Unix systems) and falls back to UTC if no default is configured.

Commands

api	Generic API tool
cd-appointment	Appointment related commands
cd-article	Article related commands
cd-calendly	Calendly commands
cd-challenge	Challenge management commands
cd-cobject	Custom Object related commands
cd-encounter	Encounter related commands
cd-orgcare	Organization Care Team management
cd-orgdoc	Organization document reference management
cd-orgpractitioner	Organization practitioner management
cd-todo	Todo entires related commands
ck-dbd-loader	Cronkite Dbd Loader Command
ck-dbm-database	Cronkite Dbm Database Command
ck-dbm-rollup	Cronkite Dbm Rollup Command
ck-dbt-project	Cronkite Dbt Project Command
ck-llm	Cronkite LLM Command
ck-loader	Cronkite Loader Command
configurator	Configurator commands
cr-announcer	Courier announcer commands
cr-channel	Courier channel commands
cr-device	Courier device commands
cr-notif	Courier notification commands
cr-text	Courier text/sms commands
cr-voice	Courier voice commands
cwd	Working directory management
dr-campaign	Campaign commands
dr-contact	Drow contacts
ds-dashboard	Dashboard commands
ds-jobspec	Job Spec commands
ds-repo	Repository commands
ds-report	Report commands
ds-table	Job Spec Table commands
ds-widget	Widget commands
ds-widgetspec	Widget Spec commands
es-spec	Elastic search spec management
fm-instance	Form instance management
fm-spec	Form spec management
id-archive	Manage identity archive requests
id-code	Signup code management
id-email	Identity email template management
id-email-logs	Outgoing email logs
id-feature	Identity feature management
id-group	Identity group management
id-org	Identity organization management
id-registration	Registration Invite
id-task	Identity task management
id-theme	Manage identity organization theme
id-user	Identity user management
it-device	Device debugger
it-ltemaps	Integrator LTE Maps commands
it-oauth	Integrator Oauth commands
it-shipment	Device shipment management
iv-instance	Interview instance management
iv-profile	Workflow profile management
j2	jinja2 template rendering
jb-test	Job tester commands
lc-entries	Lachesis time-series commands
lc-tca	Lachesis TCA management
login	Login command
logout	Logout command
pg-design	Design related commands
pg-interaction	Interaction-related commands
pg-realm	Realm management
pg-sim	Playground simulation related commands
pk-bundle	Package bundle manager
pw-instance	Pathway instance management
pw-spec	Pathway spec management
pw-step	Pathway step management
py-cerner	Pylon EHR Cerner commands
py-elation	Pylon EHR Elation commands
py-epic	Pylon EHR EPIC commands
py-jobexec	Job Executor Configuration commands
py-jobsecret	Job Secret commands
py-jobspec	Job Spec commands
py-module	Job Module commands
py-repo	Pylon repository management
py-s3-event	Pylon S3 event commands
py-setting	Pylon setting commands
py-sftp-remote	Pylon SFTP remote server management
py-sftp-user	Pylon SFTP user management
py-vcs	Pylon repository management
shell	Enter IPython REPL with brewmaster initialized
sw-banner	Banner commands
sw-company	Company Commands
sw-debugger	Debugger commands
sw-helpdoc	Help Docs commands
sw-landingpage	Landing Page
sw-logo	Private label logo commands
sw-patient	Patient commands
sw-provider	Provider commands
version	Show version information
wf-config	Workflow program config
wf-instance	Workflow instance management
wf-interaction	Workflow interaction management
wf-lnp	LNP management
wf-profile	Workflow profile management
wf-program	Workflow program
wf-type	Workflow-type management
whoami	Show current user information

api

Generic API tool
Sub commands: delete, get, patch, post

delete

Make an authenticated HTTP DELETE request

crm api delete
  path
  [--params]

path
URL path to request.
--params Optional.

get

Make an authenticated HTTP GET request

crm api get
  path
  [--params]

path
URL path to request.
--params Optional.
Query parameters.

patch

Make an authenticated HTTP PATCH request

crm api patch
  path
  [--data]
  [--json]

path
URL path to request.
--data Optional.
Raw data to send in the request body.
--json Optional.
JSON data to send in the request body.

post

Make an authenticated HTTP POST request

crm api post
  path
  [--data]
  [--json]

path
URL path to request.
--data Optional.
Raw data to send in the request body.
--json Optional.
JSON data to send in the request body.

cd-appointment

Appointment related commands
Sub commands: create-status, create-type, list-status, list-type, update-status

create-status

Create a new appointment status

crm cd-appointment create-status
  display
  [--definition]
  [--default]
  [--no-default]
  [--void]
  [--no-void]

display
--definition Optional.
--default Optional.
--no-default Optional.
--void Optional.
--no-void Optional.

create-type

Create a new appointment type

crm cd-appointment create-type
  display
  [--definition]

display
--definition Optional.

list-status

List appointment statuses

crm cd-appointment list-status
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, display, definition, void, default
Valid values: created-at, created-by, default, definition, display, id, modified-at, modified-by, void
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-type

List appointment types

crm cd-appointment list-type
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, display, definition
Valid values: created-at, created-by, definition, display, id, modified-at, modified-by
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update-status

Update an appointment status

crm cd-appointment update-status
  status
  [--definition]
  [--default]
  [--no-default]
  [--void]
  [--no-void]

status
--definition Optional.
--default Optional.
--no-default Optional.
--void Optional.
--no-void Optional.

cd-article

Article related commands
Sub commands: add-content-file, add-content-url, bulk-create, create, delete, delete-content, get, list, update

add-content-file

Add a new content in the form of a file to an article

crm cd-article add-content-file
  article_id
  file
  content_type

article_id
Article to add content to.
file
File to upload.
content_type
content-type of the file to set.

add-content-url

Add a new content in the form of a URL to an article

crm cd-article add-content-url
  article_id
  url

article_id
Article to add content to.
url
URL to set as article content.

bulk-create

crm cd-article bulk-create
  config

config

create

Create a new article

crm cd-article create
  title
  [--description]
  [--name]

title
Title of the article.
--description Optional.
Description of the article.
--name Optional.
Name of the article.

delete

Delete an article

crm cd-article delete
  article_id

article_id
Article to delete.

delete-content

Delete a content from an article

crm cd-article delete-content
  content_id

content_id
Content to delete.

get

Get an article

crm cd-article get
  article_id

article_id
Article to get.

list

List articles

crm cd-article list
  [--fields]
  [--individual]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, title, locale, views, tags
Valid values: created-at, description, id, locale, name, organization-id, tags, title, url, version, views
--individual Optional.
Only show articles that this individual can see.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

Update an article

crm cd-article update
  article_id
  [--locale]
  [--parent-id]

article_id
Article to update.
--locale Optional.
Set locale for the article.
Valid values: en_US, es_US
--parent-id Optional.
Set parent article.

cd-calendly

Calendly commands
Sub commands: get-user, list-account, list-user

list-account

crm cd-calendly list-account
  [--count]
  [--offset]
  [--fields]

--count Optional.
Number of items to return.
Default: 50
--offset Optional.
Paging offset.
--fields Optional.
Default: id, name, created-at
Valid values: created-at, id, name

list-user

crm cd-calendly list-user
  account_id
  [--count]
  [--offset]
  [--fields]

account_id
--count Optional.
Number of items to return.
Default: 50
--offset Optional.
Paging offset.
--fields Optional.
Default: id, name, scheduling-url, created-at
Valid values: created-at, id, name, scheduling-url

get-user

crm cd-calendly get-user
  user_id

user_id

cd-challenge

Challenge management commands
Sub commands: create, delete, get, list

create

crm cd-challenge create
  name
  workflow
  [--description]
  [--groups]

name
workflow
--description Optional.
--groups Optional.

delete

crm cd-challenge delete
  challenge_id

challenge_id

get

crm cd-challenge get
  challenge_id

challenge_id

list

crm cd-challenge list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, workflow, private, count-participants
Valid values: auto-group-sync, count-group-members, count-groups, count-participants, created-at, created-by, created-by-name, description, id, modified-at, modified-by, modified-by-name, name, private, status, workflow
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

cd-cobject

Custom Object related commands
Sub commands: add-column, alter-column, alter-table, create-table, describe, drop-column, drop-table, select, show-tables

add-column

crm cd-cobject add-column
  table_name
  column
  type
  [--default]
  [--display-name]
  [--indexed]
  [--options]

table_name
column
type
Valid values: boolean, date, datetime, enum, float, integer, string
--default Optional.
--display-name Optional.
--indexed Optional.
--options Optional.

alter-column

crm cd-cobject alter-column
  table_name
  field
  [--default]
  [--display-name]
  [--options]
  [--required]
  [--optional]

table_name
field
--default Optional.
--display-name Optional.
--options Optional.
--required Optional.
--optional Optional.

alter-table

crm cd-cobject alter-table
  table_name
  [--display-name]

table_name
--display-name Optional.

create-table

crm cd-cobject create-table
  name

name

drop-table

crm cd-cobject drop-table
  table_name

table_name

describe

crm cd-cobject describe
  table_name
  [field]
  [--fields]

table_name
field Optional.
--fields Optional.
Default: name, display-name, type, default, indexed, required
Valid values: created-at, created-by, default, display-name, id, indexed, modified-at, modified-by, name, options, required, type

drop-column

crm cd-cobject drop-column
  table_name
  field

table_name
field

select

crm cd-cobject select
  table_name
  [--parent]

table_name
--parent Optional.

show-tables

crm cd-cobject show-tables
  [table_name]

table_name Optional.

cd-encounter

Encounter related commands
Sub commands: create, create-type, delete, delete-type, get, list, list-type

create-type

crm cd-encounter create-type
  display
  [--definition]

display
--definition Optional.

delete-type

crm cd-encounter delete-type
  type_id

type_id

get

crm cd-encounter get
  encounter_id

encounter_id

list

crm cd-encounter list
  [--fields]
  [--external-id]
  [--individual]
  [--status]
  [--offset]
  [--count]

--fields Optional.
Default: id, individual-id, start-time, notes
Valid values: created-at, created-by, duration, end-time, external-id, id, individual-id, modified-at, modified-by, notes, start-time, status
--external-id Optional.
--individual Optional.
--status Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-type

crm cd-encounter list-type
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, organization-id, display
Valid values: created-at, created-by, definition, display, id, modified-at, modified-by, organization-id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

create

crm cd-encounter create
  definition
  display

definition
display

delete

crm cd-encounter delete
  spec_id

spec_id

cd-orgcare

Organization Care Team management
Sub commands: create, delete, get, list, update

create

crm cd-orgcare create
  group_id
  name
  [--external-id]

group_id
name
--external-id Optional.

delete

crm cd-orgcare delete
  _id

_id

get

crm cd-orgcare get
  _id

_id

list

crm cd-orgcare list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, created-at
Valid values: created-at, created-by, external-id, group-id, id, modified-at, modified-by, name
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm cd-orgcare update
  _id
  [--external-id]
  [--name]

_id
--external-id Optional.
--name Optional.

cd-orgdoc

Organization document reference management
Sub commands: create, delete, download, list, list-class

create

crm cd-orgdoc create
  individual_id
  class_id
  file
  [--content-type]
  [--description]
  [--external-id]
  [--filename]

individual_id
class_id
file
--content-type Optional.
--description Optional.
--external-id Optional.
--filename Optional.

delete

crm cd-orgdoc delete
  doc_id

doc_id

download

crm cd-orgdoc download
  doc_id
  file

doc_id
file

list

crm cd-orgdoc list
  [--fields]
  [--individual-id]

--fields Optional.
Default: id, created-at, individual-id, description
Valid values: class-description, class-id, content-type, created-at, description, external-id, filename, id, individual-id, modified-at, ready
--individual-id Optional.

list-class

crm cd-orgdoc list-class
  [--fields]

--fields Optional.
Default: id, code, description
Valid values: code, created-at, description, id, modified-at, organization-id

cd-orgpractitioner

Organization practitioner management
Sub commands: create, delete, get, list, update

create

crm cd-orgpractitioner create
  first_name
  last_name
  [--display-name]
  [--external-id]
  [--gender]
  [--qualification-code]
  [--user-id]

first_name
last_name
--display-name Optional.
--external-id Optional.
--gender Optional.
--qualification-code Optional.
--user-id Optional.

delete

crm cd-orgpractitioner delete
  _id

_id

get

crm cd-orgpractitioner get
  _id
  [--individuals]

_id
--individuals Optional.

list

crm cd-orgpractitioner list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, display-name, user
Valid values: created-at, created-by, display-name, external-id, first-name, gender, id, last-name, modified-at, modified-by, qualification-code, user
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm cd-orgpractitioner update
  _id
  [--display-name]
  [--external-id]
  [--first-name]
  [--gender]
  [--last-name]
  [--qualification-code]
  [--user-id]

_id
--display-name Optional.
--external-id Optional.
--first-name Optional.
--gender Optional.
--last-name Optional.
--qualification-code Optional.
--user-id Optional.

cd-todo

Todo entires related commands
Sub commands: create-tag, delete-tag, get-tag, list-tag

crm cd-todo list-tag
  [--count]
  [--offset]
  [--fields]

--count Optional.
Number of items to return.
Default: 50
--offset Optional.
Paging offset.
--fields Optional.
Default: id, name, created-at
Valid values: created-at, id, name

get-tag

crm cd-todo get-tag
  tag_id

tag_id

create-tag

crm cd-todo create-tag
  name

name

delete-tag

crm cd-todo delete-tag
  tag_id

tag_id

ck-dbd-loader

Cronkite Dbd Loader Command
Sub commands: list

list

crm ck-dbd-loader list
  [--offset]
  [--count]
  [--fields]
  [--name]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 150
--fields Optional.
Default: name, last-run-at
Valid values: id, last-run-at, name, type
--name Optional.

ck-dbm-database

Cronkite Dbm Database Command
Sub commands: list

list

crm ck-dbm-database list
  [--offset]
  [--count]
  [--fields]
  [--cluster]
  [--db-name]
  [--org]
  [--managed]
  [--no-managed]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--fields Optional.
Default: id, organization-id, db-name
Valid values: created-at, db-host, db-name, db-port, db-username, dbm-cluster-id, id, last-modified-at, managed, organization-id
--cluster Optional.
--db-name Optional.
--org Optional.
--managed Optional.
--no-managed Optional.

ck-dbm-rollup

Cronkite Dbm Rollup Command
Sub commands: list

list

crm ck-dbm-rollup list
  [--offset]
  [--count]
  [--fields]
  [--org]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 150
--fields Optional.
Default: organization-id, table-name, last-run-at
Valid values: created-at, dbm-database-id, id, last-run-at, organization-id, table-name
--org Optional.

ck-dbt-project

Cronkite Dbt Project Command
Sub commands: create, create-run, delete, delete-run, get, get-docs-info, get-run, list, list-run, update, upload

create

crm ck-dbt-project create
  name
  [--private-key]
  [--personal-access-token]
  [--schedule-daily]
  [--type]
  [--url]
  [--username]

name
--private-key Optional.
--personal-access-token Optional.
--schedule-daily Optional.
--type Optional.
Valid values: archive, git
--url Optional.
--username Optional.

delete

crm ck-dbt-project delete
  project_id

project_id

get

crm ck-dbt-project get
  project_id

project_id

get-docs-info

crm ck-dbt-project get-docs-info
  project_id
  [--target]

project_id
--target Optional.

list

crm ck-dbt-project list
  [--offset]
  [--count]
  [--fields]
  [--name]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--fields Optional.
Default: id, name, type, schedule-daily, url
Valid values: created-at, created-by, id, last-modified-at, last-modified-by, name, personal-access-token, private-key, schedule-daily, type, url, username
--name Optional.

upload

crm ck-dbt-project upload
  project_id
  project-path

project_id
project-path

update

crm ck-dbt-project update
  project_id
  [--name]
  [--no-schedule-daily]
  [--personal-access-token]
  [--private-key]
  [--schedule-daily]
  [--url]
  [--username]

project_id
--name Optional.
--no-schedule-daily Optional.
--personal-access-token Optional.
--private-key Optional.
--schedule-daily Optional.
--url Optional.
--username Optional.

create-run

crm ck-dbt-project create-run
  project_id
  [--branch]
  [--no-wait]
  [--select]
  [--target]
  [--upload-project-path]

project_id
--branch Optional.
--no-wait Optional.
--select Optional.
--target Optional.
--upload-project-path Optional.

delete-run

crm ck-dbt-project delete-run
  run_id

run_id

get-run

crm ck-dbt-project get-run
  run_id
  [--stdout]
  [--stderr]

run_id
--stdout Optional.
--stderr Optional.

list-run

crm ck-dbt-project list-run
  project_id
  [--offset]
  [--count]
  [--fields]

project_id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--fields Optional.
Default: id, created-at, last-modified-at, status, target, schema
Valid values: branch, created-at, created-by, id, last-modified-at, project-id, schema, select, status, stderr, stdout, target

ck-llm

Cronkite LLM Command
Sub commands: create-individual, get-individual, get-sql, get-vector, list-individual, list-vector, sql

create-individual

crm ck-llm create-individual
  individual_id
  question
  [--model]
  [--vector-limit]
  [--vector-chunk]
  [--vector-context]

individual_id
question
--model Optional.
Valid values: titan-express, claude-3-sonnet
--vector-limit Optional.
--vector-chunk Optional.
--vector-context Optional.

get-individual

crm ck-llm get-individual
  run_id

run_id

get-sql

crm ck-llm get-sql
  query_id

query_id

get-vector

crm ck-llm get-vector
  entry_id

entry_id

list-individual

crm ck-llm list-individual
  individual_id
  [--fields]

individual_id
--fields Optional.
Default: id, created-at, question, token-input, token-output
Valid values: created-at, id, model, modified-at, question, state, token-input, token-output

list-vector

crm ck-llm list-vector
  individual_id
  query
  [--fields]
  [--count]

individual_id
query
--fields Optional.
Default: id, context-id, context-type
Valid values: context-id, context-type, created-at, id, modified-at
--count Optional.
Number of items to return.
Default: 30

sql

crm ck-llm sql
  query

query

ck-loader

Cronkite Loader Command
Sub commands: list

list

crm ck-loader list
  [--offset]
  [--count]
  [--fields]
  [--name]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--fields Optional.
Default: name, last-run-at
Valid values: created-at, id, last-run-at, loader-cls, name
--name Optional.

configurator

Configurator commands
Sub commands: reset, run

reset

crm configurator reset
  user_id

user_id

run

crm configurator run
  user_id
  template
  args

user_id
template
args

cr-announcer

Courier announcer commands
Sub commands: get, list

get

crm cr-announcer get
  announcer_id

announcer_id

list

crm cr-announcer list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, event, type
Valid values: args, created-at, created-by, event, id, modified-at, modified-by, name, type
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

cr-channel

Courier channel commands
Sub commands: get, list, update

get

crm cr-channel get
  channel_id
  [--individual-id]

channel_id
--individual-id Optional.

list

crm cr-channel list
  [--fields]
  [--individual]
  [--participant]
  [--offset]
  [--count]

--fields Optional.
Default: id, subscriber, type, archived, label
Valid values: archived, created-at, created-by, group-id, group-name, group-provider-ack, id, label, msg-count, owner-id, owner-name, subscriber, type
--individual Optional.
--participant Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm cr-channel update
  channel_id
  [--group]
  [--group-provider-ack]
  [--no-group-provider-ack]
  [--label]
  [--name]

channel_id
--group Optional.
--group-provider-ack Optional.
--no-group-provider-ack Optional.
--label Optional.
--name Optional.

cr-device

Courier device commands
Sub commands: list

list

crm cr-device list
  [--all-users]
  [--app-name]
  [--app-version]
  [--fields]
  [--model]
  [--individual]
  [--shared-with]
  [--type]
  [--offset]
  [--count]

--all-users Optional.
--app-name Optional.
--app-version Optional.
--fields Optional.
Default: id, individual, type, app-version
Valid values: app-name, app-version, created-at, email, first-name, id, individual, last-login-time, last-modified-at, last-name, model, os-version, topic, type, user-id
--model Optional.
--individual Optional.
--shared-with Optional.
--type Optional.
Valid values: apn, fcm, web
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

cr-notif

Courier notification commands
Sub commands: bulk-multicast, clean, delete, get, list

bulk-multicast

crm cr-notif bulk-multicast
  individuals
  template_id
  template_data

individuals
template_id
template_data

clean

crm cr-notif clean
  [--individual]

--individual Optional.

delete

crm cr-notif delete
  notif_id

notif_id

get

crm cr-notif get
  notif_id

notif_id

list

crm cr-notif list
  [--individual]

--individual Optional.

cr-text

Courier text/sms commands
Sub commands: create, create-number, delete-number, get, list, list-number, list-send, log, send, update-number

create

crm cr-text create

create-number

crm cr-text create-number
  [--area-code]
  [--logging]

--area-code Optional.
--logging Optional.

delete-number

crm cr-text delete-number
  phone_id

phone_id

get

crm cr-text get
  [--account]

--account Optional.

list

crm cr-text list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, organization-id, phone
Valid values: created-at, id, organization-id, phone, twilio-id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-number

crm cr-text list-number
  [--phone-number]
  [--fields]

--phone-number Optional.
--fields Optional.
Default: id, phone-number, logging, forward, notes
Valid values: account-id, cap-mms, cap-sms, cap-voice, created-at, forward, id, lata, latitude, logging, longitude, notes, phone-number, rate-center, region, twilio-id, zipcode

list-send

crm cr-text list-send
  [--phone-id]
  [--target]
  [--fields]
  [--offset]
  [--count]

--phone-id Optional.
--target Optional.
--fields Optional.
Default: id, created-at, target, status
Valid values: created-at, created-by, error, from, id, message, modified-at, status, target
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm cr-text log
  phone_id
  [--fields]
  [--offset]
  [--count]

phone_id
--fields Optional.
Default: created-at, log
Valid values: created-at, log
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

send

crm cr-text send
  phone_id
  target
  message

phone_id
target
message

update-number

crm cr-text update-number
  phone_id
  [--forward]
  [--logging]
  [--no-logging]
  [--notes]

phone_id
--forward Optional.
--logging Optional.
--no-logging Optional.
--notes Optional.

cr-voice

Courier voice commands
Sub commands: create, delete, list, update

create

crm cr-voice create
  phone

phone

delete

crm cr-voice delete
  setting_id

setting_id

list

crm cr-voice list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, phone, forward, recording-enabled
Valid values: account-id, created-at, forward, id, modified-at, organization-id, phone, recording-enabled, recording-message, wait-message
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm cr-voice update
  setting_id
  [--forward]
  [--phone]
  [--recording]
  [--no-recording]
  [--recording-message]
  [--wait-message]

setting_id
--forward Optional.
--phone Optional.
--recording Optional.
--no-recording Optional.
--recording-message Optional.
--wait-message Optional.

cwd

Working directory management
Sub commands: set, show

set

crm cwd set
  dir

dir

show

crm cwd show

dr-campaign

Campaign commands
Sub commands: add-attachment, add-contact, create, delete, delete-attachment, delete-contact, get, get-attachment, get-contact, list, list-attachment, list-contact, log, set-default, start, update, update-contact

add-attachment

crm dr-campaign add-attachment
  campaign_id
  file
  [--content-type]

campaign_id
file
--content-type Optional.

add-contact

crm dr-campaign add-contact
  campaign_id
  [--email]
  [--phone]

campaign_id
--email Optional.
--phone Optional.

create

crm dr-campaign create
  name
  subject
  template
  [--sms-template]

name
subject
template
--sms-template Optional.

delete

crm dr-campaign delete
  campaign_id

campaign_id

delete-attachment

crm dr-campaign delete-attachment
  attachment_id

attachment_id

delete-contact

crm dr-campaign delete-contact
  campaign_id
  email

campaign_id
email

get

crm dr-campaign get
  campaign_id
  [--template]

campaign_id
--template Optional.

get-attachment

crm dr-campaign get-attachment
  attachment_id
  outfile

attachment_id
outfile

get-contact

crm dr-campaign get-contact
  contact_id

contact_id

list

crm dr-campaign list
  [--fields]
  [--count]

--fields Optional.
Default: id, name, email-subject, modified-at
Valid values: created-at, created-by, data, display-name, email-from, email-subject, id, modified-at, modified-by, name, start-time, template
--count Optional.
Number of items to return.
Default: 50

list-attachment

crm dr-campaign list-attachment
  campaign_id
  [--fields]

campaign_id
--fields Optional.
Default: id, filename, content-type, size
Valid values: content-type, created-at, filename, id, size

list-contact

crm dr-campaign list-contact
  campaign_id
  [--email]
  [--fields]
  [--offset]
  [--count]

campaign_id
--email Optional.
--fields Optional.
Default: id, email, phone, send-email, send-sms, sends, views
Valid values: email, first-name, id, last-name, phone, send-email, send-sms, sends, views
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm dr-campaign log
  campaign_id
  [log_id]
  [--contact]
  [--fields]
  [--offset]
  [--count]

campaign_id
log_id Optional.
--contact Optional.
--fields Optional.
Default: id, created-at, event, email, message
Valid values: contact-id, created-at, email, event, id, message
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

start

crm dr-campaign start
  campaign_id
  [--emails]
  [--resend]
  [--resend-sends]
  [--resend-views]

campaign_id
--emails Optional.
--resend Optional.
--resend-sends Optional.
--resend-views Optional.

set-default

crm dr-campaign set-default
  campaign_id

campaign_id

update

crm dr-campaign update
  campaign_id
  [--data]
  [--display-name]
  [--from]
  [--subject]
  [--sms-template]
  [--template]
  [--name]

campaign_id
--data Optional.
--display-name Optional.
--from Optional.
--subject Optional.
--sms-template Optional.
--template Optional.
--name Optional.

update-contact

crm dr-campaign update-contact
  contact_id
  [--send-email]
  [--no-send-email]
  [--send-sms]
  [--no-send-sms]

contact_id
--send-email Optional.
--no-send-email Optional.
--send-sms Optional.
--no-send-sms Optional.

dr-contact

Drow contacts
Sub commands: bulk-create, create, delete, get, list, unsubscribe, update

bulk-create

crm dr-contact bulk-create
  csv

csv

create

crm dr-contact create
  first_name
  last_name
  [--email]
  [--phone]
  [--data]

first_name
last_name
--email Optional.
--phone Optional.
--data Optional.

delete

crm dr-contact delete
  contact_id

contact_id

get

crm dr-contact get
  contact_id

contact_id

list

crm dr-contact list
  [--email]
  [--fields]
  [--bounced]
  [--normal]
  [--subscribed]
  [--unsubscribed]
  [--registered]
  [--unregistered]
  [--offset]
  [--count]

--email Optional.
--fields Optional.
Default: id, first-name, last-name, email, phone, bounce-status, unsubscribed
Valid values: birth-date, bounce-status, created-at, created-by, data, email, first-name, id, last-name, locale, modified-at, modified-by, phone, unsubscribed, user-id
--bounced Optional.
--normal Optional.
--subscribed Optional.
--unsubscribed Optional.
--registered Optional.
--unregistered Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

unsubscribe

crm dr-contact unsubscribe
  contact_id

contact_id

update

crm dr-contact update
  contact_id
  [--birth-date]
  [--data]
  [--email]
  [--first-name]
  [--last-name]
  [--phone]

contact_id
--birth-date Optional.
--data Optional.
--email Optional.
--first-name Optional.
--last-name Optional.
--phone Optional.

ds-dashboard

Dashboard commands
Sub commands: create, delete, download, get, list, update, upload

create

crm ds-dashboard create
  name
  [--group-id]
  [--scope]

name
--group-id Optional.
--scope Optional.
Valid values: organization, participant

delete

crm ds-dashboard delete
  dashboard_id

dashboard_id

download

crm ds-dashboard download
  dashboard_id

dashboard_id

get

crm ds-dashboard get
  dashboard_id

dashboard_id

list

crm ds-dashboard list
  [--fields]
  [--group-id]
  [--scope]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, scope, created-at
Valid values: created-at, created-by, group-id, id, name, scope
--group-id Optional.
--scope Optional.
Valid values: organization, participant
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm ds-dashboard update
  dashboard_id
  [--name]
  [--scope]
  [--group-id]
  [--no-group-id]

dashboard_id
--name Optional.
--scope Optional.
Valid values: organization, participant
--group-id Optional.
--no-group-id Optional.

upload

crm ds-dashboard upload
  dashboard_id
  spec
  [--update]

dashboard_id
spec
--update Optional.

ds-jobspec

Job Spec commands
Sub commands: create, delete, get, get-run, get-run-output, list, list-run, run, set-default, sync, update

create

crm ds-jobspec create
  name
  class_name
  code
  [--dbm-database-id]

name
class_name
code
--dbm-database-id Optional.

delete

crm ds-jobspec delete
  spec_id

spec_id

get

crm ds-jobspec get
  spec_id
  [--args]
  [--code]
  [--widgets]

spec_id
--args Optional.
Show args.
--code Optional.
Show code.
--widgets Optional.
Show widget specs.

get-run

crm ds-jobspec get-run
  run_id
  [--stdout]
  [--stderr]
  [--args]
  [--state]

run_id
--stdout Optional.
--stderr Optional.
--args Optional.
--state Optional.

get-run-output

crm ds-jobspec get-run-output
  run_id
  [--scope]

run_id
--scope Optional.

list

crm ds-jobspec list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, class, created-at
Valid values: args, args-schema, class, created-at, created-by, daily, dbm-database-id, id, monitored, name, organization-id, rrule, run-id, sched-id, scopes, start, user
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-run

crm ds-jobspec list-run
  spec_id
  [--offset]
  [--count]

spec_id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

run

crm ds-jobspec run
  spec_id
  [--args]
  [--scope]
  [--wait]

spec_id
--args Optional.
--scope Optional.
--wait Optional.

set-default

crm ds-jobspec set-default
  spec_id

spec_id

sync

crm ds-jobspec sync
  spec_id

spec_id

update

crm ds-jobspec update
  spec_id
  [--args]
  [--branch]
  [--class]
  [--code]
  [--dbm-database-id]
  [--log-level]
  [--name]
  [--no-schedule-args]
  [--no-start]
  [--path]
  [--repo]
  [--rrule]
  [--schedule-args]
  [--schema]
  [--scopes]
  [--start]
  [--user]
  [--no-user]
  [--monitored]
  [--not-monitored]
  [--daily]
  [--no-daily]

spec_id
--args Optional.
--branch Optional.
--class Optional.
--code Optional.
--dbm-database-id Optional.
--log-level Optional.
Valid values: debug, info, warning, error, critical
--name Optional.
--no-schedule-args Optional.
--no-start Optional.
--path Optional.
--repo Optional.
--rrule Optional.
--schedule-args Optional.
--schema Optional.
--scopes Optional.
--start Optional.
--user Optional.
--no-user Optional.
--monitored Optional.
--not-monitored Optional.
--daily Optional.
--no-daily Optional.

ds-repo

Repository commands
Sub commands: create, get, list

create

crm ds-repo create
  name
  url
  [--key]

name
url
--key Optional.

get

crm ds-repo get
  repo_id

repo_id

list

crm ds-repo list
  [--offset]
  [--count]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

ds-report

Report commands
Sub commands: create, delete, download, get, list, update

create

crm ds-report create
  name
  source
  [--args]
  [--description]
  [--display]
  [--fields]
  [--filters]
  [--sorts]

name
source
--args Optional.
--description Optional.
--display Optional.
--fields Optional.
--filters Optional.
--sorts Optional.

delete

crm ds-report delete
  report_id

report_id

download

crm ds-report download
  report_id

report_id

get

crm ds-report get
  report_id

report_id

list

crm ds-report list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, source, created-at
Valid values: args, created-at, created-by, description, display, fields, filters, groups, id, modified-at, modified-by, name, sorts, source
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm ds-report update
  report_id
  [--args]
  [--description]
  [--display]
  [--fields]
  [--filters]
  [--name]
  [--sorts]

report_id
--args Optional.
--description Optional.
--display Optional.
--fields Optional.
--filters Optional.
--name Optional.
--sorts Optional.

ds-table

Job Spec Table commands
Sub commands: add-field, create, delete, delete-field, get, list, query

add-field

crm ds-table add-field
  table_id
  name
  type
  [--options]

table_id
name
type
--options Optional.

create

crm ds-table create
  spec_id
  name
  [--field-name]
  [--field-type]
  [--options]
  [--schema]

spec_id
name
--field-name Optional.
--field-type Optional.
--options Optional.
--schema Optional.

delete

crm ds-table delete
  table_id

table_id

delete-field

crm ds-table delete-field
  table_id
  name

table_id
name

get

crm ds-table get
  table_id

table_id

list

crm ds-table list
  [--spec-id]
  [--fields]

--spec-id Optional.
--fields Optional.
Default: id, spec-id, name, fields
Valid values: created-at, fields, id, modified-at, name, spec-id

query

crm ds-table query
  table_id
  query

table_id
query

Widget commands
Sub commands: create, delete, get, get-output, get-raw-data, list, log, set-default, update

crm ds-widget create
  name
  spec_id
  dashboard_id

name
spec_id
dashboard_id

crm ds-widget delete
  widget_id

widget_id

crm ds-widget get
  widget_id

widget_id

crm ds-widget get-output
  widget_id
  [--args]
  [--scope]

widget_id
--args Optional.
--scope Optional.

crm ds-widget get-raw-data
  widget_id

widget_id

crm ds-widget list
  [--dashboard-id]
  [--fields]
  [--offset]
  [--count]

--dashboard-id Optional.
--fields Optional.
Default: id, name, type, spec-name
Valid values: args, created-at, created-by, dashboard-id, id, last-run-id, last-run-time, max-duration, name, position, refresh, spec-id, spec-name, title, type
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

crm ds-widget log
  widget_id
  [log_id]
  [--count]
  [--offset]

widget_id
log_id Optional.
--count Optional.
Number of items to return.
Default: 50
--offset Optional.
Paging offset.

crm ds-widget set-default
  widget_id

widget_id

crm ds-widget update
  widget_id
  [--args]
  [--debug]
  [--no-debug]
  [--height]
  [--name]
  [--pylon-viewer-spec]
  [--ui-schema]
  [--width]
  [--x]
  [--y]

widget_id
--args Optional.
--debug Optional.
--no-debug Optional.
--height Optional.
--name Optional.
--pylon-viewer-spec Optional.
--ui-schema Optional.
--width Optional.
--x Optional.
--y Optional.

ds-widgetspec

Widget Spec commands
Sub commands: create, delete, get, list, update

create

crm ds-widgetspec create
  name
  job_spec_id
  [--class-name]
  [--scope]
  [--type]

name
job_spec_id
--class-name Optional.
--scope Optional.
--type Optional.
Valid values: graph, html, markdown, metric, table

delete

crm ds-widgetspec delete
  spec_id

spec_id

get

crm ds-widgetspec get
  spec_id

spec_id

list

crm ds-widgetspec list
  [--job-spec-id]
  [--offset]
  [--count]

--job-spec-id Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm ds-widgetspec update
  spec_id
  [--allow-refresh]
  [--args-schema]
  [--class-name]
  [--job-spec-id]
  [--layout-schema]
  [--name]
  [--scope]
  [--type]

spec_id
--allow-refresh Optional.
Valid values: yes, no
--args-schema Optional.
--class-name Optional.
--job-spec-id Optional.
--layout-schema Optional.
--name Optional.
--scope Optional.
--type Optional.
Valid values: graph, html, markdown, metric, table

es-spec

Elastic search spec management
Sub commands: get, list, list-version

get

crm es-spec get
  spec_id

spec_id

list

crm es-spec list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, modified-at, version-name
Valid values: created-at, created-by, id, modified-at, modified-by, name, version-description, version-id, version-name
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-version

crm es-spec list-version
  spec_id
  [--fields]
  [--name]
  [--offset]
  [--count]

spec_id
--fields Optional.
Default: id, name, description, modified-at
Valid values: created-at, created-by, description, id, index-last-collection-at, index-status, modified-at, modified-by, name
--name Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

fm-instance

Form instance management
Sub commands: create, delete, get, list, update

create

crm fm-instance create
  individual_id
  [--assign-individual]
  [--description]
  [--spec-id]
  [--version-id]

individual_id
--assign-individual Optional.
--description Optional.
--spec-id Optional.
--version-id Optional.

delete

crm fm-instance delete
  instance_id

instance_id

get

crm fm-instance get
  instance_id
  [--spec-info]

instance_id
--spec-info Optional.

list

crm fm-instance list
  [--fields]
  [--offset]
  [--count]
  [--individual]
  [--internal]
  [--state]

--fields Optional.
Default: id, individual-id, modified-at, name
Valid values: created-at, created-by, description, id, individual-id, internal, modified-at, modified-by, name, spec-id, state, url, url-expires, version-id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--individual Optional.
--internal Optional.
--state Optional.
Valid values: completed, created, started

update

crm fm-instance update
  instance_id
  [--assign-individual]
  [--unassign-individual]
  [--description]
  [--notify]
  [--no-notify]

instance_id
--assign-individual Optional.
--unassign-individual Optional.
--description Optional.
--notify Optional.
--no-notify Optional.

fm-spec

Form spec management
Sub commands: add-version, create, delete, get, get-schema, list, list-version, update, update-version

add-version

crm fm-spec add-version
  spec_id
  form_schema
  response_schema
  [--current]
  [--description]

spec_id
form_schema
response_schema
--current Optional.
--description Optional.

create

crm fm-spec create
  name
  [--internal]
  [--no-internal]
  [--type]

name
--internal Optional.
--no-internal Optional.
--type Optional.
Default: standard
Valid values: standard, participant-extension

delete

crm fm-spec delete
  spec_id

spec_id

get

crm fm-spec get
  spec_id
  [--version]

spec_id
--version Optional.

get-schema

crm fm-spec get-schema
  spec_id
  [--version]

spec_id
--version Optional.

list

crm fm-spec list
  [--fields]
  [--internal]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, ui-managed, modified-at, version-name
Valid values: created-at, created-by, id, internal, modified-at, modified-by, name, type, ui-managed, version-id, version-name
--internal Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-version

crm fm-spec list-version
  spec_id
  [--name]
  [--fields]
  [--offset]
  [--count]

spec_id
--name Optional.
--fields Optional.
Default: id, name, description, modified-at
Valid values: created-at, created-by, description, id, modified-at, modified-by, name
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm fm-spec update
  spec_id
  [--name]
  [--version]
  [--internal]
  [--no-internal]
  [--ui-managed]
  [--no-ui-managed]
  [--type]

spec_id
--name Optional.
--version Optional.
--internal Optional.
--no-internal Optional.
--ui-managed Optional.
--no-ui-managed Optional.
--type Optional.
Valid values: standard, participant-extension

update-version

crm fm-spec update-version
  version
  [--description]

version
--description Optional.

id-archive

Manage identity archive requests
Sub commands: list

list

crm id-archive list
  [--fields]
  [--individual-id]
  [--offset]
  [--count]

--fields Optional.
Default: created-time, individual-id, email, request-state
Valid values: created-by, created-time, email, individual-id, interview-id, modified-time, request-state
--individual-id Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

id-code

Signup code management
Sub commands: create, delete, get, list

create

crm id-code create
  code
  group_id

code
group_id

delete

crm id-code delete
  code

code

get

crm id-code get
  code

code

list

crm id-code list

id-email

Identity email template management
Sub commands: create, delete, download, get, list, update, upload

create

crm id-email create
  format
  locale
  type
  template
  [--theme]

format
Valid values: html, txt
locale
Valid values: en_US, es_US
type
Valid values: forgot-password, messaging-patient, messaging-provider, onboarding, onboarding-provider, reverify-email, verify-email
template
--theme Optional.

delete

crm id-email delete
  template_id

template_id

download

crm id-email download
  directory
  [--organization]
  [--theme]

directory
--organization Optional.
--theme Optional.

get

crm id-email get
  template_id
  [--template]

template_id
--template Optional.

list

crm id-email list
  [--fields]
  [--organization]
  [--theme]

--fields Optional.
Default: id, type, locale, format, organization-id, theme-id
Valid values: created-at, format, id, locale, modified-at, organization-id, subject, support, support-title, theme-id, type
--organization Optional.
--theme Optional.

update

crm id-email update
  template_id
  [--format]
  [--locale]
  [--subject]
  [--support-email]
  [--support-title]
  [--template]
  [--type]

template_id
--format Optional.
Valid values: html, txt
--locale Optional.
Valid values: en_US, es_US
--subject Optional.
--support-email Optional.
--support-title Optional.
--template Optional.
--type Optional.
Valid values: forgot-password, messaging-patient, messaging-provider, onboarding, onboarding-provider, reverify-email, verify-email

upload

crm id-email upload
  directory
  [--organization]
  [--theme]
  [--force-update]

directory
--organization Optional.
--theme Optional.
--force-update Optional.

id-email-logs

Outgoing email logs
Sub commands: list

list

crm id-email-logs list
  [--destination]
  [--fields]

--destination Optional.
Destination email address.
--fields Optional.
Default: id, timestamp, destination, notification-type, subject
Valid values: bounce-subtype, bounce-type, destination, event-received, id, notification-type, ses-id, ses-raw, source, subject, timestamp

id-feature

Identity feature management
Sub commands: add-org, add-user, create, delete, delete-org, delete-user, get, list, list-org, list-user, update, update-org, update-user

add-org

crm id-feature add-org
  feature
  [--state]
  [--force]

feature
--state Optional.
Default: enabled
Valid values: enabled, disabled, dontcare
--force Optional.

add-user

crm id-feature add-user
  feature
  user_id
  [--org]
  [--no-org]
  [--state]
  [--force]

feature
user_id
--org Optional.
--no-org Optional.
--state Optional.
Default: enabled
Valid values: enabled, disabled, dontcare
--force Optional.

create

crm id-feature create
  feature
  description
  [--assignable]
  [--global]
  [--no-global]
  [--stage]

feature
description
--assignable Optional.
--global Optional.
--no-global Optional.
--stage Optional.
Valid values: alpha, beta, released

delete

crm id-feature delete
  feature
  [--force]

feature
--force Optional.

delete-org

crm id-feature delete-org
  feature

feature

delete-user

crm id-feature delete-user
  feature
  user_id

feature
user_id

get

crm id-feature get
  feature

feature

list

crm id-feature list
  [--offset]
  [--count]
  [--user]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--user Optional.

list-org

crm id-feature list-org
  [--offset]
  [--count]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-user

crm id-feature list-user
  user_id
  [--offset]
  [--count]

user_id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm id-feature update
  feature
  [--assignable]
  [--no-assignable]
  [--description]
  [--global]
  [--no-global]
  [--stage]

feature
--assignable Optional.
--no-assignable Optional.
--description Optional.
--global Optional.
--no-global Optional.
--stage Optional.
Valid values: alpha, beta, released

update-user

crm id-feature update-user
  feature
  user_id
  [--state]
  [--force]

feature
user_id
--state Optional.
Valid values: enabled, disabled, dontcare
--force Optional.

update-org

crm id-feature update-org
  feature
  [--state]
  [--force]

feature
--state Optional.
Valid values: enabled, disabled, dontcare
--force Optional.

id-group

Identity group management
Sub commands: add-leader, create, delete, delete-leader, get, list, log, move, update

add-leader

crm id-group add-leader
  group_id
  user_id

group_id
user_id

create

crm id-group create
  name
  type

name
type
Valid values: regular, provider_only

delete

crm id-group delete
  group_id

group_id

delete-leader

crm id-group delete-leader
  group_id
  user_id

group_id
user_id

get

crm id-group get
  group_id

group_id

list

crm id-group list
  [--fields]
  [--inactive]
  [--individual]
  [--leader]
  [--name]
  [--parent-id]
  [--search]
  [--type]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, type, individual-count, active
Valid values: active, child-count, id, individual-count, leader-count, modified-at, name, node-type, organization-id, parent-id, parent-name, type
--inactive Optional.
--individual Optional.
--leader Optional.
--name Optional.
--parent-id Optional.
--search Optional.
--type Optional.
Valid values: regular, provider_only
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm id-group log
  [group]
  [--individual]
  [--fields]
  [--offset]
  [--count]

group Optional.
--individual Optional.
--fields Optional.
Default: individual-group-id, individual-id, event, subject, created-at
Valid values: created-at, event, id, individual-group-id, individual-id, subject
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

move

crm id-group move
  group_id
  to_parent_group_id
  [--wait]

group_id
to_parent_group_id
--wait Optional.
Wait for task completion.

update

crm id-group update
  group_id
  [--name]

group_id
--name Optional.

id-org

Identity organization management
Sub commands: add-role-user, add-user, create, delete-role-user, get, list, list-role-user, set-default, show, update

create

crm id-org create
  name
  [--classification]
  [--display]
  [--type]
  [--timezone]

name
--classification Optional.
Default: customer
Valid values: carium, customer, carium-test, customer-test
--display Optional.
--type Optional.
Default: coach
Valid values: coach, provider
--timezone Optional.

add-user

crm id-org add-user
  username

username

add-role-user

crm id-org add-role-user
  role
  username

role
username

delete-role-user

crm id-org delete-role-user
  role
  username

role
username

get

crm id-org get
  [organization_id]

organization_id Optional.

list

crm id-org list
  [--fields]
  [--name]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, display, modified-at
Valid values: active, classification, display, id, logo, modified-at, name, theme, timezone, type
--name Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-role-user

crm id-org list-role-user
  role

role

set-default

crm id-org set-default
  organization_id

organization_id

show

crm id-org show

update

crm id-org update
  organization_id
  [--classification]
  [--display]
  [--name]
  [--theme]
  [--timezone]
  [--type]

organization_id
--classification Optional.
--display Optional.
--name Optional.
--theme Optional.
--timezone Optional.
--type Optional.

id-registration

Registration Invite
Sub commands: create, list

list

crm id-registration list
  [--offset]
  [--count]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

create

crm id-registration create
  email

email

id-task

Identity task management
Sub commands: get

get

crm id-task get
  task_id

task_id

id-theme

Manage identity organization theme
Sub commands: create, delete, get, list, update

create

crm id-theme create
  domain
  support_email_name
  [--support-email]

domain
support_email_name
--support-email Optional.
Default: support@carium.com

delete

crm id-theme delete
  theme_id

theme_id

get

crm id-theme get
  theme_id

theme_id

list

crm id-theme list
  [--fields]
  [--domain]
  [--offset]
  [--count]

--fields Optional.
Default: id, domain, support-email, support-email-name
Valid values: created-by, created-time, domain, id, modified-by, modified-time, support-email, support-email-name
--domain Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm id-theme update
  theme_id
  [--domain]
  [--support-email]
  [--support-email-name]

theme_id
--domain Optional.
--support-email Optional.
--support-email-name Optional.

id-user

Identity user management
Sub commands: archive, change-password, clear-password-reset-required, confirm-forgot-password, create, disable, enable, forgot-password, get, list, set-password-reset-required, share, unshare, update

clear-password-reset-required

crm id-user clear-password-reset-required
  user_id

user_id

change-password

crm id-user change-password
  user_id
  [--context]
  [--old-password]
  [--new-password]
  [--maintain-active-sessions]
  [--no-maintain-active-sessions]

user_id
--context Optional.
Valid values: carium-support
--old-password Optional.
--new-password Optional.
--maintain-active-sessions Optional.
--no-maintain-active-sessions Optional.

confirm-forgot-password

crm id-user confirm-forgot-password
  user_id
  code
  [--password]

user_id
code
--password Optional.

create

crm id-user create
  birth_date
  first_name
  last_name
  [--auto-confirm]
  [--email]
  [--gender]
  [--locale]
  [--password]
  [--phone]
  [--preferred-name]

birth_date
first_name
last_name
--auto-confirm Optional.
--email Optional.
--gender Optional.
Default: unknown
--locale Optional.
Default: en_US
--password Optional.
--phone Optional.
--preferred-name Optional.

disable

Disable a user

crm id-user disable
  user_id

user_id

enable

Enable a user

crm id-user enable
  user_id

user_id

forgot-password

crm id-user forgot-password
  user_id
  [--locale]

user_id
--locale Optional.
Valid values: en_US, es_US

get

crm id-user get
  user_id
  [--details]
  [--all-details]

user_id
--details Optional.
Default:
Valid values: badge_count, devices, groups, homefeed, journals, messages, recent_metrics, roles, signups, timeseries
--all-details Optional.

list

crm id-user list
  [--offset]
  [--count]
  [--email]
  [--fields]
  [--individual]
  [--organization]
  [--phone]
  [--query]
  [--shared-with]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--email Optional.
--fields Optional.
Default: id, username, name, birthdate, timezone
Valid values: birthdate, created-at, email, enabled, id, individual-id, locale, locale-explicit, modified-at, name, organization-id, phone, registration-time, status, timezone, timezone-explicit, username, verified
--individual Optional.
--organization Optional.
--phone Optional.
--query Optional.
--shared-with Optional.

crm id-user share
  individual_id
  [--share-with]

individual_id
--share-with Optional.

set-password-reset-required

crm id-user set-password-reset-required
  user_id

user_id

unshare

crm id-user unshare
  individual_id

individual_id

update

crm id-user update
  user_id
  [--email]
  [--first-name]
  [--last-name]
  [--locale]
  [--phone]
  [--tz]
  [--username]

user_id
--email Optional.
--first-name Optional.
--last-name Optional.
--locale Optional.
--phone Optional.
--tz Optional.
--username Optional.
Valid values: email, phone

it-device

Device debugger
Sub commands: bt-reading, sm-reading, sm-validate

bt-reading

crm it-device bt-reading
  imei
  start_time

imei
start_time

sm-reading

crm it-device sm-reading
  device_id
  start_time
  end_time

device_id
start_time
end_time

sm-validate

crm it-device sm-validate
  device_id

device_id

it-ltemaps

Integrator LTE Maps commands
Sub commands: create, delete, list, sync

list

crm it-ltemaps list
  map_type
  [--individual]
  [--organization]
  [--devicetype]
  [--deviceid]
  [--hwideviceid]
  [--imei]
  [--offset]
  [--count]

map_type
Valid values: bodytrace, smartmeter, tenovi, alio
--individual Optional.
--organization Optional.
--devicetype Optional.
--deviceid Optional.
--hwideviceid Optional.
--imei Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

create

crm it-ltemaps create
  map_type
  device_id
  individual_id

map_type
device_id
individual_id

delete

crm it-ltemaps delete
  map_type
  _id

map_type
Valid values: bodytrace, smartmeter, tenovi, alio
_id

sync

crm it-ltemaps sync
  map_type
  _id

map_type
Valid values: bodytrace, smartmeter, tenovi, alio
_id

it-oauth

Integrator Oauth commands
Sub commands: add-feature, create-config, delete-config, list-config, list-types, remove-feature

list-types

crm it-oauth list-types
  individual
  [--type]
  [--details]

individual
--type Optional.
--details Optional.

create-config

crm it-oauth create-config
  individual
  type
  [--fetch-history-days]
  [--fetch-history-months]

individual
type
--fetch-history-days Optional.
Default: 7
--fetch-history-months Optional.
Default: 12

list-config

crm it-oauth list-config
  [--type]
  [--individual]
  [--limit]
  [--offset]

--type Optional.
--individual Optional.
--limit Optional.
Default: 25
--offset Optional.
Paging offset.

delete-config

crm it-oauth delete-config
  _id

_id

add-feature

crm it-oauth add-feature
  individual
  type
  feature

individual
type
feature

remove-feature

crm it-oauth remove-feature
  _id

_id

it-shipment

Device shipment management
Sub commands: get, list, update

get

crm it-shipment get
  _id

_id

list

crm it-shipment list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, tracking-id, tracking-status, tracking-time
Valid values: created-at, id, modified-at, order-id, order-notes, shipper, tracked, tracking-id, tracking-log, tracking-status, tracking-time
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm it-shipment update
  _id
  [--order-individual]
  [--order-notes]
  [--shipper]
  [--tracked]
  [--tracking-id]
  [--tracking-status]

_id
--order-individual Optional.
--order-notes Optional.
--shipper Optional.
--tracked Optional.
--tracking-id Optional.
--tracking-status Optional.

iv-instance

Interview instance management
Sub commands: answer, create, delete, get, list, start, stop, update

answer

crm iv-instance answer
  interview_id
  value

interview_id
value

create

crm iv-instance create
  profile_name
  individual_id
  [--auto-open]
  [--no-auto-open]
  [--auto-start]
  [--no-auto-start]
  [--blocking]
  [--no-blocking]
  [--dismissible]
  [--no-dismissible]
  [--expired-at]
  [--external-data]
  [--version]

profile_name
individual_id
--auto-open Optional.
--no-auto-open Optional.
--auto-start Optional.
--no-auto-start Optional.
--blocking Optional.
--no-blocking Optional.
--dismissible Optional.
--no-dismissible Optional.
--expired-at Optional.
--external-data Optional.
--version Optional.

delete

crm iv-instance delete
  interview_id

interview_id

get

crm iv-instance get
  interview_id

interview_id

list

crm iv-instance list
  [--fields]
  [--auto-open]
  [--no-auto-open]
  [--profile]
  [--individual]
  [--state]
  [--offset]
  [--count]

--fields Optional.
Default: id, profile, created-at, state
Valid values: auto-open, blocking, created-at, created-by, dismissed, dismissible, expired-at, id, individual-id, profile, profile-id, state
--auto-open Optional.
--no-auto-open Optional.
--profile Optional.
--individual Optional.
--state Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

start

crm iv-instance start
  interview_id

interview_id

stop

crm iv-instance stop
  interview_id

interview_id

update

crm iv-instance update
  interview_id
  [--external-data]

interview_id
--external-data Optional.

iv-profile

Workflow profile management
Sub commands: add-version, create, delete, get, get-graph, list, update

add-version

crm iv-profile add-version
  profile_id
  spec

profile_id
spec

create

crm iv-profile create
  name

name

delete

crm iv-profile delete
  profile_id

profile_id

get

crm iv-profile get
  profile_id
  [--version]

profile_id
--version Optional.

get-graph

crm iv-profile get-graph
  profile_id
  [--png]

profile_id
--png Optional.

list

crm iv-profile list
  [--fields]
  [--type]
  [--ui]
  [--no-ui]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, default-version, ui-managed, modified-at
Valid values: auto-open, blocking, count, count-finished, count-in-progress, created-at, created-by, default-version, description, display, id, modified-at, modified-by, name, retake, type, ui-managed
--type Optional.
--ui Optional.
--no-ui Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm iv-profile update
  profile_id
  [--auto-open]
  [--no-auto-open]
  [--blocking]
  [--no-blocking]
  [--retake]
  [--no-retake]
  [--ui-managed]
  [--no-ui-managed]
  [--description]
  [--display-name]
  [--name]
  [--type]

profile_id
--auto-open Optional.
--no-auto-open Optional.
--blocking Optional.
--no-blocking Optional.
--retake Optional.
--no-retake Optional.
--ui-managed Optional.
--no-ui-managed Optional.
--description Optional.
--display-name Optional.
--name Optional.
--type Optional.
Valid values: general, internal

j2

jinja2 template rendering

jb-test

Job tester commands
Sub commands: run-download, run-event, run-report, run-view, sql, unittest

run-download

crm jb-test run-download
  spec_id
  file
  class_name
  output
  [--report]
  [--run-id]
  [--scope]
  [--use-dynamic-table]
  [--widget-args]
  [--widget-height]
  [--widget-name]
  [--widget-width]
  [--widget-x]
  [--widget-y]

spec_id
file
class_name
output
--report Optional.
--run-id Optional.
--scope Optional.
--use-dynamic-table Optional.
--widget-args Optional.
--widget-height Optional.
--widget-name Optional.
--widget-width Optional.
--widget-x Optional.
--widget-y Optional.

run-event

crm jb-test run-event
  spec_id
  file
  class_name
  input
  [--direct-api]
  [--memory-summary]
  [--module-dir]
  [--profile]

spec_id
file
class_name
input
--direct-api Optional.
--memory-summary Optional.
--module-dir Optional.
--profile Optional.

run-report

crm jb-test run-report
  spec_id
  file
  class_name
  [--output]
  [--run-args]
  [--run-id]
  [--scope]

spec_id
file
class_name
--output Optional.
--run-args Optional.
--run-id Optional.
--scope Optional.

run-view

crm jb-test run-view
  spec_id
  file
  class_name
  [--report]
  [--run-id]
  [--scope]
  [--use-dynamic-table]
  [--widget-args]
  [--widget-height]
  [--widget-name]
  [--widget-width]
  [--widget-x]
  [--widget-y]

spec_id
file
class_name
--report Optional.
--run-id Optional.
--scope Optional.
--use-dynamic-table Optional.
--widget-args Optional.
--widget-height Optional.
--widget-name Optional.
--widget-width Optional.
--widget-x Optional.
--widget-y Optional.

sql

crm jb-test sql
  sql
  [--database]
  [--verbose]

sql
--database Optional.
Default: redshift
--verbose Optional.

unittest

crm jb-test unittest
  test_module

test_module

lc-entries

Lachesis time-series commands
Sub commands: clean, create, delete, delete-source, list, list-meta, list-source

clean

crm lc-entries clean
  type
  [--individual]

type
--individual Optional.

create

crm lc-entries create
  type
  value
  [--context]
  [--individual]
  [--time]
  [--source]

type
value
--context Optional.
--individual Optional.
--time Optional.
--source Optional.
Default: manual

delete

crm lc-entries delete
  type
  time
  [--individual]

type
time
--individual Optional.

delete-source

crm lc-entries delete-source
  source_id
  [--no-wait/-n]

source_id
--no-wait/-n Optional.

list

crm lc-entries list
  type
  [--context]
  [--end-time]
  [--individual]
  [--source]
  [--start-time]
  [--delete]
  [--offset]
  [--count]

type
--context Optional.
--end-time Optional.
--individual Optional.
--source Optional.
--start-time Optional.
--delete Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-meta

crm lc-entries list-meta
  [--individual]

--individual Optional.

list-source

crm lc-entries list-source
  [--fields]
  [--individual]
  [--source]
  [--offset]
  [--count]

--fields Optional.
Default: id, type, source, organization
Valid values: id, organization, registered-at, series-id, source, type
--individual Optional.
--source Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

lc-tca

Lachesis TCA management
Sub commands: delete, list

delete

crm lc-tca delete
  tca_id

tca_id

list

crm lc-tca list
  [--individual]
  [--alerter-type]

--individual Optional.
--alerter-type Optional.
Default: Range
Valid values: Range, Watermark

logout

Logout command

pg-design

Design related commands
Sub commands: create, delete, download, export, get, import, list, set-default, upload, validate

create

crm pg-design create
  name

name

delete

crm pg-design delete
  design_id

design_id

download

crm pg-design download
  design_id
  [output]

design_id
output Optional.
If not specified, will create the files in cwd.

export

crm pg-design export
  design_id
  wftype_id

design_id
wftype_id

get

crm pg-design get
  design_id
  [--section]

design_id
--section Optional.
Valid values: design, state, event, interaction

import

crm pg-design import
  design_id
  wftype_id
  [--wf-version]

design_id
wftype_id
--wf-version Optional.

list

crm pg-design list
  [--offset]
  [--count]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

set-default

crm pg-design set-default
  design_id

design_id

upload

crm pg-design upload
  design_id
  [input]

design_id
input Optional.
If not specified, will upload the files from cwd.

validate

crm pg-design validate
  design_id
  realm_id

design_id
realm_id

pg-interaction

Interaction-related commands
Sub commands: get

get

crm pg-interaction get
  interaction_id
  [--section]

interaction_id
--section Optional.
Valid values: interaction, invocation, action

pg-realm

Realm management
Sub commands: create, delete, get, list, set-default, update-args

create

crm pg-realm create
  design_id
  name
  [--time]
  [--args]

design_id
name
--time Optional.
--args Optional.

delete

crm pg-realm delete
  realm_id

realm_id

get

crm pg-realm get
  realm_id

realm_id

list

crm pg-realm list
  design_id
  [--offset]
  [--count]

design_id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

set-default

crm pg-realm set-default
  realm_id

realm_id

update-args

crm pg-realm update-args
  realm_id
  args

realm_id
args

pg-sim

Playground simulation related commands
Sub commands: change-time, create, create-object, delete, get, get-object, list, list-objects, start

change-time

crm pg-sim change-time
  sim_id
  time

sim_id
time
absolute (2010-01-01 00:00:00) or relative ("1 days 01:00:00", "-01", "-01:00:00").

create

crm pg-sim create
  realm_id
  profile_id
  [--name]
  [--version]

realm_id
profile_id
--name Optional.
--version Optional.

create-object

crm pg-sim create-object
  sim_id
  service
  type
  content

sim_id
service
type
content

delete

crm pg-sim delete
  sim_id

sim_id

get

crm pg-sim get
  sim_id

sim_id

get-object

crm pg-sim get-object
  obj_id

obj_id

list

crm pg-sim list
  [--offset]
  [--count]
  [--inactive]
  [--name]

--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--inactive Optional.
--name Optional.

list-objects

crm pg-sim list-objects
  sim_id
  [--service]
  [--type]

sim_id
--service Optional.
--type Optional.

start

crm pg-sim start
  sim_id

sim_id

pk-bundle

Package bundle manager
Sub commands: diff, download, init, show, upload

diff

crm pk-bundle diff
  section
  [--filter]

section
Valid values: announcer, article, careplan, dashboard, event, feature, form, pathway, survey, theme, workflow
--filter Optional.

download

crm pk-bundle download
  section
  [--filter]

section
Valid values: announcer, article, careplan, dashboard, event, feature, form, pathway, survey, theme, workflow
--filter Optional.

init

crm pk-bundle init
  [--path]
  [--reset]

--path Optional.
--reset Optional.

show

crm pk-bundle show

upload

crm pk-bundle upload
  section
  [--filter]
  [--override]

section
Valid values: announcer, article, careplan, dashboard, event, feature, form, pathway, survey, theme, workflow
--filter Optional.
--override Optional.

pw-instance

Pathway instance management
Sub commands: delete, get, list, log, set-stage, update

delete

crm pw-instance delete
  instance_id

instance_id

get

crm pw-instance get
  instance_id
  [--store-schema]

instance_id
--store-schema Optional.

list

crm pw-instance list
  [--fields]
  [--individual]
  [--spec]
  [--state]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, created-at, state, version-name
Valid values: created-at, created-by, id, individual-id, modified-at, name, state, version-name
--individual Optional.
--spec Optional.
--state Optional.
Valid values: archived, completed, created, started
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm pw-instance log
  instance_id
  [log_id]
  [--fields]
  [--filter]
  [--log-level]
  [--step]
  [--offset]
  [--count]

instance_id
log_id Optional.
--fields Optional.
Default: id, created-at, level, step-name, user-name, message
Valid values: created-at, id, level, message, step-name, user-name
--filter Optional.
--log-level Optional.
Valid values: debug, info, warning, error, critical
--step Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

set-stage

crm pw-instance set-stage
  instance_id
  stage

instance_id
stage

update

crm pw-instance update
  instance_id
  [--description]
  [--store-schema]

instance_id
--description Optional.
--store-schema Optional.

pw-spec

Pathway spec management
Sub commands: create, create-stage, create-stage-link, create-step, delete, dump, get, list, list-stage, list-step, load, update

create

crm pw-spec create
  name
  [--allow-duplicate]

name
--allow-duplicate Optional.

create-stage

crm pw-spec create-stage
  spec_id
  name
  title

spec_id
name
title

create-stage-link

crm pw-spec create-stage-link
  stage1_id
  stage2_id

stage1_id
stage2_id

create-step

crm pw-spec create-step
  stage_id
  name
  title
  [--type]

stage_id
name
title
--type Optional.
Default: basic.Action

delete

crm pw-spec delete
  spec_id

spec_id

dump

crm pw-spec dump
  spec_id

spec_id

get

crm pw-spec get
  spec_id

spec_id

load

crm pw-spec load
  spec_id
  model

spec_id
model

list

crm pw-spec list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, modified-at, version-name
Valid values: created-at, created-by, id, modified-at, modified-by, name, version-id, version-name
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-stage

crm pw-spec list-stage
  spec_id
  [--fields]
  [--offset]
  [--count]

spec_id
--fields Optional.
Default: id, name, title, links
Valid values: created-at, created-by, id, links, modified-at, modified-by, name, title
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-step

crm pw-spec list-step
  stage_id
  [--fields]
  [--offset]
  [--count]

stage_id
--fields Optional.
Default: id, name, type
Valid values: created-at, created-by, description, id, modified-at, modified-by, name, necessity, title, type
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm pw-spec update
  version_id
  [--description]
  [--store-schema]

version_id
--description Optional.
--store-schema Optional.

pw-step

Pathway step management
Sub commands: get, list-reminder, set-state, trigger-reminder, update

get

crm pw-step get
  step_id

step_id

list-reminder

crm pw-step list-reminder
  step_id
  [--offset]
  [--count]

step_id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

set-state

crm pw-step set-state
  step_id
  state

step_id
state
Valid values: new, incomplete, inprogress, inreview, skipped, complete, archived

update

crm pw-step update
  step_id
  [--args]
  [--description]
  [--due-date]
  [--generate-event]
  [--no-generate-event]
  [--group-id]
  [--order]
  [--title]
  [--user-id]

step_id
--args Optional.
--description Optional.
--due-date Optional.
--generate-event Optional.
--no-generate-event Optional.
--group-id Optional.
--order Optional.
--title Optional.
--user-id Optional.

trigger-reminder

crm pw-step trigger-reminder
  step_id
  reminder

step_id
reminder

py-cerner

Pylon EHR Cerner commands
Sub commands: list-cred

list-cred

crm py-cerner list-cred
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, organization-id
Valid values: id, name, organization-id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

py-elation

Pylon EHR Elation commands
Sub commands: list-cred

list-cred

crm py-elation list-cred
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, organization-id
Valid values: id, name, organization-id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

py-epic

Pylon EHR EPIC commands
Sub commands: list-account

list-account

crm py-epic list-account
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, organization-id
Valid values: id, name, organization-id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

py-jobexec

Job Executor Configuration commands
Sub commands: create, delete, get, list, update

create

crm py-jobexec create
  name
  [--organization]
  [--wait]
  [--memory-size]
  [--runtime-version]

name
Executor name.
--organization Optional.
Organization ID if different from default.
--wait Optional.
--memory-size Optional.
Memory size in MB.
--runtime-version Optional.
Lambda Runtime version (eg 1.2.3, $STABLE, or $LATEST).

delete

crm py-jobexec delete
  executor_id

executor_id

get

crm py-jobexec get
  executor_id

executor_id

list

crm py-jobexec list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, memory-size, runtime-version, status
Valid values: created-at, created-by, id, last-updated-at, last-updated-by, memory-size, name, runtime-version, status
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm py-jobexec update
  executor_id
  [--wait]
  [--memory-size]
  [--runtime-version]

executor_id
--wait Optional.
--memory-size Optional.
Memory size in MB.
--runtime-version Optional.
Lambda Runtime version (eg 1.2.3, $STABLE, or $LATEST).

py-jobsecret

Job Secret commands
Sub commands: create, delete, get-value, list, update

create

crm py-jobsecret create
  name
  [--type]
  [--json-value]

name
Unique name for the secret.
--type Optional.
Default: json
Valid values: json
--json-value Optional.

delete

crm py-jobsecret delete
  secret_id

secret_id

list

crm py-jobsecret list
  [--fields]

--fields Optional.
Default: id, name, type, modified-at
Valid values: created-at, created-by, global, id, modified-at, modified-by, name, organization, type

update

crm py-jobsecret update
  secret_id
  [--json-value]

secret_id
--json-value Optional.

get-value

crm py-jobsecret get-value
  secret_id

secret_id

py-jobspec

Job Spec commands
Sub commands: add-secret, create, create-module, create-queue, create-queue-entry, delete, delete-queue, delete-storage, get, get-queue, get-storage, list, list-queue, list-queue-entry, list-storage, log, remove-secret, run, set-default, update

add-secret

crm py-jobspec add-secret
  spec_id
  key
  [--secret-name]

spec_id
key
Arbitrary key to bind the secret value to.
--secret-name Optional.
Name of the secret.

create

crm py-jobspec create
  object
  event
  code
  class_name
  [--executor]
  [--name]

object
event
code
class_name
--executor Optional.
--name Optional.

create-module

crm py-jobspec create-module
  name
  code
  [--global]
  [--description]

name
code
--global Optional.
--description Optional.

create-queue

crm py-jobspec create-queue
  spec_id
  name
  [--worker-count]

spec_id
name
--worker-count Optional.
Default: 1

create-queue-entry

crm py-jobspec create-queue-entry
  queue_id
  data

queue_id
data

delete

crm py-jobspec delete
  spec_id

spec_id

delete-queue

crm py-jobspec delete-queue
  queue_id

queue_id

delete-storage

crm py-jobspec delete-storage
  storage_id

storage_id

get

crm py-jobspec get
  spec_id
  [--args]
  [--code]
  [--schema]

spec_id
--args Optional.
--code Optional.
--schema Optional.

get-queue

crm py-jobspec get-queue
  queue_id

queue_id

get-storage

crm py-jobspec get-storage
  storage_id

storage_id

list

crm py-jobspec list
  [--executor]
  [--fields]
  [--refcode]
  [--offset]
  [--count]

--executor Optional.
--fields Optional.
Default: id, object, event, name, count-trigger, count-filter
Valid values: args, class, container, count-filter, count-trigger, created-at, created-by, differences, event, executor-id, executor-name, filter, id, modified-at, modified-by, monitored, name, object, run-as, schedule-id, schedule-rrule, schedule-start, schedule-timezone, secret-bindings
--refcode Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-queue

crm py-jobspec list-queue
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, spec-id, worker, entries
Valid values: entries, id, name, spec-id, worker
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-queue-entry

crm py-jobspec list-queue-entry
  queue_id
  [--offset]
  [--count]

queue_id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-storage

crm py-jobspec list-storage
  spec_id
  [--fields]
  [--offset]
  [--count]

spec_id
--fields Optional.
Default: id, index, created-at, value
Valid values: created-at, id, index, modified-at, value
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm py-jobspec log
  spec_id
  [log_id]
  [--offset]
  [--filter]
  [--count]
  [--last]
  [--input]
  [--status]
  [--wait]
  [-f/--follow]

spec_id
log_id Optional.
--offset Optional.
Paging offset.
--filter Optional.
--count Optional.
Default: 10
--last Optional.
--input Optional.
--status Optional.
Valid values: dropped-dup, dropped-filter, dropped-rate, debounced, failed, running, started, success
--wait Optional.
-f/--follow Optional.

remove-secret

crm py-jobspec remove-secret
  spec_id
  key

spec_id
key
Key to unbind.

run

crm py-jobspec run
  spec_id
  data
  [--wait]

spec_id
data
JSON, log-id, or log~N to use last-log's input.
--wait Optional.

set-default

crm py-jobspec set-default
  spec_id

spec_id

update

crm py-jobspec update
  spec_id
  [--allow-continuation]
  [--allow-participant]
  [--args]
  [--args-schema]
  [--class]
  [--code]
  [--consecutive-threshold]
  [--event]
  [--executor]
  [--filter]
  [--log-level]
  [--log-limit]
  [--monitored]
  [--not-allow-continuation]
  [--not-allow-participant]
  [--not-monitored]
  [--name]
  [--object]
  [--run-as]
  [--runs-per-minute]
  [--schedule-rrule]
  [--schedule-start]
  [--schedule-timezone]
  [--schema]
  [--ui-args-schema]

spec_id
--allow-continuation Optional.
--allow-participant Optional.
--args Optional.
--args-schema Optional.
--class Optional.
--code Optional.
--consecutive-threshold Optional.
--event Optional.
--executor Optional.
Executor ID.
--filter Optional.
--log-level Optional.
Valid values: debug, info, warning, error, critical
--log-limit Optional.
--monitored Optional.
--not-allow-continuation Optional.
--not-allow-participant Optional.
--not-monitored Optional.
--name Optional.
--object Optional.
--run-as Optional.
--runs-per-minute Optional.
--schedule-rrule Optional.
--schedule-start Optional.
--schedule-timezone Optional.
--schema Optional.
--ui-args-schema Optional.

py-module

Job Module commands
Sub commands: create, create-version, delete, get, get-version, list, update, update-version

create

crm py-module create
  name
  code
  [--global]
  [--description]

name
code
--global Optional.
--description Optional.

create-version

crm py-module create-version
  module_id
  name
  code
  [--description]

module_id
name
code
--description Optional.

delete

crm py-module delete
  module_id

module_id

get

crm py-module get
  module_id
  [--code]

module_id
--code Optional.

get-version

crm py-module get-version
  version_id
  [--code]

version_id
--code Optional.

list

crm py-module list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, modified-at, version, global
Valid values: created-at, description, global, id, modified-at, name, version
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm py-module update
  module_id
  [--description]
  [--version]
  [--name]

module_id
--description Optional.
--version Optional.
--name Optional.

update-version

crm py-module update-version
  version_id
  [--code]
  [--description]
  [--name]

version_id
--code Optional.
--description Optional.
--name Optional.

py-repo

Pylon repository management
Sub commands: create, delete, list, update

create

crm py-repo create
  name
  key
  url
  [--global]

name
key
url
--global Optional.

delete

crm py-repo delete
  repo_id

repo_id

list

crm py-repo list
  [--fields]

--fields Optional.
Default: id, name, url, global
Valid values: created-at, global, id, modified-at, name, url

update

crm py-repo update
  repo_id
  [--key]
  [--url]

repo_id
--key Optional.
--url Optional.

py-s3-event

Pylon S3 event commands
Sub commands: list-files, list-maps

list-maps

crm py-s3-event list-maps
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, key-prefix, bucket-name, created-at
Valid values: bucket-name, created-at, id, key-prefix
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-files

crm py-s3-event list-files
  map_id
  [--fields]
  [--offset]
  [--count]

map_id
--fields Optional.
Default: id, filename, created-at
Valid values: created-at, filename, id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

py-setting

Pylon setting commands
Sub commands: create, delete, get, list, update

create

crm py-setting create
  name
  value

name
value

delete

crm py-setting delete
  setting_id

setting_id

get

crm py-setting get
  setting_id

setting_id

list

crm py-setting list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, modified-at, name, value
Valid values: created-at, id, modified-at, name, value
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm py-setting update
  setting_id
  [--value]

setting_id
--value Optional.

py-sftp-remote

Pylon SFTP remote server management
Sub commands: cli, create, delete, get, list, list-put, put, update

create

crm py-sftp-remote create
  name
  username
  host
  [--port]
  [--password]

name
username
host
--port Optional.
--password Optional.

delete

crm py-sftp-remote delete
  remote_id

remote_id

get

crm py-sftp-remote get
  remote_id
  [--public-key]

remote_id
--public-key Optional.

list

crm py-sftp-remote list
  [--name]
  [--fields]
  [--offset]
  [--count]

--name Optional.
--fields Optional.
Default: id, name, host, username
Valid values: host, id, name, username
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm py-sftp-remote update
  remote_id
  [--username]
  [--host]
  [--port]
  [--password]
  [--no-password]

remote_id
--username Optional.
--host Optional.
--port Optional.
--password Optional.
--no-password Optional.

cli

crm py-sftp-remote cli
  remote_id
  command

remote_id
command
Valid values: ls

put

crm py-sftp-remote put
  remote_id
  source_filepath
  remote_filepath
  [--content-type]

remote_id
source_filepath
remote_filepath
--content-type Optional.

list-put

crm py-sftp-remote list-put
  remote_id
  [--fields]
  [--offset]
  [--count]

remote_id
--fields Optional.
Default: id, source, target, status
Valid values: content-type, id, source, status, target
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

py-sftp-user

Pylon SFTP user management
Sub commands: add-key, create, delete, get, list, remove-key

add-key

crm py-sftp-user add-key
  user_id
  public_key

user_id
SFTP user id.
public_key
Public key to upload.

create

crm py-sftp-user create
  username
  [--org]

username
--org Optional.
Organization owning SFTP user. Default: active organization.

delete

crm py-sftp-user delete
  user_id

user_id
SFTP user id.

get

crm py-sftp-user get
  user_id

user_id
SFTP user id.

list

crm py-sftp-user list
  [--username]
  [--fields]

--username Optional.
--fields Optional.
Default: id, username, organization-id, key-count
Valid values: id, key-count, keys, organization-id, username

remove-key

crm py-sftp-user remove-key
  user_id
  key_id

user_id
SFTP user id.
key_id
ID of SFTP Key to delete.

py-vcs

Pylon repository management
Sub commands: create, delete, get, list, sync, update, update-status

create

crm py-vcs create
  spec_id
  repo_id
  path
  [--branch]

spec_id
repo_id
path
--branch Optional.
Default: master

delete

crm py-vcs delete
  vcs_id

vcs_id

get

crm py-vcs get
  vcs_id

vcs_id

list

crm py-vcs list
  [--fields]

--fields Optional.
Default: id, spec-name, repository-name, path, is-dirty
Valid values: branch, created-at, id, is-dirty, modified-at, path, repository-id, repository-name, spec-id, spec-name

sync

crm py-vcs sync
  vcs_id

vcs_id

update

crm py-vcs update
  vcs_id
  [--branch]
  [--path]

vcs_id
--branch Optional.
--path Optional.

update-status

crm py-vcs update-status

shell

Enter IPython REPL with brewmaster initialized

Banner commands
Sub commands: create, delete, get, list, update

crm sw-banner create
  name
  type
  message_en
  message_es
  [--args]
  [--description]

name
type
Valid values: survey, upgrade
message_en
message_es
--args Optional.
--description Optional.

crm sw-banner delete
  banner_id

banner_id

crm sw-banner get
  banner_id

banner_id

crm sw-banner list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, type, description, message
Valid values: args, description, id, message, messages, name, type
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

crm sw-banner update
  banner_id
  [--args]
  [--description]
  [--message-en]
  [--message-es]
  [--name]

banner_id
--args Optional.
--description Optional.
--message-en Optional.
--message-es Optional.
--name Optional.

sw-company

Company Commands
Sub commands: create, delete, list, update

create

crm sw-company create
  name
  app_display_name
  display_name
  care_app_display_name
  [--app-url-android]
  [--app-url-ios]
  [--care-app-url-android]
  [--care-app-url-ios]
  [--default-organization-code]
  [--fqdn]
  [--support-email]

name
app_display_name
display_name
care_app_display_name
--app-url-android Optional.
--app-url-ios Optional.
--care-app-url-android Optional.
--care-app-url-ios Optional.
--default-organization-code Optional.
--fqdn Optional.
--support-email Optional.

list

crm sw-company list
  [--fields]
  [--name]
  [--fqdn]
  [--offset]
  [--count]

--fields Optional.
Default: fqdn, name, app-url-android, app-url-ios, support-email
Valid values: app-display-name, app-url-android, app-url-ios, care-app-display-name, care-app-url-android, care-app-url-ios, default-organization-code, display-name, fqdn, id, name, support-email
--name Optional.
--fqdn Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm sw-company update
  company_id
  [--app-url-android]
  [--app-url-ios]
  [--care-app-url-android]
  [--care-app-url-ios]
  [--default-organization-code]
  [--fqdn]
  [--support-email]

company_id
--app-url-android Optional.
--app-url-ios Optional.
--care-app-url-android Optional.
--care-app-url-ios Optional.
--default-organization-code Optional.
--fqdn Optional.
--support-email Optional.

delete

crm sw-company delete
  company_id

company_id

sw-debugger

Debugger commands
Sub commands: create, delete, list, log

create

crm sw-debugger create
  individual_id

individual_id

delete

crm sw-debugger delete
  debugger_id

debugger_id

list

crm sw-debugger list
  [--fields]
  [--individual]
  [--offset]
  [--count]

--fields Optional.
Default: id, created-at, individual-id, scopes
Valid values: created-at, id, individual-id, scopes
--individual Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm sw-debugger log
  debugger_id
  [--offset]
  [--count]
  [--colsize]
  [--fields]

debugger_id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--colsize Optional.
Default: 100
--fields Optional.
Default: created-at, message
Valid values: created-at, id, message

sw-helpdoc

Help Docs commands
Sub commands: create

create

crm sw-helpdoc create
  name
  url
  [--org]
  [--locale]
  [--doc-type]
  [--order]

name
url
--org Optional.
--locale Optional.
Default: en_US
Valid values: en_US, es_US
--doc-type Optional.
Valid values: participant, provider
--order Optional.

sw-landingpage

Landing Page
Sub commands: create, delete, list, upload-image

create

crm sw-landingpage create
  company_name
  name
  order
  [--details-en]
  [--details-es]
  [--min-android-version]
  [--min-ios-version]
  [--titles-en]
  [--titles-es]

company_name
name
order
--details-en Optional.
--details-es Optional.
--min-android-version Optional.
--min-ios-version Optional.
--titles-en Optional.
--titles-es Optional.

upload-image

crm sw-landingpage upload-image
  id
  file
  [--offset]
  [--count]

id
file
Path to file name.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list

crm sw-landingpage list
  [--fields]
  [--name]
  [--company-name]
  [--offset]
  [--count]

--fields Optional.
Default: company-name, details-en, details-es, id, name, order
Valid values: company-name, details-en, details-es, id, min-android-version, min-ios-version, name, order, titles-en, titles-es
--name Optional.
--company-name Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

delete

crm sw-landingpage delete
  id

id

sw-logo

Private label logo commands
Sub commands: create, delete, list

create

Upload new or replace an existing logo

crm sw-logo create
  fqdn
  type
  filename

fqdn
Private label fully-qualified domain name.
type
Logo type to upload (LOGO_SIGN_IN, LOGO, FAVICON_32, ...).
filename
Path to logo file to upload.

delete

crm sw-logo delete
  logo_id

logo_id

list

crm sw-logo list
  [--fields]
  [--fqdn]
  [--offset]
  [--count]

--fields Optional.
Default: fqdn, id, active, type, image-url
Valid values: active, fqdn, id, image-url, type
--fqdn Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

sw-patient

Patient commands
Sub commands: create, list

create

crm sw-patient create
  email
  birth_date
  first_name
  last_name
  [--gender]
  [--locale]
  [--group]

email
birth_date
first_name
last_name
--gender Optional.
Default: pnta
Valid values: male, female, pnta, unknown, other
--locale Optional.
Default: en_US
Valid values: en_US, es_US
--group Optional.

list

crm sw-patient list
  [--birth-date]
  [--fields]
  [--first-name]
  [--last-name]
  [--unverified]
  [--offset]
  [--count]

--birth-date Optional.
--fields Optional.
Default: id, email
Valid values: email, first-name, id, last-name, user-id, verified
--first-name Optional.
--last-name Optional.
--unverified Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

sw-provider

Provider commands
Sub commands: create

create

crm sw-provider create
  email
  first_name
  last_name
  [--locale]
  [--admin]
  [--organization]

email
first_name
last_name
--locale Optional.
Default: en_US
Valid values: en_US, es_US
--admin Optional.
--organization Optional.

version

Show version information

wf-config

Workflow program config
Sub commands: create, delete, get, list, update, update-args

create

crm wf-config create
  name
  [--args]

name
--args Optional.

delete

crm wf-config delete
  config_id

config_id

get

crm wf-config get
  config_id

config_id

list

crm wf-config list
  [--fields]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, created-at, args
Valid values: args, created-at, created-by, id, modified-at, modified-by, name, new-user
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm wf-config update
  config_id
  [--args]

config_id
--args Optional.

update-args

crm wf-config update-args
  config_id
  [--rpm-billing]
  [--no-rpm-billing]
  [--ccm-billing]
  [--no-ccm-billing]
  [--add-email-id]
  [--remove-email-id]
  [--todo-group-id]
  [--disable-flag]
  [--enable-flag]

config_id
--rpm-billing Optional.
--no-rpm-billing Optional.
--ccm-billing Optional.
--no-ccm-billing Optional.
--add-email-id Optional.
--remove-email-id Optional.
--todo-group-id Optional.
--disable-flag Optional.
--enable-flag Optional.

wf-instance

Workflow instance management
Sub commands: create, delete, get, get-stats, list, log, set-default

create

crm wf-instance create
  type_id
  individual_id
  [--version]
  [--user-metadata]
  [--interaction-args]
  [--sim-args]

type_id
individual_id
--version Optional.
--user-metadata Optional.
--interaction-args Optional.
--sim-args Optional.

delete

crm wf-instance delete
  workflow_id

workflow_id

get

crm wf-instance get
  workflow_id

workflow_id

get-stats

crm wf-instance get-stats
  workflow_id

workflow_id

list

crm wf-instance list
  [--fields]
  [--individual]
  [--workflow-name]
  [--offset]
  [--count]

--fields Optional.
Default: id, type-name, created-at, individual-id
Valid values: active, created-at, created-by, id, individual-id, interaction-args, modified-at, state, state-data, stats, type-id, type-name, user-metadata, version
--individual Optional.
--workflow-name Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm wf-instance log
  workflow_id
  [-f/--follow]
  [--with-data]
  [--level]
  [--count]

workflow_id
-f/--follow Optional.
--with-data Optional.
--level Optional.
Default: DEBUG
Valid values: DEBUG, INFO, WARN, ERROR, CRIT
--count Optional.
Number of items to return.
Default: 50

set-default

crm wf-instance set-default
  workflow_id

workflow_id

wf-interaction

Workflow interaction management
Sub commands: delete, event, get, list, log

delete

crm wf-interaction delete
  interaction_id

interaction_id

event

crm wf-interaction event
  interaction_id
  invocation_id
  [--data]

interaction_id
invocation_id
--data Optional.

get

crm wf-interaction get
  interaction_id

interaction_id

list

crm wf-interaction list
  [--fields]
  [--offset]
  [--count]
  [--profile]
  [--individual]
  [--workflow]
  [--inactive]

--fields Optional.
Default: id, profile, version, created-at, individual-id
Valid values: active, args, created-at, created-by, id, individual-id, profile, profile-id, user-id, version, workflow-id
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--profile Optional.
--individual Optional.
--workflow Optional.
--inactive Optional.

log

crm wf-interaction log
  interaction_id
  [-f/--follow]
  [--with-data]
  [--count]
  [--level]

interaction_id
-f/--follow Optional.
--with-data Optional.
--count Optional.
Default: 20
--level Optional.
Default: DEBUG
Valid values: DEBUG, INFO, WARN, ERROR, CRIT

wf-lnp

LNP management
Sub commands: delete, get, get-run, list, list-run, update

delete

crm wf-lnp delete
  program

program

get

crm wf-lnp get
  program

program

get-run

crm wf-lnp get-run
  run

run

list

crm wf-lnp list
  [--fields]
  [--offset]
  [--count]
  [--name]

--fields Optional.
Default: id, name, created-at, armed, event-type
Valid values: active-version, armed, created-at, created-by, description, event-type, id, modified-at, modified-by, name, run-as
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50
--name Optional.

list-run

crm wf-lnp list-run
  program
  [--fields]
  [--offset]
  [--count]

program
--fields Optional.
Default: id, created-at, status
Valid values: created-at, error, id, modified-at, status
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

update

crm wf-lnp update
  program
  [--arm]
  [--disarm]
  [--description]
  [--event-filter]
  [--event-type]

program
--arm Optional.
--disarm Optional.
--description Optional.
--event-filter Optional.
--event-type Optional.

wf-profile

Workflow profile management
Sub commands: add-version, delete, find-versions, get, list, set-default

add-version

crm wf-profile add-version
  profile_id
  spec
  [--name]

profile_id
spec
--name Optional.

delete

crm wf-profile delete
  profile_id

profile_id

find-versions

crm wf-profile find-versions
  spec

spec

get

crm wf-profile get
  profile_id
  [--version]

profile_id
--version Optional.

list

crm wf-profile list
  [--fields]
  [--name]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, default-version, default-version-hash, created-at
Valid values: active, created-at, created-by, created-by-id, default-version, default-version-hash, id, modified-at, modified-by, modified-by-id, name, organization-id
--name Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

set-default

crm wf-profile set-default
  profile_id

profile_id

wf-program

Workflow program
Sub commands: create, delete, get, list, list-args, list-args-history, log, start, stop, update, update-args

create

crm wf-program create
  name
  individual_id
  [--auto-start]
  [--args]

name
individual_id
--auto-start Optional.
--args Optional.

delete

crm wf-program delete
  program_id

program_id

get

crm wf-program get
  program_id
  [--args]

program_id
--args Optional.

list

crm wf-program list
  [--fields]
  [--individual]
  [--name]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, individual-id, state
Valid values: args, created-at, derived-args, id, individual-id, modified-at, name, state, storage
--individual Optional.
--name Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-args

crm wf-program list-args
  [--fields]
  [--individual]
  [--name]
  [--offset]
  [--count]

--fields Optional.
Default: id, derived-args, billing-eligible, ccm-billing-eligible, num-of-emails
Valid values: billing-eligible, ccm-billing-eligible, created-at, derived-args, email-individual-ids, id, individual-id, num-of-emails, state, todo-group-id
--individual Optional.
--name Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

list-args-history

crm wf-program list-args-history
  program_id
  [log_id]
  [--offset]
  [--count]

program_id
log_id Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

log

crm wf-program log
  program_id
  [log_id]
  [--colsize]
  [--fields]
  [--offset]
  [--count]

program_id
log_id Optional.
--colsize Optional.
Default: 30
--fields Optional.
Default: id, created-at, level, message
Valid values: created-at, data, id, level, message
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

start

crm wf-program start
  program_id

program_id

stop

crm wf-program stop
  program_id

program_id

update

crm wf-program update
  program_id
  [--args]

program_id
--args Optional.

update-args

crm wf-program update-args
  program_id
  [--rpm-billing]
  [--no-rpm-billing]
  [--ccm-billing]
  [--no-ccm-billing]
  [--add-email-id]
  [--remove-email-id]
  [--todo-group-id]
  [--disable-flag]
  [--enable-flag]

program_id
--rpm-billing Optional.
--no-rpm-billing Optional.
--ccm-billing Optional.
--no-ccm-billing Optional.
--add-email-id Optional.
--remove-email-id Optional.
--todo-group-id Optional.
--disable-flag Optional.
--enable-flag Optional.

wf-type

Workflow-type management
Sub commands: create, delete, diff, get, list, set-default, update

create

crm wf-type create
  name
  category
  [--type]
  [--supports-unverified-users]

name
category
--type Optional.
--supports-unverified-users Optional.

delete

crm wf-type delete
  type_id

type_id

diff

crm wf-type diff
  type_id
  [--detail]

type_id
--detail Optional.
Default: none
Valid values: none, partial, full

get

crm wf-type get
  type_id
  [--version]

type_id
--version Optional.

list

crm wf-type list
  [--fields]
  [--name]
  [--type]
  [--offset]
  [--count]

--fields Optional.
Default: id, name, type, category, select-version, select-hash
Valid values: active, category, created-at, created-by, id, latest-detail, latest-hash, latest-version, modified-at, modified-by, name, select-detail, select-hash, select-version, support-unverified, type
--name Optional.
--type Optional.
--offset Optional.
Paging offset.
--count Optional.
Number of items to return.
Default: 50

set-default

crm wf-type set-default
  type_id

type_id

update

crm wf-type update
  type_id
  [--supports-unverified-users/-s]
  [--no-supports-unverified-users/-u]

type_id
--supports-unverified-users/-s Optional.
--no-supports-unverified-users/-u Optional.

whoami

Show current user information

Global Options​

Commands​

api​

delete​

get​

patch​

post​

cd-appointment​

create-status​

create-type​

list-status​

list-type​

update-status​

cd-article​

add-content-file​

add-content-url​

bulk-create​

create​

delete​

delete-content​

get​

list​

update​

cd-calendly​

list-account​

list-user​

get-user​

cd-challenge​

create​

delete​

get​

list​

cd-cobject​

add-column​

alter-column​

alter-table​

create-table​

drop-table​

describe​

drop-column​

select​

show-tables​

cd-encounter​

create-type​

delete-type​

get​

list​

list-type​

create​

delete​

cd-orgcare​

create​

delete​

get​

list​

update​

cd-orgdoc​

create​

delete​

download​

list​

list-class​

cd-orgpractitioner​

create​

delete​

get​

list​

update​

cd-todo​

list-tag​

get-tag​

create-tag​

delete-tag​

ck-dbd-loader​

list​

ck-dbm-database​

list​

ck-dbm-rollup​

list​

ck-dbt-project​

Global Options

Commands

api

delete

get

patch

post

cd-appointment

create-status

create-type

list-status

list-type

update-status

cd-article

add-content-file

add-content-url

bulk-create

create

delete

delete-content

get

list

update

cd-calendly

list-account

list-user

get-user

cd-challenge

create

delete

get

list

cd-cobject

add-column

alter-column

alter-table

create-table

drop-table

describe

drop-column

select

show-tables

cd-encounter

create-type

delete-type

get

list

list-type

create

delete

cd-orgcare

create

delete

get

list

update

cd-orgdoc

create

delete

download

list

list-class

cd-orgpractitioner

create

delete

get

list

update

cd-todo

list-tag

get-tag

create-tag

delete-tag

ck-dbd-loader

list

ck-dbm-database

list

ck-dbm-rollup

list

ck-dbt-project