Skip to main content
Simplekpi logo
  • Category: analytics
  • Auth: BASIC
  • Composio-managed OAuth available? N/A
  • Tools: 51
  • Triggers: 0
  • Slug: SIMPLEKPI
  • Version: 20261101_00

Tools

Slug: SIMPLEKPI_ADD_USER_GROUP_ITEMTool to assign a group item to a user in SimpleKPI. Use when you need to add a group item to a specific user’s profile.

Input Parameters

integer
required
The group item identifier to assign to the user.
integer
required
The identifier of the user to assign the group item to.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_ADD_USER_KPITool to assign a KPI to a user in SimpleKPI. Use when you need to link a KPI to a specific user with optional custom target and display order.

Input Parameters

integer
required
KPI ID to assign to the user
integer
required
User ID to assign the KPI to
integer
required
Display order of the KPI on the KPI Entry screen for this user
number
User-specific target value for this KPI (optional). Overrides the default KPI target for this user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_CATEGORY_KPITool to create a new KPI within a category in SimpleKPI. Use when you need to add a new performance indicator to track metrics like sales, revenue, or customer satisfaction.

Input Parameters

string
required
Name of the KPI (maximum 100 characters)
integer
required
The ID of the icon to use for this KPI
integer
required
The ID of the unit of measurement for this KPI
boolean
required
Whether the KPI is active and visible
integer
required
Display order position for this KPI within the category
integer
required
The ID of the category where the KPI will be created
string
required
Frequency ID as a single uppercase letter: D (daily), W (weekly), M (monthly), Q (quarterly), Y (yearly)
string ("U" | "D" | "N")
required
Indicates whether higher (U) or lower (D) values are better, or if direction doesn’t matter (N)
string ("AVG" | "SUM")
required
Function to use when aggregating KPI values: AVG (average) or SUM (sum)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_GROUPTool to create a new group in SimpleKPI. Use when you need to organize KPIs or users into logical groups for better organization and reporting.

Input Parameters

string
required
Group name. Must not exceed 50 characters.
integer
required
Display order for the group. Lower values appear first in lists.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_GROUP_ITEMTool to create a new item within a group in SimpleKPI. Use when you need to add a new item to an existing group for organizing KPIs or data.

Input Parameters

string
required
The name of the group item (maximum 100 characters)
integer
required
The ID of the group to create the item in
integer
required
The display order of the item within the group

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_KPITool to create a new KPI with specified configuration. Use when you need to add a new Key Performance Indicator to track metrics.

Input Parameters

string
required
Name of the KPI.
integer
required
Icon ID for the KPI display.
integer
required
Unit ID that defines the measurement unit for this KPI.
boolean
required
Active status indicating whether the KPI is currently active.
integer
required
Display order for sorting KPIs in the interface.
integer
required
KPI Category ID. Use GET /api/kpicategories to fetch available categories.
string
required
Frequency ID that determines data entry frequency (e.g., ‘M’ for monthly, ‘W’ for weekly, ‘D’ for daily).
string ("U" | "D" | "N")
required
Direction indicator: ‘U’ (up is good), ‘D’ (down is good), or ‘N’ (neutral).
string ("AVG" | "SUM")
required
Calculation method for aggregating KPI values: ‘AVG’ (average) or ‘SUM’ (sum).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_KPI_CATEGORYTool to create a new KPI category in SimpleKPI. Use when you need to organize KPIs into logical groups or categories.

Input Parameters

string
required
Category name (maximum 50 characters)
integer
required
Display order for the category (integer value)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_KPI_UNITTool to create a new KPI unit in SimpleKPI. Use when you need to define a measurement unit for KPI tracking.

Input Parameters

string
required
Unit name (maximum 25 characters)
string
required
Entry format for the unit (maximum 25 characters). Use ’###’ as placeholder for numeric values
boolean
required
Whether the unit represents a percentage value
string
required
Display format for the unit (maximum 25 characters). Use ’###’ as placeholder for numeric values

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_OR_UPDATE_KPI_ENTRIESTool to batch create or update multiple KPI entries at once. Use when you need to load multiple KPI data points efficiently (up to 5000 entries per batch). Each entry must have a kpi_id, entry_date, and either email or user_id.

Input Parameters

array
required
Array of KPI entry objects to create or update. Maximum 5000 entries per batch
boolean
Indicates whether the batch contains notes. Helps optimize processing
boolean
Indicates whether the batch contains actual values. Helps optimize processing
boolean
Indicates whether the batch contains target values. Helps optimize processing

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_CREATE_USERTool to create a new user account in SimpleKPI. Use when you need to add a new user with specific permissions and access levels.

Input Parameters

string
required
Valid email address for login
string
required
Password for new user. Must be at least 8 characters long
string
Last name of user (optional)
string ("Admin" | "Director" | "Manager" | "User")
required
User type: Admin, Director, Manager, or User
string
required
First name of user
string ("A" | "L")
required
User status: A for Active or L for Locked
boolean
required
Whether user can manage other users. Relevant for Manager type
boolean
required
Whether user can access admin settings. Relevant for Admin type

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_CATEGORY_KPITool to delete a KPI from a category. Use when you need to remove a specific KPI from a category.

Input Parameters

integer
required
The ID of the KPI to delete from the category
integer
required
The ID of the category containing the KPI

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_GROUPTool to delete a group by ID. Use when you need to permanently remove a group from the system.

Input Parameters

integer
required
Group ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_GROUP_ITEMTool to delete a group item by ID. Use when you need to remove an item from a specific group.

Input Parameters

integer
required
The ID of the group item to delete
integer
required
The ID of the group containing the item to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_KPITool to delete a KPI by ID. Use when you need to permanently remove a specific KPI from the system.

Input Parameters

integer
required
The unique identifier of the KPI to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_KPI_CATEGORYTool to delete a KPI category by its ID. Use when you need to remove a KPI category from the system.

Input Parameters

integer
required
The unique identifier of the KPI category to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_KPI_ENTRYTool to delete a KPI entry by ID. Use when you need to permanently remove a specific KPI entry from the system.

Input Parameters

integer
required
The unique identifier of the KPI entry to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_KPI_UNITTool to delete a KPI unit by its ID. Use when you need to remove a KPI unit from the system.

Input Parameters

integer
required
The unique identifier of the KPI unit to delete.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_USERTool to delete a user account by ID. Use when you need to permanently remove a user from the system.

Input Parameters

integer
required
User ID to delete

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_USER_GROUP_ITEMRemove a group item assignment from a user in SimpleKPI. The tool also reports success when the deletion request returns 404, so success does not confirm an assignment was removed.

Input Parameters

integer
required
Group item ID to remove from the user.
integer
required
User ID to remove the group item assignment from.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_DELETE_USER_KPITool to remove a KPI assignment from a user. Use when you need to unassign or delete a specific KPI from a user’s profile.

Input Parameters

integer
required
The ID of the KPI assignment to remove from the user
integer
required
The ID of the user from whom to remove the KPI assignment

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_ALL_DATA_ENTRIESRetrieve processed KPI report entries, including calculated KPIs, with metrics, targets, and metadata. Results are limited to 10,000 entries; omitted start and end dates each default to today.

Input Parameters

string
End date for filtering entries in YYYY-MM-DD format. Defaults to today if not provided
string
Comma-separated list of KPI IDs to filter entries (e.g., ‘1,2,3’). If not provided, returns entries for all KPIs
string
Comma-separated list of user IDs to filter entries (e.g., ‘5,15,25’). Filters by specific users
string
Start date for filtering entries in YYYY-MM-DD format. Defaults to today if not provided
string
Comma-separated list of group item IDs to filter entries (e.g., ‘10,20,30’). Filters by specific group items

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_CATEGORY_KPITool to retrieve a specific KPI within a category. Use when you need detailed information about a particular KPI including its name, description, target values, and configuration settings.

Input Parameters

integer
required
The ID of the KPI to retrieve.
integer
required
The ID of the category containing the KPI.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_GROUPTool to get a specific group by ID from SimplekPI. Use when you need to retrieve detailed information about a particular group.

Input Parameters

integer
required
The unique identifier of the group to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_GROUP_ITEMTool to retrieve a specific group item by ID. Use when you need to fetch details of a particular item within a group.

Input Parameters

integer
required
The unique identifier of the item to retrieve.
integer
required
The identifier of the group containing the item.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_KPITool to retrieve a specific KPI by ID from SimpleKPI. Use when you need detailed information about a particular KPI including its configuration, targets, and metadata.

Input Parameters

integer
required
The unique identifier of the KPI to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_KPI_CATEGORYTool to get a specific KPI category by ID from SimpleKPI. Use when you need to retrieve detailed information about a particular KPI category.

Input Parameters

integer
required
The unique identifier of the KPI category to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_KPI_ENTRYTool to retrieve a specific KPI entry by ID. Use when you need to fetch detailed information about a particular KPI entry including actual values, targets, notes, and timestamps.

Input Parameters

integer
required
The unique identifier of the KPI entry to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_KPI_FREQUENCYTool to get a specific KPI frequency by ID from SimplekPI. Use when you need to retrieve information about a particular frequency setting for KPIs.

Input Parameters

string
required
The frequency ID (e.g., ‘D’ for Daily, ‘W’ for Weekly, ‘M’ for Monthly)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_KPI_ICONTool to retrieve a specific KPI icon by ID. Use when you need to get icon details including the icon name which can be used to construct the icon URL.

Input Parameters

integer
required
The unique identifier of the KPI icon to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_KPI_UNITTool to get a specific KPI unit by ID from SimpleKPI. Use when you need to retrieve detailed information about a particular KPI unit including its format specifications and metadata.

Input Parameters

integer
required
The unique identifier of the KPI unit to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_USERTool to retrieve a specific user by ID. Use when you need to get details about a particular user account.

Input Parameters

integer
required
The unique user ID to retrieve

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_USER_GROUP_ITEMTool to get a specific group item assigned to a user. Use when you need to retrieve details of a particular group item for a user.

Input Parameters

integer
required
The identifier of the group item to retrieve
integer
required
The identifier of the user

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_GET_USER_KPITool to retrieve a specific KPI assigned to a user. Use when you need details about a particular KPI assignment for a user.

Input Parameters

integer
required
The ID of the KPI assigned to the user.
integer
required
The ID of the user.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_CATEGORY_KPISTool to retrieve all KPIs within a specific category. Use when you need to list or inspect KPIs belonging to a particular category.

Input Parameters

integer
required
The ID of the category to retrieve KPIs from

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_GROUP_ITEMSTool to get all items within a group. Use when you need to retrieve the complete list of items belonging to a specific group.

Input Parameters

integer
required
The identifier of the group containing the items

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_GROUPSTool to retrieve all groups from SimpleKPI. Use when you need to list groups for organizing users and company hierarchy.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_KPI_CATEGORIESTool to get all KPI categories. Use when you need to retrieve the complete list of KPI categories for organizing KPIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_KPI_ENTRIESTool to get all KPI entries filtered by date range and optional criteria. Use when you need to retrieve KPI data for analysis or reporting. Returns a maximum of 500 entries per page. Use pagination parameters (rows, page) to retrieve additional entries.

Input Parameters

integer
Page number for pagination (starts at 1)
integer
Maximum number of entries to return per page (max 500)
integer
Filter by specific KPI ID to get entries only for that KPI
string
required
End date for filtering KPI entries in YYYY-MM-DD format
integer
Filter by specific user ID to get entries only for that user
string
required
Start date for filtering KPI entries in YYYY-MM-DD format

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_KPI_FREQUENCIESTool to get all KPI frequencies. Use when you need to retrieve available data entry frequency options (Daily, Weekly, Monthly, etc.) for KPI configuration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_KPI_ICONSTool to retrieve all KPI icons from SimpleKPI. Use when you need to get available icons for display purposes or to help identify KPIs.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_KPISTool to retrieve all KPIs from a SimpleKPI account. Use when you need to list all available KPIs with their configurations, targets, and metadata.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_KPI_UNITSTool to retrieve all KPI units from a SimpleKPI account. Use when you need to list available units that describe how KPI values are displayed (currency, percentage, etc.).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_USER_GROUP_ITEMSTool to get all group items assigned to a user. Use when you need to retrieve group assignments for a specific user in SimpleKPI.

Input Parameters

integer
required
The ID of the user to retrieve group items for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_LIST_USER_KPISTool to get all KPIs assigned to a specific user. Use when you need to retrieve what KPIs a user can enter data against and analyze.

Input Parameters

integer
required
User ID to retrieve KPIs for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_UPDATE_CATEGORY_KPITool to update a KPI within a category. Use when you need to modify KPI details such as name, target, frequency, or aggregation method.

Input Parameters

integer
required
KPI ID to update
string
required
KPI name (max 100 characters)
integer
required
Icon identifier for the KPI
integer
required
Unit of measure identifier
boolean
required
Determines if data entry is permitted for this KPI
integer
required
Display ordering position
integer
required
Category ID containing the KPI
string
KPI description (max 150 characters)
string ("W" | "D" | "M" | "Q" | "Y")
required
Data entry frequency: W (Weekly), D (Daily), M (Monthly), Q (Quarterly), or Y (Yearly)
number
Default target value for the KPI
string ("U" | "D" | "N")
required
Direction indicator: U (Up), D (Down), or N (None)
string ("AVG" | "SUM")
required
Calculation method: AVG (Average) or SUM (Sum)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_UPDATE_GROUPTool to update an existing group in SimpleKPI. Use when you need to modify a group’s name or display order.

Input Parameters

integer
required
The unique ID of the group to update.
string
required
The new name for the group (max 50 characters).
integer
required
The display order for the group. Lower values appear first.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_UPDATE_GROUP_ITEMTool to update an existing item in a SimpleKPI group. Use when you need to modify the name or sort order of a group item. Requires both group_id and item id to identify the item to update. Both name and sort_order must be provided.

Input Parameters

integer
required
The unique identifier of the item to update.
string
required
The new name for the item. Maximum length is 50 characters.
integer
required
The unique identifier of the group containing the item.
integer
required
The display order of the item. Must be a 16-bit integer (range: -32768 to 32767).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_UPDATE_KPITool to update an existing KPI in SimpleKPI. Use when you need to modify KPI properties such as name, description, target values, or settings.

Input Parameters

integer
required
KPI ID to update
string
required
KPI name (maximum 100 characters)
integer
required
Icon identifier for the KPI
integer
required
Unit of measure identifier
boolean
required
Activation status for data entry. Set to true to enable data entry, false to disable.
integer
required
Display order ranking for the KPI
integer
required
KPI Category ID that this KPI belongs to
string
KPI description (maximum 150 characters)
string ("D" | "W" | "M" | "Q" | "Y")
required
Data entry frequency (D=Daily, W=Weekly, M=Monthly, Q=Quarterly, Y=Yearly). Case-sensitive, must be uppercase.
number
Default target value for the KPI
string ("U" | "D" | "N")
required
Direction indicator: U(p) means higher is better, D(own) means lower is better, N(one) means no direction
string ("AVG" | "SUM")
required
How the KPI is calculated: AVG (Average) or SUM (Total Sum)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_UPDATE_KPI_ENTRYTool to update an existing KPI entry in SimpleKPI. Use when modifying entry values, targets, or notes for a specific KPI entry. At least one of actual, target, or notes must be provided (actual cannot be null if both target and notes are null).

Input Parameters

string
The note associated with the KPI entry (max 500 characters)
number
The actual value. Cannot be null if the target and notes are both null
integer
required
The KPI must be active and cannot be a calculated KPI. The KPI must also be assigned to the user
number
The target value of the entry. This value will be ignored if the KPI has a null target
integer
required
An ID of an active user to assign to the KPI entry
string
required
The date of the entry. Date time format without timezone, e.g. ‘2019-01-01T00:00:00’
integer
required
The ID of the KPI entry to update (required)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_UPDATE_KPI_UNITTool to update an existing KPI unit in SimpleKPI. Use when you need to modify unit properties such as name, entry format, display format, or percentage status.

Input Parameters

integer
required
The unit ID to update
string
required
The name of the KPI unit (maximum 25 characters)
string
required
The entry format is only for entry and will not have the prefix or suffix (e.g., #.00). Maximum 25 characters.
boolean
required
To determine if the value is a percentage as these values are treated differently
string
required
The display format must be a valid number format (e.g., £ #.00). Maximum 25 characters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: SIMPLEKPI_UPDATE_USERTool to update an existing user account in SimpleKPI. Use when you need to modify user details such as type, status, name, or permissions.

Input Parameters

integer
required
User ID to update
string
required
Email address of the user
string
Last name of the user
string
required
User type (e.g., ‘Standard’, ‘Manager’, ‘Director’)
string
required
First name of the user
string
required
User status ID. Use ‘A’ for Active, ‘I’ for Inactive
boolean
Whether the user can manage other users. Set to true to grant user management permissions
boolean
Whether the user can access admin settings. Set to true to grant admin access

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not