Userlist connects to a Nagent workspace with an API key. Once it is connected, agents can call 2 Userlist actions: "Delete Company from Userlist" and "Push User-Company Relationship". Nothing is enabled on connect: each action is allowed one at a time, and an action with side effects runs or waits for a person according to the agent's level.
Every operation an agent can call against Userlist, with input parameters and output schema.
USERLIST_DELETE_COMPANYTool to delete a company from Userlist. Use when you need to remove a company by its unique identifier after verifying it.
Input parameters
Unique identifier of the company to delete (must not contain '/').
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
USERLIST_PUSH_RELATIONSHIPTool to create or update a relationship between a user and a company in Userlist. Use after confirming valid user and company identifiers.
Input parameters
Additional custom data for the relationship (key-value pairs).
Identifier of the user.
Identifier of the company.
ISO-8601 timestamp for when the relationship was established.
Type of relationship: member, admin, or owner.
Output
Data from the action execution
Error if any occurred during the execution of the action
Whether or not the action execution was successful or not
Agents can call 2 Userlist actions on Nagent: "Delete Company from Userlist" and "Push User-Company Relationship". Delete Company from Userlist: Delete a company from Userlist. Each action is listed on this page with its input parameters and its output.
Userlist connects with an API key, under your workspace's own connection. Nothing is enabled on connect: each action is allowed one at a time and can be scoped to the agents that need it.
Delete Company from Userlist takes 1 required input: identifier. It returns data, error and successful.