Create Recipient List

SparkPost is an online email delivery service provider for developers and businesses. This activity lets you create a new recipient list in your SparkPost account. To do this, add this activity to the canvas and configure it. Select the appropriate connection for SparkPost from the drop-down list. If you haven’t created a connection yet, select ‘Add New’ to create one. 

Field data

List ID (Mandatory): Provide a suitable ID for the recipient list to be created. This ID should be unique, and can contain lowercase letters, numbers, hyphens and underscores only. 

List Name (Optional): Provide a suitable name for the recipient list to be created. 

Description (Optional): Enter the description for the recipient list to be created.

Internal ID (Optional): Enter the internal ID for the recipient list to be created. 

List Group ID (Optional): Enter the group ID that you wish to assign to the recipient list.

Recipients (Mandatory): Enter the details for each recipient in this block.

   - Return Path (Optional): Enter the email ID that you wish to use as a return path.

   - Email (Mandatory): Enter the email ID of the recipient.

   - Name (Optional): Enter a suitable name for the recipient email ID.

   - Header To (Optional): Email address to display in the “To” header instead of address.email (for  CC and BCC)

   - Metadata_Key (Optional): Enter the key for metadata.

   - Metadata_Value (Optional): Enter the value for the specified key.

    You can add metadata values for multiple keys by clicking on the '+ADD' link.

   - Substitution Data_Key (Optional): Enter the key for substitution engine.

   - Substitution Data_Value (Optional): Enter the value for the specified key.

     You can add substitution values for multiple keys by clicking on the '+ADD' link.

    - Tags (Optional): Enter a comma separated list of tags.

You can enter the details for multiple recipients by clicking on the '+ADD' link.

create-recipient-list

Once you have entered all the details, click on 'Done' and 'Run' the flow. This will create a new recipient list in your SparkPost account. 

Refer to SparkPost API documentation for more information: https://developers.sparkpost.com/api/recipient-lists#recipient-lists-create-post

Output:
  • output-arrow sparkpost Create Recipient List
    • left-triangle results object