freshworks · Schema

UserCreate

Properties

Name Type Description
name string Full name of the user.
email string Email address.
phone string Phone number.
role string Role to assign (admin, supervisor, agent).
team_ids array IDs of teams to assign.
View JSON Schema on GitHub

JSON Schema

freshworks-usercreate-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/UserCreate",
  "title": "UserCreate",
  "type": "object",
  "required": [
    "name",
    "email"
  ],
  "properties": {
    "name": {
      "type": "string",
      "description": "Full name of the user."
    },
    "email": {
      "type": "string",
      "format": "email",
      "description": "Email address."
    },
    "phone": {
      "type": "string",
      "description": "Phone number."
    },
    "role": {
      "type": "string",
      "description": "Role to assign (admin, supervisor, agent)."
    },
    "team_ids": {
      "type": "array",
      "items": {
        "type": "integer"
      },
      "description": "IDs of teams to assign."
    }
  }
}