The Omnilert Subscriber Import utility is used to import subscriber data via CSV upload files.
The command-driven upload option allows complete control over subscriber data via simple commands. This provides an API without a need for any special programming.
Commands will consist of a command followed by one key item, typically the subscriber's "username", and then any additional parameters. In the list below, optional parameters are listed in brackets.
A command-driven file might resemble the example shown below:
Omnilert CSV Upload Commands
The following commands are supported:
add_admin
Format:
add_admin,admin_username,[fname,lname,password,email_address,active,role]
Notes:
- Adds a new Admin account in Omnilert
- All uploaded admins are assigned the Content Admin role. (You can adjust this after importing on the
Admins page.) - fname = first name of the subscriber.
- lname = last name of the subscriber
- password = password for the subscriber – if blank defaults to ‘password’
- email_address = Admins email address to be added.
- active = the active/inactive status for the admin's account. Set to "1" for active. Set to "0" to set the admin as inactive
- role = Set the admin role for this admin. (See "Admin Roles") The role's name must match the roles listed in Omnilert. If omitted or the role is not found, the admin will be added as a "Content Admin" default role.
Examples:
add_admin,jdoe,John,Doe,password123,jdoe@myschool.edu,1,"Content Admin"
- adds "jdoe" as an active admin with the role of Content Admin
add_user
Format:
add_user,username,[fname,lname,"password",validated,active,expiration_date,languages,tags]
Notes:
- Adds a new subscriber account in Omnilert
- fname = first name of the subscriber.
- lname = last name of the subscriber
- password = password for the subscriber. (If no password is specified, the password will be "password")
- validated = numeric validation status. (1 = validated, 0 = unvalidated)
- active = numeric account activation status. (1 = active, 0 = inactive)
- expiration_date = date on which the account expires. Must be formatted mm/dd/yyyy
- languages = Add any languages from the listed language abbreviations. If adding more than one language filter to a subscriber, use a comma-delimited list encapsulated in quotes. (Example: "en,sp,sw") See Languages for a full list of two-letter abbreviations.
- tags = Assign this subscriber to any pre-defined Tags in the system. If adding more than one tag filter to a subscriber, use a comma-delimited list encapsulated in quotes.
Examples:
add_user,jdoe,John,Doe,password123,1,1,01/30/2028
- adds "jdoe" as an active, validated account with an expiration on Jan 30, 2028.
add_user,jsmtih
- Adds "jsmith" with no firstname, lastname, password, activation status or expiration date.
Note: Upload files are processed sequentially from top to bottom. If you're adding a new subscriber and wish to
add devices to their new account, the "add_user" command must appear before any other "add"
commands, such as "add_groupuser" or "add_mobile". (Otherwise the new subscriber won't exist yet!)
add_group
Format:
add_group,admin_username,group_name,[group_description,group_type,suggested]
Notes:
- Adds a new Group into the account in Omnilert
- admin_username = username of the admin for this group, non-admins cannot add/update or delete groups.
- group_name = name of the group
- group_description = description of the group
- group_type = numeric group type designation. (1 = private, 0 = public).
- suggested = numeric status if group is offered by default to subscribers. (1 = suggested, 0 = not suggested)
Example:
add_group,jdoe,Bad Weather,Group for bad weather announcements, 0,1
- adds a public group called "Bad Weather " with the admin "jdoe" and makes this group a suggested public group.
add_groupuser
Format:
add_groupuser,username,group_name
Notes:
- Adds an existing subscriber (username) to an existing group (group_name) in Omnilert
- username = username of an existing subscriber in this account.
- group_name = name of the existing group to add the subscriber to.
Example:
add_groupuser,jdoe,Bad Weather
- adds subscriber "jdoe" to the group Bad Weather.
add_groupadmin
Format:
add_groupadmin,username,group_name
Notes:
- Adds an existing admin to a group
- The admin account must exist in Omnilert before issuing the add_groupadmin command.
- group_name = name of the group
Example:
add_groupadmin,jdoe,Bad Weather
- Adds a the admin "jdoe" to the group called Bad Weather
add_mobile
Format:
add_mobile,username,cell_number,carrier,validated,active
Notes:
- Adds a new mobile phone to the subscriber's account.
- The subscriber account must exist in Omnilert before issuing the add_mobile command. (Use the "add_user" command BEFORE this or any other "add" command for a subscriber.)
- Can be used to insert "unvalidated" phones by setting the validation status flag to "0". Unvalidated subscribers must log in and validate to activate their phone for SMS service.
- cell_number = Phone number. Note: The leading plus & country code (+1 ) is optional for US numbers but required for phones outside the United States. So, for example, (212) 555-1234 can be sent as either "+12125551234" or "2125551234".
- carrier = The subscriber's mobile carrier.
- If the carrier is unknown, use "Default" for US mobile numbers.
- Use "Other" for international numbers. International numbers require the leading + & country code along with the number.
- validated = numeric validation status. (1 = validated, 0 = unvalidated), defaults to 0 if omitted.
- active = numeric "Active" device status. (1 = active, 0 = inactive) defaults to 0 if omitted.
Examples:
add_mobile,jdoe,2125551234,Default,1,1
- Adds a validated mobile phone (212) 555-1234 for subscriber with username "jdoe"
add_mobile,jsmith,+17185551235,Verizon Wireless,0,0
- Adds mobile phone for "jsmith" as an unvalidated phone. (The subscriber must validate it to begin service.)
add_email
Format:
add_email,username,email_address,validated
Notes:
- Adds a new e-mail address to the subscriber's account.
- The subscriber account must exist in Omnilert before issuing the add_email command.
- email_address = email address to be added.
- validated = numeric validation status. (1 = validated, 0 = unvalidated)
Examples:
add_email,jdoe,jdoe@sample.edu,1
- Adds a validated e-mail address for jdoe
add_email,jsmith,jsmith@sample.com,0
- Adds an unvalidated e-mail address for "jsmith"
add_voice
Format:
add_voice,username,voice_number
Notes:
- Adds a new voice phone to the subscriber account.
- The subscriber account must exist in Omnilert before issuing the add_voice command.
- voice_number = 10-digit US phone number. Just digits, No punctuation.
Example:
add_voice,jdoe,2125551234
- Adds a voice number to "jdoe" account.
add_tag
Format:
add_tag,tag_name
Notes:
- Adds a new Tag (see Tags) to the system. If the tags include spaces or commas, enclose the value in quotes (e.g. "My New Tag")
- Tag names may include numbers, letters (A-Z a-z), dashes, hyphens, or commas (requires a quoted value for tag names with non-alphanumeric characters).
Example:
add_tag,"Anytown, NY"
- Adds a new tag to the system called "Anytown, NY".
update_admin
Format:
update_admin,admin_username,fname,lname,password,email_address,active,admin_role,access_views
Notes:
- Updates an existing administrator login account for Omnilert. (Admin must already exist.)
- All columns must be present. Only the username is required. Leave columns blank if you wish to not change the current value for that admin.
- fname = admin's first name
- lname = admin's last name
- password = the password the admin will use to log into Omnilert as an admin.
- email_address = the admin's email address. (Used for password reset requests.)
- active = determines if the admin account is "active" (and can log in.) 1 = YES, 0 = NO
- admin_role = The assigned admin role for this administrator account. (See Admin Roles)
- access_views = One or more Access Views assigned to this admin. If multiple, insert as a quote encapsulated string. (e.g. "View 1, View 2")
Examples:
update_admin,jdoe,,,,,,Content Admin,
- Updates the admin "jdoe" to set their admin role to that of a "Content Admin" role.
update_admin,jdoe,James,Doe,,,0,,"North Campus, South Campus"
- Updates the admin "jdoe" to set their first name to "James" and their last name to "Doe"
- Sets the admin "jdoe" as "inactive". (Inactive admins can't log into Omnilert.)
- Assigns the admin "jdoe" to two access views ("North Campus" and "South Campus")
update_user
Format:
update_user,username,[fname,lname,password,validated,active,expiration_date,languages,tags]
Notes:
- Updates a uses account in Omnilert
- The subscriber account must exist in Omnilert before issuing the update_user command.
- Unlike "add_user", all fields must be present, even if left blank with empty quotes.
- fname = first name of the subscriber.
- lname = last name of the subscriber
- password = password for the subscriber
- validated = numeric validation status. (1 = validated, 0 = unvalidated)
- active = numeric account activation status. (1 = active, 0 = inactive)
- expiration_date = a new subscriber account expiration date for this username. (Set to "0" to have the subscriber "Never expire".)
- languages = Add any languages from the listed language abbreviations. If adding more than one language filter to a subscriber, use a comma-delimited list encapsulated in quotes. (Example: "en,sp,sw") See Languages for a full list of two-letter abbreviations.
- tags = Assign this subscriber to any pre-defined Tags in the system. If adding more than one tag filter to a subscriber, use a comma-delimited list encapsulated in quotes.
Examples:
update_user,jdoe,,,,0,0,
- changes subscriber jdoe's account to inactive and unvalidated.
update_user,jsmtih,Jim,,pasword23sd12@3,,,01/01/2025
- updates jsmith's first name to "Jim"
- changes jsmith's password to "pasword23sd12@3"
- changes jsmith's expiration date to Jan 1st 2025.
Note: This command cannot be used to change a subscriber's username. The username is used as a unique
key and cannot be changed via upload. If you must change a username via upload, we recommend
DELETING the subscriber and then uploading a new record with a new username.
update_mobile
Format:
update_mobile,username,cell_number,carrier,validated
Notes:
- Updates subscriber's mobile phone in the subscriber account.
- The subscriber account must exist in Omnilert before issuing the update_mobile command.
- Can be used to change carrier.
- Can be used to change validation status.
- Can not be used to change a phone number. (To change the SMS number, please delete the old number and then add a new number.)
- cell_number = 10-digit US phone number without any punctuation. This is used to identify the phone.
- carrier = The subscriber's mobile carrier. If unknown, use "Default".
- validated = numeric validation status. (1 = validated, 0 = unvalidated)
Examples:
update_mobile,jdoe,2125551234,AT&T,1
- Adds the validated status to mobile phone for "jdoe" and changes the carrier to "AT&T"
update_mobile,jsmith,7185551235,,0
- Sets the unvalidated mobile phone for "jsmith" without changing the carrier
update_email
Format:
update_email,username,email_address,validated
Notes:
- Can only change the validation status for an e-mail address. (To change the e-mail address, please delete the old address and then add a new address.)
- The subscriber account must exist in Omnilert before issuing the update_email command.
- email_address = email address to be changed.
- validated = numeric validation status. (1 = validated, 0 = unvalidated)
Examples:
update_email,jdoe,jdoe@sample.edu,1
- changes email address for jdoe to validated
update_email,jsmith,jsmith@sample.com,0
- changes e-mail address for "jsmith" to unvalidated
update_tag
Format:
add_tag,new_tag_name|old_tag_name
Notes:
- Change the name of a Tag (see Tags)
- Replaces "old_tag_name" with "new_tag_name"
- Use a pipe character ("|") to separate the "new tag" and the "old tag".
- If the tag being renamed has a comma in it, enclose the whole section in quotes.
- Renaming a tag will preserve the membership of that tag.
Example:
update_tag,"Newtown, NY|Anytown, NY"
- Rename the tag named "Anytown, NY" as "Newtown, NY"
delete_admin
Format:
delete_admin,admin_username
Notes:
- Deletes an existing Admin account in Omnilert.
- Takes no optional information.
- Deletion is permanent.
- Admin must exist in the Omnilert database to be deleted.
Example:
delete_admin,jdoe
- Admin account "jdoe" is deleted.
delete_user
Format:
delete_user,username
Notes:
- Deletes a subscriber account in Omnilert
- Takes no optional information.
- Deletion is permanent.
- Subscribers must exist in the Omnilert database to be deleted.
Examples:
delete_user,jdoe
- Account "jdoe" is deleted.
delete_group
Format:
delete_group,admin_username,group_name
Notes:
- Deletes an existing group for this account in Omnilert.
- Takes no optional information.
- Deletion is permanent.
- Does not delete the subscriber accounts associated with the group.
- Group must exist in Omnilert database to be deleted.
- Group deletion also deletes all user_group relationship for this group.(Does not delete the user accounts.)
- Group deletion also deletes all admin_group relationship for this group. (Does not delete the admin
accounts)
Example:
delete_group,jdoe,Bad Weather
- deletes group "Bad Weather" and all subscriber and admin ("jdoe") associations with the group.
delete_groupuser
Format:
delete_groupuser,username,group_name
Notes:
- Removes an existing subscriber (username) from an existing group (group_name) in Omnilert
- username = username of an existing subscriber in this account.
- group_name = name of the existing group to remove the user from.
- Does not delete the subscriber's Omnilert account
Example:
delete_groupuser,jdoe,Bad Weather
- removes subscriber "jdoe" from the group Bad Weather.
delete_groupadmin
Format:
delete_groupadmin,admin_username,group_name
Notes:
- Removes an existing admin from an existing group (group_name) in Omnilert
- admin_username = username of an existing admin assigned to the group.
- group_name = name of the existing group to remove the admin from. The admin will no longer be able to send alerts to that group.
- Does not delete the admin's Omnilert account.
Example:
delete_groupadmin,jdoe,Bad Weather
- removes admin "jdoe" from access to the group Bad Weather.
delete_mobile
Format:
delete_mobile,username,cell_number
Notes:
- Updates email address in the subscriber's account.
- The subscriber account must exist in Omnilert before issuing the delete_mobile command.
- Deletion is permanent
- cell_number = email address to be added.
Example:
delete_mobile,jdoe,2125551234
- Removes matching cell phone for "jdoe"
delete_email
Format:
delete_email,username,email_address
Notes:
- Updates e-mail address in the subscriber account.
- The subscriber account must exist in Omnilert before issuing the delete_email command.
- Deletion is permanent
- email_address = email address to be added.
Examples:
delete_email,jdoe,jdoe@sample.edu
- Removes matching e-mail address for "jdoe"
delete_voice
Format:
delete_voice,username,voice_number
Notes:
- Removes a matching voice number from subscriber account
- The subscriber account must exist in Omnilert before issuing the update_voice command.
- voice_number = 10-digit US phone number. Just digits, No punctuation.
Example:
delete_voice,jdoe,2125551234
- Removes voice calling number from "jdoe" account.
delete_tag
Format:
delete_tag,tag_name
Notes:
- deletes the tag with "tag_name"
- A tag must exist to be deleted
- Will remove that tag from any/all subscribers that have that tag.
- Best to encapsulate the tag name in quotes if the name includes spaces, commas, or any other non-alphanumeric characters.
Example:
delete_tag,"Anytown, NY"
- Tag named "Anytown, NY" is removed.
Access Views Upload Commands
The following commands are only used in combination with the special Access Views permissions system.
ADD_AVADMIN
Format:
add_avadmin,admin_username,access_view_name
Notes:
- Adds an existing admin to an access view.
- If the access view does not exist, it will be created.
Example:
add_avadmin,jimadmin,"Main Site"
- Adds the admin "jimadmin" to the Access View titled "Main Site"
ADD_AVUSER
Format:
add_avuser,username,access_view_name
Notes:
- Adds an existing subscriber record to an access view.
- If the access view does not exist, it will be created.
Example:
add_avuser,jdoe,"Main Site"
- Adds the subscriber "jdoe" to the Access View titled "Main Site"
ADD_AVGROUP
Format:
add_avgroup,group_name,access_view_name
Notes:
- Adds an existing GROUP record to an access view.
- If the access view does not exist, it will be created.
Example:
add_avgroup,"Students","Main Site"
- Adds the subscriber "Students" to the Access View titled "Main Site"
UPDATE_AVADMIN
Format:
update_avadmin,admin_username,access_view_name
Notes:
- Sets an existing admin record to the selected access view.
- The UPDATE action is destructive as an update for any of these will delete all existing views for this admin/user/group and replace it with the one access view passed in.
Example:
update_avadmin,jsmith,"Main Site"
- Updates the admin "jsmith" to set their Access View to "Main Site"
UPDATE_AVUSER
Format:
update_avuser,username,access_view_name
Notes:
- Sets an existing subscriber record to the selected access view.
- The UPDATE action is destructive as an update for any of these will delete all existing views for this admin/user/group and replace it with the one access view passed in.
Example:
update_avuser,jsmith,"Main Site"
- Updates the subscriber "jdoe" to set their Access View to "Main Site"
UPDATE_AVGROUP
Format:
update_avgroup,group_name,access_view_name
Notes:
- Sets an existing GROUP record to the selected access view.
- The UPDATE action is destructive as an update for any of these will delete all existing views for this admin/user/group and replace it with the one access view passed in.
Example:
update_avgroup,"Faculty","Main Site"
- Updates the group called "Faculty" to set its Access View to "Main Site"
DELETE_AVADMIN
Format:
delete_avadmin,admin_username,access_view_name
Notes:
- Removes admin record from the selected access view.
- Use this to selectively remove the view from that record.
Example:
delete_avadmin,jsmith,"Main Site"
- Remove the admin "jsmith" from the Access View named "Main Site"
DELETE_AVUSER
Format:
delete_avuser,username,access_view_name
Notes:
- Removes subscriber record from the selected access view.
- Use this to selectively remove the view from that subscriber's record.
Example:
delete_avuser,jdoe,"Main Site"
- Remove the subscriber "jdoe" from the Access View named "Main Site"
DELETE_AVGROUP
Format:
delete_avgroup,group_name,access_view_name
Notes:
- Removes a GROUP from the selected access view.
- Use this to selectively remove the view from that GROUP's record.
Example:
delete_avgroup,"Campus Visitors","Main Site"
- Remove the group named "Campus Visitors" from the Access View named "Main Site"
Notes / Tips
- We strongly recommend using UTF-8 character encoding. Other spreadsheet formats such as .xlsx may work OK, but we recommend using CSV files with quote-encapsulated text fields to avoid import issues.
- If unsure, it's recommended to encapsulate individual text fields in quotes, but not the entire line. (If the whole line is in quotes, the server sees it as a single field of data.) For example, if there is a comma in the name of your group, place that group's name in quotes. (e.g. "Washington, DC")
- If you are uploading mobile numbers, be sure they are legally obtained and you have permission to send them text messages.
- If the carrier name for a US mobile number is unknown, use the word "Default" to send without carrier information. This will function for all major US carriers that support shortcode SMS. Otherwise, you can use "Other" as the mobile carrier for non-standard cell carriers.
- Groups must be created before subscribers can be added to them.
- Tags must be created before subscribers can have tags added to them.
- Languages filters must be selected and enabled via the Languages settings before assigning them to subscribers.
Comments
0 comments
Please sign in to leave a comment.