Subscriptions - Update Subscription User Settings

参考

服务:: Notification

API 版本:: 7.1-preview.1

更新指定订阅的指定用户设置。此 API 通常用于选择加入或退出共享订阅。用户设置只能应用于共享订阅，如团队订阅或默认订阅。

PUT https://{service}dev.azure.com/{organization}/_apis/notification/Subscriptions/{subscriptionId}/usersettings/{userId}?api-version=7.1-preview.1

URI 参数

名称	在	必需	类型	说明
subscriptionId	path	True	string
userId	path	True	string uuid	用户的 ID
organization	path		string	Azure DevOps 组织的名称。
service	path		string	此请求定向到的服务。
api-version	query	True	string	要使用的 API 版本。应将其设置为“7.1-preview.1”才能使用此版本的 API。

请求正文

名称	类型	说明
optedOut	boolean	指示用户是否将收到关联组订阅的通知。

响应

名称	类型	说明
200 OK	SubscriptionUserSettings	成功的操作

安全性

oauth2

类型: oauth2
流向: accessCode
授权 URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
令牌 URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

作用域

名称	说明
vso.notification_write	提供对订阅的读/写访问权限和对事件元数据（包括可筛选字段值）的读取访问权限。

示例

Opt out

示例请求

HTTP

PUT https://dev.azure.com/fabrikam/_apis/notification/Subscriptions/{subscriptionId}/usersettings/{userId}?api-version=7.1-preview.1

{
  "optedOut": true
}

示例响应

状态代码:: 200

{
  "optedOut": true
}

定义

SubscriptionUserSettings

Object

组订阅的用户托管设置。

名称	类型	说明
optedOut	boolean	指示用户是否将收到关联组订阅的通知。

通过