freshworks · Schema

AgentUpdate

Properties

Name Type Description
occasional boolean Whether the agent is occasional.
group_ids array IDs of groups to assign.
role_ids array IDs of roles to assign.
ticket_scope integer Scope of tickets the agent can access.
View JSON Schema on GitHub

JSON Schema

freshworks-agentupdate-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AgentUpdate",
  "title": "AgentUpdate",
  "type": "object",
  "properties": {
    "occasional": {
      "type": "boolean",
      "description": "Whether the agent is occasional."
    },
    "group_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "IDs of groups to assign."
    },
    "role_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "IDs of roles to assign."
    },
    "ticket_scope": {
      "type": "integer",
      "description": "Scope of tickets the agent can access."
    }
  }
}