PUT api/users/{guid}/settings

Update an existing user's settings

Request Information

URI Parameters

NameDescriptionTypeAdditional information
guid

globally unique identifier

Required

Body Parameters

ObitNoteSettingsDto
NameDescriptionTypeAdditional information
NotifySms

Whether the user should be notified by SMS

 boolean

Required
NotifyEmail

Whether the user should be notified by email

 boolean

Required
NotifyPush

Whether the user should be notified by push notification

 boolean

Required

Request Formats

application/json, text/json

Sample: 
{
  "notifySms": true,
  "notifyEmail": true,
  "notifyPush": true
}

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Update an existing user's settings

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.

Error responses

  • invalid_fields - The submitted information is incomplete or otherwise invalid. The description of the error will be a detailed summary of invalid fields