v1

latestOpenAPI 3.0.02026-08-04265791.1 MB

Users

Partial Update

Update a subset of properties of an user.
Important - password cannot be updated (will be ignored) via this endpoint.

patch/public/api/users/{id}

Path parameters

idstring required

The id of the User

Headers

Acceptstring

e.g. application/json

Request body

tagsstring[]

client_role_extensionstring

store_type_namesstring[]

Example request

{
  "tags": [
    "The Dream",
    "Hakeem the Dream Olajuwon",
    "The Dream Shake"
  ],
  "client_role_extension": "Super",
  "store_type_names": [
    "ST1",
    "ST2"
  ],
  "weekly_schedule": {
    "fri": {
      "periods": [
        {
          "from": "09:00",
          "to": "13:00"
        }
      ]
    }
  }
}

Response

user_idstring

usernamestring

first_namestring

last_namestring

client_rolestring

client_role_extensionstring

emailstring

groupsstring[]

languagestring

photostring

store_idstring

tagsstring[]

mobile_versionstring

desktop_versionstring

store_type_namesstring[]

last_seenstring

created_datestring

updated_datestring

Example response

{
  "user_id": "53fb03c6546847ee0d30086a",
  "username": "johndoe9@houston.com",
  "first_name": "John",
  "last_name": "Doe",
  "client_role": "ROLEMANAGER",
  "client_role_extension": "Super",
  "email": "johndoe9@houston.com",
  "groups": [
    "test"
  ],
  "language": "en",
  "photo": "https://www.w3schools.com/w3images/avatar2.png",
  "store_id": "5739b18c6b8e2ac941fbee86",
  "tags": [
    "The Dream",
    "Hakeem the Dream Olajuwon",
    "The Dream Shake"
  ],
  "mobile_version": "6.5.16",
  "desktop_version": "7.0.16-9",
  "store_type_names": [
    "ST1",
    "ST2"
  ],
  "last_seen": "2020-11-19T14:21:44.625Z",
  "created_date": "2019-02-10T17:20:11.531Z",
  "updated_date": "2020-11-10T12:11:15.439Z",
  "weekly_schedule": {
    "mon_hours": {
      "periods": [
        {
          "from": "08:00",
          "to": "20:00"
        }
      ]
    },
    "tue_hours": {
      "periods": [
        {
          "from": "08:00",
          "to": "17:00"
        }
      ]
    },
    "wed_hours": {
      "periods": [
        {
          "from": "08:20",
          "to": "10:00"
        },
        {
          "from": "11:00",
          "to": "16:20"
        }
      ]
    },
    "thu_hours": {
      "periods": [
        {
          "from": "08:00",
          "to": "20:10"
        }
      ]
    },
    "fri": {
      "periods": [
        {
          "from": "09:00",
          "to": "13:00"
        }
      ]
    }
  }
}