CSV Syntax Guide for Channel Imports

Overview

This topic explains how to use the correct syntax for CSV file imports, new channels, or updating existing channel membership and settings. The table below outlines each CSV field and its expected format.

CSV Syntax Guidelines

Include values for all mandatory fields.
Use semicolons (;) to separate multiple values within a single header.
Use pipes (|) to separate subcategories within headers.

CSV Field Header	Format	Description	Sample Syntax
name	String	Specifies the unique name of the channel to be created. This is a required field.	Channel One
description	String	Specifies the description of the channel.	Channel used for security notifications and alerts.
admin privacy	String	Specifies the access level for the channel and determines which administrators can view and interact with it. The following values are supported: Public: Allows all administrators to view and send messages to the channel. Restricted: Allows all administrators to view the channel and request access to it. Hidden: Allows only administrators with channel access to view and send messages to the channel. Other administrators cannot see the channel.	Public Restricted Hidden
permissions	String	Specifies whether the system can receive replies from the channel’s recipients. The following values are supported: Announcement: The system does not receive replies from this channel’s recipients using Email, SMS, or Mobile apps, and admins cannot view or manage them. Open_discussion: The system receives replies from the channel’s recipients. Administrators can view and manage these replies.The default value is “open_discussion”	Announcement open_discussion
Keyword	String	Keyword is used to be able to subscribe to the channel	Channel_one_keyword
alert_moderation	String	Specifies whether messages sent to the channel require approval from a channel administrator before they are delivered to channel recipients.The following values are supported: Yes No The default value is “No”.	Yes No
notify_admins	String	Specifies whether channel administrators receive an email notification when a message is sent to a channel they administer.The following values are supported: Yes No The default value is “No”	Yes No
emergency	String	Specifies whether the channel is designated for sending urgent messages.The following values are supported: Yes No The default value is “No”	Yes No
groupid	String	Specifies the ID of the group whose members you want to add as recipients to the channel. To add multiple groups, separate each group ID with a semicolon (`;`).	123 123;124
groupname	String	Specifies the name of the group whose members you want to add as recipients to the channel. To add multiple groups, separate each group ID with a semicolon (`;`).	group1 group1;group2
recipient_emails	String	Specifies the email addresses of the recipients to add to the channel. To add multiple recipients, separate each email address with a semicolon (`;`).	email1@example.com email2@example.com
recipient_user_names	String	Specifies the user names of the recipients to add to the channel. To add multiple recipients, separate each user name with a semicolon (`;`).	username1 username1;username2
recipient_database_ids	String	Specifies the database IDs used to identify recipients to add to the channel. To specify multiple database IDs, separate each ID with a semicolon (`;`).	db_id1;db_id2 db_id1
admins	String	Specifies the email addresses of the admins to add to the channel. To add multiple admins, separate each email address with a semicolon (`;`).	admin1@example.com admin2@example.com
post_methods	String	Specifies the message delivery methods available for the channel. Multiple delivery methods are separated by a semicolon (`;`). For delivery methods that require an email type or phone type, specify the method and type separated by a pipe (`\|`). Multiple phone types are separated by a semicolon (`;`). Accepted Message Methods: email sms call regroupmobile facebook twitter rss alertus cap paging_system microsoft_teams Accepted Email Types: primary secondary both Accepted Phone Types: work home cell other	sms\|work:home;email\|primary;call;regroupmobile;rss;cap;twitter;fb;paging_system
sender_profile_id	String	The id of the sender profile to be used while sending the message to the channel.	123
Subscribers	String	Specifies the email addresses of the subscribers to add to the channel. To add multiple subscribers, separate each email address with a semicolon (`;`).	email1@example.com;email2@example.com
noaa_enable	String	Specifies whether NOAA alerts are enabled for the channel.The supported values are: Yes No	Yes• No
noa_type	String	Specifies a NOAA alert type for the channel.The supported values are:• country_based• location_based• live_location_based• recipient_address_based• country_and_location_based	• country_based• location_based• live_location_based• recipient_address_based• country_and_location_based
noaa_counties	String	Specifies the countries for which NOAA alerts are generated. To add multiple counties, separate each county entry with a semicolon (`;`). Each county must be specified in the format `CountyName, State`.	US, California
noaa_location	String	Specifies a geographic location for which NOAA alerts are generated. The location must include the street address, city, state, and country, with each value separated by a pipe (`\|`).	123 Main Street\|White Plains\|New York\|USA
noaa_alert_events	String	Specifies the NOAA alert event configuration for the channel, including the alert event type, delivery methods, quiet hours, quiet days, and time zone. The values must be provided in the following format:`NOAAAlertEvent\|NOAAPostMethods\|QuietHours\|QuietDays\|TimeZone`	Flood Warning\|email:sms\|10:00-20:00\|0:1:2:3\|CST
noaa_sender_profile	String	The id of the sender profile to be used while sending the NOAA alerts to the channel.	123
email_in_access	String	Specifies who can send messages to the channel’s contacts using the channel’s email address.The following values are supported: Restricted: Only channel admins can send messages using the channel’s email address. unrestricted: Any channel contact or channel admin can send messages using the channel’s email address. noaccess: No one can send messages using the channel’s email address.	• restricted
email_in_post_types	String	Specifies how the message will be delivered when triggered through Email In and SMS In. When email is post type : second attribute email type is acceptable values : primary, secondary, both. i.e email\|primary or email\|secondary or email\|both When sms is post type : second attribute is phone types. the acceptable values : work, home, cell, other. i.e sms\|work:cell etc.Third attribute is true or false. When rss is post type : second attribute is rss duration type and acceptable values : always or until. i.e : rss\|always when rss duration type is until then we required to add third attribute that is hours and minutes. i.e : rss\|until\|1-20	email\|both;sms\|work:home:cell:other\|true;tts;alert_manager;rss\|always email\|both;tts\|work:home:cell:other;alert_manager;rss\|until\|1-25
email_in_sender_profile_id	String	The id of the sender profile to be used while sending the Email In messages.	123
requires_subscription_approval	String	Specifies whether subscription requests to the channel require approval before users can become channel subscribers.The following values are supported: Yes No	Yes• No
processing_style	String	Use this tag to define the processing style for importing channel subscribers.Accepted Values:• Add Only: The system adds new subscribers. Existing subscribers are not removed, even if they are not present in the imported file.• add only \| static: Channel subscribers have no impact other than adding new information.• add and remove: The system adds new subscribers and removes existing subscribers who are not present in the imported file for the channel.Default Value: Add onlyIf any value other than the supported values is provided, the system uses the default value, issues a warning, and performs a soft fail.	• add_only\|static• add_only• add_remove
sync_subscribers_to_groups	String	Use this tag to automatically add channel subscribers as contacts to one or more groups.	groupname1;groupname2;groupname3
Action	String	This is a required field:The accepted values are:• Add: Adds new channels and adds/updates any new information to the existing channels.• Delete: Deletes any existing channels	• Add• Delete