create retrieve update del Return to API overview

Calls: {root}/{version}/user note


POST/v4/create
Route {root}/v4/user-note/create
Request type BODY
User level SUPER USER
Requires authentication Yes
Response type Single

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_id INT32 REQUIRED 0 2147483647 - -
note STRING OPTIONAL 0 500 - -

Sample cURL

curl --location --request POST "{{ROOT}}/v4/user-note/create/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"user_id": "123456","note": "sample"}'

Sample response

Standard response object returned, see API Overview for structure.
GET/v4/retrieve
Route {root}/v4/user-note/retrieve
Request type URL
User level SUPER USER
Requires authentication Yes
Response type Single
Sample call{root}/v0/user-note/retrieve/12345678

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_id INT32 REQUIRED 0 2147483647 - -

Sample cURL

curl --location --request GET "{{ROOT}}/v4/user-note/retrieve/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Sample response

[
    {
      "object_name":"user_note_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"type_id",
      "type":"custom",
      "is_nullable":false,
      "nest":null,
      "custom":[
            {
                "name":"free",
                "value":"0"
            },
            {
                "name":"restricted",
                "value":"1"
            }]
      "note": 
  },
    {
      "object_name":"note",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"changed_date",
      "type":"DateTime",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"changed_id",
      "type":"Int32",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"changed_first_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  },
    {
      "object_name":"changed_last_name",
      "type":"String",
      "is_nullable":false,
      "nest":null,
      "custom":null
      "note": 
  }
]
PUT/v4/update
Route {root}/v4/user-note/update
Request type BODY
User level SUPER USER
Requires authentication Yes
Response type Single

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_note_id [INT32] REQUIRED 0 2147483647 - -
note STRING OPTIONAL 0 500 - -

Sample cURL

curl --location --request PUT "{{ROOT}}/v4/user-note/update/" \
-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \
--data '{"user_note_id": "123456","note": "sample"}'

Sample response

Standard response object returned, see API Overview for structure.
DELETE/v4/del
Route {root}/v4/user-note/del
Request type URL
User level SUPER USER
Requires authentication Yes
Response type Single
Sample call{root}/v0/user-note/del/12345678

Parameters

Name Type Nullable? Required? Min. Max. Nest Custom
user_note_id INT32 REQUIRED 0 2147483647 - -

Sample cURL

curl --location --request DELETE "{{ROOT}}/v4/user-note/del/12345678-H "Authorization: Bearer {{BEARER_TOKEN}}" \
-H "app-id:{{APP_ID}}" \
-H "Content-Type: application/json" \
-H "Accept-Encoding: gzip" \
-H "accept: */*" \

Sample response

Standard response object returned, see API Overview for structure.


Don't have a WhosOff account yet?

Instantly reduce time spent on leave management with your FREE, no obligation trial today!
Sign up today and get until Sunday, 26th July 2026 to try the full service, for Free!

Get your instant FREE account today