BlueCart · Schema

UserCreate

Payload for creating or updating a user.

RestaurantProcurementWholesaleOrderingFood DistributionHospitalityeCommerce

Properties

Name Type Description
firstName string
lastName string
email string
enabled boolean
notify boolean
role string
phone string
reportsTo integer
notificationTypes array
View JSON Schema on GitHub

JSON Schema

bluecart-user-create-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "title": "UserCreate",
  "description": "Payload for creating or updating a user.",
  "$id": "https://raw.githubusercontent.com/api-evangelist/bluecart/refs/heads/main/json-schema/bluecart-user-create-schema.json",
  "type": "object",
  "properties": {
    "firstName": {
      "type": "string",
      "example": "Alex"
    },
    "lastName": {
      "type": "string",
      "example": "Morgan"
    },
    "email": {
      "type": "string",
      "format": "email",
      "example": "[email protected]"
    },
    "enabled": {
      "type": "boolean",
      "example": true
    },
    "notify": {
      "type": "boolean",
      "example": true
    },
    "role": {
      "type": "string",
      "example": "Admin"
    },
    "phone": {
      "type": "string",
      "example": "+15555550123"
    },
    "reportsTo": {
      "type": "integer",
      "format": "int64",
      "example": 3000
    },
    "notificationTypes": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "example": [
        "OrderPlaced",
        "OrderShipped"
      ]
    }
  },
  "required": [
    "firstName",
    "lastName",
    "email"
  ]
}