修改日程
PUT
/v1.0/calendar/users/{userId}/calendars/{calendarId}/events/{eventId}说明
调用本接口修改单个日程信息。
服务地址:api.dingtalk.com
权限
要调用此API,需要以下权限之一。
应用类型 | 是否支持 | 权限 | API Explorer调试 |
---|---|---|---|
企业内部应用 | 支持 | 日历应用中日程写权限 | API Explorer |
第三方企业应用 | 暂不支持 | 日历应用中日程写权限 | 暂不支持 |
第三方个人应用 | 支持 | 日历应用中日程写权限 | API Explorer |
错误码
HttpCode | 错误码 | 错误信息 | 说明 |
---|---|---|---|
400 | invalidParameter | forwardErrorMessage | 参数异常 |
404 | itemNotFound | forwardErrorMessage | 无法找到指定日程 |
请求参数
日程组织者的unionId,可通过根据userid获取用户详情接口获取。
日程所属的日历ID,统一为primary,表示用户的主日历。
调用服务端接口的授权凭证。使用个人用户的accessToken,请参考获取登录用户的访问凭证。使用企业内部应用的accessToken,请参考获取企业内部应用的accessToken。
日程开始日期,格式:yyyy-MM-dd。如果是全天日程必须有值,非全天日程必须留空。
日程开始时间,格式为ISO-8601的date-time格式。非全天日程必须有值,全天日程必须留空。
日程开始时间所属时区,TZ database name格式非全天日程必须有值,全天日程必须留空。
日程结束时间。日程循环次数numberOfOccurrences和日程结束时间end不可同时设置。
日程结束日期,格式:yyyy-MM-dd如果是全天日程必须有值,非全天日程必须留空。
日程结束时间,格式为ISO-8601的date-time格式。非全天日程必须有值,全天日程必须留空。
日程结束时间所属时区,必须和开始时间所属时区相同,TZ database name格式非全天日程必须有值,全天日程必须留空。
用户的unionId。
JSON格式的扩展能力开关,选填,具体属性定义如下:noPushNotification:创建日程时是否向关联人员发送钉钉推送通知,取值:
true:不发送false:发送noChatNotification:创建日程时是否向参与人发送单聊卡片,取值:
true:不发送false:发送
日程提醒,可以添加多个,如果不传默认提醒时间为:非全天日程:开始前15分钟提醒全天日程:开始前一天9点如果传空数据表示不创建任何提醒。
提醒方式:dingtalk: 钉钉内提醒
在日程开始前N分钟发出提醒。
{}
示例代码
返回响应
日程开始日期,格式:yyyy-MM-dd。如果是全天日程必须有值,非全天日程必须留空。
日程开始时间,格式为ISO-8601的date-time格式。非全天日程必须有值,全天日程必须留空。
日程开始时间所属时区,TZ database name格式非全天日程必须有值,全天日程必须留空。
日程结束日期,格式:yyyy-MM-dd。如果是全天日程必须有值,非全天日程必须留空。
日程结束时间,格式为ISO-8601的date-time格式。非全天日程必须有值,全天日程必须留空。
日程结束时间所属时区,必须和开始时间所属时区相同,TZ database name格式非全天日程必须有值,全天日程必须留空。
用户unionId。
是否是当前登陆用户。
用户uninonId。
是否是当前登陆用户。
{
"id": "string",
"summary": "string",
"description": "string",
"start": {
"date": "string",
"dateTime": "string",
"timeZone": "string"
},
"end": {
"date": "string",
"dateTime": "string",
"timeZone": "string"
},
"isAllDay": true,
"recurrence": {
"pattern": {
"type": "string",
"dayOfMonth": 0,
"daysOfWeek": "string",
"index": "string",
"interval": 0
},
"range": {
"type": "string",
"endDate": "string",
"numberOfOccurrences": 0
}
},
"attendees": [
{
"id": "string",
"displayName": "string",
"responseStatus": "string",
"self": true
}
],
"organizer": {
"id": "string",
"displayName": "string",
"responseStatus": "string",
"self": true
},
"location": {
"displayName": "string"
},
"createTime": "string",
"updateTime": "string"
}