internal

Set Company Notification Preference

Set one notification type to the same value for every user at the company.

Users who lack the permission the notification requires are skipped, so a bulk change never grants a notification a user can't access.

put/internal/notifications/companies/{company_id}/preferences

Request

  • Base URL
    https://api.kobaltlabs.com (the document declares no server; this is the origin it was published from)
  • URL
    https://api.kobaltlabs.com/internal/notifications/companies/{company_id}/preferences
  • Auth
    none declared

Path parameters

company_idstring uuid required

Request body

notification_typestring required
enabledboolean required
scope'all' | 'assigned'

How widely a user wants to receive a (scope-supporting) notification.

ALL means every event of this type at the company; ASSIGNED narrows it to the subset that concerns the user. What "assigned" resolves to is defined by the definition's AssignedScopeSpec.kind.

Response

Successful Response

Changes

No recorded changes to this operation across all 8 revisions of this API.