Postman setup and usage

• Postman installation
• Updating user attributes
• Pre-setup instructions
• Update a single user
• Update batch users
• Testing custom transactional API
• Pre-setup instructions
• Sending a custom transactional email to a single user
• Sending a custom transactional email to multiple users

Postman installation

1. Download Postman.
2. Open Postman and Click Import > Import From Link.
3. Paste link: “https://www.getpostman.com/collections/1feed899613c723e9b68“
4. Click Import.
   
   
   
   

Updating user attributes

Important: Before making any requests be sure to update your API KEY in the headers section. Additional documentation on the User Patch API can be found here.

Pre-setup instructions

1. Go to the "ReSci API" collection.
2. Click on the request you want to make.
3. Click on the Headers column and add in your API Key.
4. Click Cmd + s to save the configuration.
   
   
   
   

Update a single user

1. Go to ReSci API > User Patch Request > Params Column.
2. Add in a "Key" (user attribute name).
3. Add in a "Value" (user attribute value).
4. If you need to update multiple key / values make sure you add them into the parameters.

• Example:
  • Key: email
  • Value: test@retentionscience.com

5. Click Send.

Update batch users

1. Save .CSV file with user attributes. ** Must have an email column**
   Note: Make sure the users included in the API call already exist in the database. If users are included in the API call do not already exist in Cortex they will be sent the welcome flow.
2. Go to ReSci API > User Batch Request > Body Column.
3. If making an update to a custom user attribute update the resci object variables with the names of the custom user attribute.
   
   
   
   
4. If making an update to a standard user attribute add in a key to the JSON object
   
   
   
   
   
5. Click Cmd + s to save. 
   
   
   
   
6. Click on Runner.
7. Select "ReSci API" collection.
8. Uncheck all except "User Batch Request."
9. Click on Select File > Upload CSV file.
10. Click "Run ReSci API."
    
    
    
    

Testing custom transactional API

Important: Before making any requests be sure to update your API KEY in the headers section. Additional documentation on the Send Custom Transactional Email API can be found here.

Pre-setup instructions

1. Go to the "ReSci API" collection.
2. Click on the request you want to make.
3. Click on the Headers Column and add in your API key.
4. Click Cmd + s to save. 

Sending a custom transactional email to a single user

1. Go to ReSci API > Custom Transactional Post Request > Body Column.
2. Update the values for: 

• template_id
• email
• merge_fields

3. Click Send.
   
   
   
   

Sending a custom transactional email to multiple users

1. Before doing anything in Postman, create a .csv file containing the list of users who should receive the transactional email, as well as any of the attributes that will be dynamically populated into the transactional email body.
   Note: The columns of the .csv file must include email, as well as any of the other attributes that will be used in the email. In the example file below, the user attributes sent in the email will be order_number and processing_window. 
   
   
   
   
2. Within Postman, go to ReSci API > Custom Transactional Post Request > Body Column.
3. Update the values for: 

• template_id

4. Rather than hardcoding the value for the email and merge field attributes, insert them as dynamic attributes, as seen in the image below. In this example, the API call will contain information on users' email, order_number, and processing_window values. Please be sure that the values of these attributes matches the column headers of the .csv file.
   
   
   
   
5. Click Cmd + s to save.
6. Click on Runner at the top left of the page.
   
   
   
   
7. Select the collection ReSci API and make sure that the "Custom Transactional Request" is checked.  
   
   
   
   
8. Click Select File and choose the .csv file.
   
   
   
   
9. Once the file is selected, the iterations value should be updated. Confirm that this matches the number of rows in the .csv file:
   
   
   
   
10. Clicking Preview shows the attributes for each iteration. When clicking Preview you will see this the following view. Verify that this matches the .csv file:
    
    
    
    
11. Click the Run ReSci API button.