UPupsmith
admin
user-preferences

List User Preference Definitions

get/admin/user-preferences/definitions

Request

  • Base URL
    https://api-docs.upsmith.com (the document declares no server; this is the origin it was published from)
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Query parameters

category'availability' | 'dispatch' | 'agent' | 'voice' | 'notification' | 'general'

Headers

organization-idstring nullable
timezonestring
x-user-idstring nullable
x-actor-emailstring nullable
x-request-sourcestring nullable
x-operation-idstring nullable
x-commit-messagestring nullable
x-confirmation-idstring nullable
x-chat-idstring nullable

Response

Successful Response

idstring required
keystring required
labelstring required
descriptionstring nullable required
category'availability' | 'dispatch' | 'agent' | 'voice' | 'notification' | 'general' required
value_type'string' | 'integer' | 'float' | 'boolean' | 'string_list' | 'integer_list' | 'json' required
validation_schemaobject nullable required
is_org_scopedboolean required
sort_orderinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.