/irm/v1/workstates

Log in to see full request history

This call allows adding new Workstates and associated values.

Parameters

  • TenantID - How your specific customer instance is identified, this will be a number. Find this in the app Help (?) icon > MotionCX Voice > Tenant:
  • Name - Name of new Workstate.
  • Color - HTML color of Workstate bubble in the MotionCX webclient.
  • Productive - This is a parameter for future reporting work.
  • IsHiddenForEdit - Hides it from the Administration UI.
  • IsHiddenFor Agent - Makes it not a choice in the MotionCX client pull down.
  • IsDefault - This is the Workstate that the Agent receives at logging into the MotionCX client.
  • It is recommended advanced filter object be done outside of the API document for best results.

Responses available:

  • 200
  • 401
  • 403

Example return:

{ "id": 1007, "tenantId": 2, "name": "available" }
Body Params
int32
required
string
required
length ≥ 1
string | null
string | null
boolean | null
boolean | null
boolean | null
boolean | null
Responses

401

Unauthorized

403

Forbidden

Language
Credentials
URL
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json