User Webservice

Update partner user notification settings

Update notification settings for partner user with partner-specific notification configurations.

post/api/user/updatePartnerUserNotificationSettings

Request

  • Base URL: https://api2.rhombussystems.com
  • URL: https://api2.rhombussystems.com/api/user/updatePartnerUserNotificationSettings
  • Auth: API key in header x-auth-apikey

Headers

x-auth-scheme'api-token' | 'api' | 'partner-api-token' | 'partner-api' required

Authentication scheme identifier. Use api-token for standard API key authentication, partner-api-token for partner API key authentication. Must be paired with the x-auth-apikey header containing your API key.

Request body

allClientsSelectedboolean nullable
clientNotificationIntervalsMapobject nullable
orgUuidstring RUUID nullable

base 64 (url-safe) uuid string

smsNotificationIncludesLinksboolean nullable
smsPhoneNumbersstring[] nullable
summaryEmailEnabledboolean nullable
updatedSetMethodMapobject nullable
userUuidstring RUUID nullable

base 64 (url-safe) uuid string

Example request

{
  "notificationIntervalsForAllClients": [
    {
      "clientUuids": [
        "AAAAAAAAAAAAAAAAAAAAAA"
      ]
    }
  ],
  "orgUuid": "AAAAAAAAAAAAAAAAAAAAAA",
  "userUuid": "AAAAAAAAAAAAAAAAAAAAAA"
}

Response

OK

errorboolean nullable
errorCodestring nullable

Stable, machine-readable code for the failure (one of the ApiErrorCode catalog) when error is true. Branch on this, not on errorMsg.

errorMsgstring nullable
warningMsgstring nullable

Changes

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