Target Users
The Target Users are those who receive e-mails that will be sent through the platform. This document explains how to add target users to the platform so that it can send training, phishing, campaigns, and other emails to them.

Managing Target Users

You can manage all target users from the Company > Target Users menu. You may create, remove, modify, and add target users to a group on this page.

Methods for Adding Target Users

Adding Target Users via XLS(x) or CSV Files

You can easily add target users to the system by importing a list on an Excel file. To use this option, enter the Company > Target Users menu, click the "New" button, and click the "Import from a file" option.
To view a sample sheet, please click "DOWNLOAD EXAMPLE SHEET" on the target users page.
Fill in the required fields in the excel file as in the sample list to have it ready. Then click Upload File, choose the file on your system and click NEXT. Map Fields tab will require you to match the titles to the fields on the platform. When you complete matching the fields, click NEXT. Then either pick the users you wish to add and click IMPORT SELECTED, or click IMPORT ALL to add all the users.
First Name, Last Name and Email fields are required, and the other fields are optional.

Adding Target Users via API

Using the platform's APIs, target users may be effortlessly migrated. The API endpoints that are required are detailed below.
You need to create Rest API keys on the platform from here in order to use this API import option.
Use your own domain if you are using an on-premise version. e.g. https://api.PLATFORM_DOMAIN/docs/index.html

Instructions for adding target users using an API

POST ​/api​/target-users
  • Go to the Swagger link.
  • Click the Authorize button on the top right side of the page.
  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.
  • Make sure that the api1 option is checked (✓) on the Scopes section.
  • Then use this endpoint to add a new target user to the platform.
The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Searching for a user using API

POST ​/api​/target-users​/search
  • Go to the Swagger link.
  • Click the Authorize button on the top right side of the page.
  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.
  • Make sure that the api1 option is checked (✓) on the Scopes section.
  • Then use this endpoint to search for a target user on the platform.
The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Editing Target Users using API

PUT ​/api​/target-users​/{resourceId}
  • Go to the Swagger link.
  • Click the Authorize button on the top right side of the page.
  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.
  • Make sure that the api1 option is checked (✓) on the Scopes section.
  • Then use this endpoint to edit a target user on the platform.
The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Deleting Target Users using API

DELETE ​/api​/target-users​/{resourceId}
  • Go to the Swagger link.
  • Click the Authorize button on the top right side of the page.
  • Complete the authorization step with the Client ID and Client Secret key that you created on the platform.
  • Make sure that the api1 option is checked (✓) on the Scopes section.
  • Then use this endpoint to delete a target user on the platform.
The most up-to-date format of the body content that you need to use for requesting an API is available on the Swagger interface.

Adding Target Users Manually

​​From the left menu, select Company > Target Users. Then, click New and click "Add users manually" on the new page. Fill out the required boxes in the "Add New User" window to add a new target user to the system.
Field
Description
First name
Specify the first name information of the target user.
Last name
Specify the last name information of the target user.
Email
Specify the email information of the target user.
Department
Specify the department information of the target user.
Proritiy
Specify the priority information of the target user. If the priority is high, the user will get the email first.

Adding Target Users to Groups

You may create new groups by clicking the New button on the Company > Target Users > Group menu.
To add target users to a group, clickicon under the Action column and click Add users to the group. Select the users you want to add to a group and click “Add Selected Users” to complete the process.

Deleting Target Users

To delete target users on the platform, go to the Company > Target Users > People menu and select the user(s) that you want to remove. Clickicon under the Action column and click “Delete” to complete the process.

Deleting Groups

To delete target user groups on the platform, go to the Company > Target Users > Group menu and select the group(s) that you want to remove. Clickicon under the Action column and click “Delete” to complete the process.
Deleting a target user group will not delete the users defined in the group. It will only delete the group.

FAQ

Q: Is it possible to add a target user with any domain name?

A: You can only add e-mail addresses with authorized domains. Contact your Account Manager or Support Team if you wish to add users with a different domain address.

Q: Would the remaining license count increase when a target user is deleted?

A: No, when a target user is added, your remaining license is reduced appropriately, but your license is not increased when the target user is deleted.
Last modified 8mo ago
Copy link
On this page
Managing Target Users
Methods for Adding Target Users
Adding Target Users via XLS(x) or CSV Files
Adding Target Users via API
Adding Target Users Manually
Adding Target Users to Groups
Deleting Target Users
Deleting Groups
FAQ
Q: Is it possible to add a target user with any domain name?
Q: Would the remaining license count increase when a target user is deleted?