API Command: set_rep_status

The set_rep_status command sets the status for representatives logged into the representative console.

The command API is an authenticated API. For instructions on using authenticated APIs using OAuth, see Authenticate to the Remote Support API. The API account must have read-only or full access to the command API.

Required Parameter for set_rep_status

rep_id=[integer] The user ID of the representative whose status gets updated.
code_name=[string] The code name of the status to set.

XML Response for set_rep_status Query

<success> Present if the status was set successfully.
<error> Returns an error message if the status was not set successfully.

Query Example: set_rep_status Query

Set the status of the representative with ID 5 to the status with the code name busy.