Freshservice - Create agent action

The Create agent action allows you to create a new agent in Freshservice.

Input

Input fieldDescription
First nameProvide the first name of the agent.
Last nameProvide the last name of the agent.
OccasionalSelect the boolean value from the drop-down menu. Set true if the agent is an occasional agent, and false if a full-time agent.
Job titleProvide the agent's job title.
EmailProvide the agent's email address.
Work phone numberProvide the agent's work phone number.
Mobile phone numberProvide the agent's mobile phone number.
Department IDsProvide the unique IDs of the departments associated with the agent
Can see all tickets from associated departmentsSelect the boolean value from the drop-down menu. Set to true if the agent must be allowed to view tickets filed by other members of the department, and false otherwise
Reporting manager IDProvide the user ID of the agent's reporting manager.
AddressProvide the agent's address.
Time zoneProvide the agent's time zone.
Time formatProvide the agent's time format. Possible values include: 12h (12 hour format) and 24h (24 hour format).
LanguageSpecify the language used by the agent.
Location IDProvide the unique ID of the location associated with the agent.
Background informationProvide the background information of the agent.
Scoreboard level IDProvide the unique ID of the agent's level in the arcade. Possible values include: 1 (Beginner), 2 (Intermediate), 3 (Professional), 4 (Expert), 5 (Master), and 6 (Guru)
Member ofProvide the unique IDs of the groups that the agent is a member of.
Observer ofProvide the unique IDs of the groups that the agent is an observer of.
RolesEach individual role is a hash in the roles array that contains attributes like role ID, assignment scope, and groups. Provide the appropriate values in the respective fields.
SignatureProvide the signature of the agent in HTML format.
Custom fieldsProvide the key-value pair containing the names and values of the (custom) agent fields.

Output

FieldDescription
Agent IDA unique identifier assigned to the agent.
First nameFirst name of the agent.
Last nameLast name of the agent.
OccasionalIndicates whether the agent is an occasional user (true/false).
ActiveIndicates whether the agent is currently active (true/false).
Job titleJob title of the agent.
EmailEmail address of the agent.
Work phone numberWork phone number of the agent.
Mobile phone numberMobile phone number of the agent.
Department IDsUnique IDs of the departments associated with the agent.
Can see all tickets from associated departmentsIndicates whether the agent has access to all tickets within their department (true/false).
Auto assign ticketsIndicates whether tickets are automatically assigned to the agent.
External IDA unique identifier for external system integrations.
Department namesThe names of the departments the agent is associated with.
Auto assign status changed atThe timestamp when the auto-assign status was last changed.
Reporting manager IDUser ID of the agent's reporting manager.
AddressAddress of the agent.
Time zoneTime zone of the agent.
Time formatTime format for the agent.
LanguageLanguage used by the agent.
Location IDUnique ID of the location associated with the agent.
Background informationBackground information of the agent.
Scoreboard level IDUnique ID of the level of the agent in the Arcade.
ScopesThe permissions and access levels assigned to the agent.
Member ofUnique IDs of the groups that the agent is a member of.
Observer ofUnique IDs of the groups that the agent is an observer of.
RolesThe roles assigned to the agent, defining their permissions.
Last login atThe last recorded time the agent logged in.
Last active atThe last recorded time the agent was active.
Has logged inIndicates whether the agent has ever logged into the system (true/false).
SignatureSignature of the agent in HTML format.
VIP userIndicates whether the agent is considered a VIP user.
Work schedule IDThe identifier for the agent’s assigned work schedule.
Workspace IDsThe IDs of the workspaces the agent is associated with.
Workspace infoAdditional information about the agent’s workspace.
Created atThe timestamp when the agent profile was created.
Updated atThe timestamp when the agent profile was last updated.
Custom fieldsKey-value pair containing the names and values of the (custom) agent fields.

Last updated: