CLI Reference
Global Options
--format
: Change the output format to one ofcsv
,json
, ortext
. Defaults totext
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
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
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