更新企业内部应用

PUT

/v1.0/microApp/apps/{agentId}

**
接口调用量说明**钉钉标准版接口累计可调用次数为1万次/月，当前接口会消耗调用次数。若该调用量无法满足需求，你可升级钉钉专业版(Open API调用量50万次/月)或钉钉专属版(Open API调用量500万次/月)扩容调用次数。

调用本接口，更新企业内部应用信息。

接口功能介绍

例如，企业管理员小明拥有测试微应用的管理权限，调用本接口可以更新该应用的如下信息：

应用信息，包含应用Logo、应用名称和应用简介。如下图所示：

开发管理，包含服务器出口IP、应用首页地址、PC端首页地址和管理后台地址。如下图所示：

权限

要调用此API，需要以下权限之一。

应用类型	是否支持	权限	API Explorer调试
企业内部应用	支持	管理微应用的权限	API Explorer
第三方企业应用	暂不支持	管理微应用的权限	暂不支持
第三方个人应用	暂不支持	管理微应用的权限	暂不支持

错误码

HttpCode	错误码	错误信息	说明
400	invalidParam	参数错误: %s	参数错误
400	invalidUser	用户id不合法，不在对应企业中	用户id不合法，不在对应企业中
400	invalidEcologicalCorpId	不合法的合作空间corpId	不合法的合作空间corpId
400	noAppManagePermission	没有操作应用的权限	没有操作应用的权限
400	illegalIp	ip不合法	ip不合法，可能是单个ip不合法，也可能是ip总长度超过了50
400	invalidAgentId	不合法的agentId	不合法的agentId
400	illegalAppName	应用名称含有不规范词语	应用名称含有不规范词语
400	illegalAppDesc	应用描述含有不规范词语	应用描述含有不规范词语
400	illegalAppIcon	应用图标含有不规范词语	应用图标含有不规范词语
500	systemError	系统繁忙	系统繁忙

请求示例

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.dingtalk.com/v1.0/microApp/apps/' \
--header 'x-acs-dingtalk-access-token;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "opUnionId" : "String",
  "name" : "String",
  "desc" : "String",
  "icon" : "String",
  "homepageLink" : "String",
  "pcHomepageLink" : "String",
  "ompLink" : "String",
  "ipWhiteList" : [ "String" ]
}'

响应示例

{
    "result": true
}

请求参数

Path 参数

agentId

string

必需

应用的agentId，请参考基础概念-AgentId。

Header 参数

x-acs-dingtalk-access-token

string

必需

调用该接口的访问凭证。

企业内部应用，调用获取企业内部应用的accessToken接口获取。

第三方企业应用，调用获取第三方应用授权企业的accessToken接口获取。

Body 参数application/json

opUnionId

string

必需

操作更新的员工unionId，可调用查询用户信息接口获取unionid参数值。说明操作更新的员工必须有该应用的管理权限，否则会出现没有操作应用的权限的错误。应用管理权限查看路径：管理员登录钉钉管理后台 > 安全与权限 > 权限管理 > 管理组查看。

name

string

可选

应用名称，名称可以由中文、数字以及字母组成，长度范围要求2-20个字符。

desc

string

可选

应用描述，最大长度200个字符。

icon

string

可选

应用图标，可调用上传媒体文件接口获取media_id参数值。

homepageLink

string

可选

应用首页地址，请输入http或https开头的网址链接。例如：https://www.dingtalk.com。

pcHomepageLink

string

可选

应用PC端地址，请输入http或https开头的链接。例如：https://www.dingtalk.com。

ompLink

string

可选

应用管理后台地址，输入http或https开头的链接。例如：https://www.dingtalk.com。

ipWhiteList

array[string]

可选

服务器出口ip白名单，支持带一个*号通配符的IP格式。

示例

返回响应

🟢200成功

application/json

Body

result

boolean

必需

更新结果。如果更新成功，该值为true。如果更新失败，不返回result，接口会响应对应报错信息。

修改于 2024-01-25 02:53:24

创建企业内部应用

删除企业内部应用

更新企业内部应用

接口功能介绍#

权限#

错误码#

请求参数

返回响应

接口功能介绍

权限

错误码