Set notes for a team user

This function replaces the current notes field with new text.

SecurityBasicAuth
Request
query Parameters
notes
required
string

The content of the notes field.

Example: notes=teamUser is a good employee
user
required
string

The username of the team user.

Example: user=teamUser
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Team/set_notes
Request samples
uapi --output=jsonpretty \
  --user=username \
  Team \
  set_notes \
  user='teamUser' \
  notes='teamUser '
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "set_notes",
  • "module": "Team",
  • "result": {
    • "data": { },
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}