添加地点地址

添加地点地址

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/corehr/v2/locations/:location_id/addresses
HTTP Method	POST
接口频率限制	5 次/秒
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	corehr:locations:write 更新地点信息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
location_id	string	地点 ID。ID 获取方式： - 调用【创建地点】【批量分页查询地点】等接口可以返回地点 ID 示例值："1616161616"

查询参数

名称	类型	必填	描述
client_token	string	否	根据 client_token 是否一致来判断是否为同一请求 示例值：12454646
need_custom_latin_address	boolean	否	是否需要自定义传入国际化拉丁语系地址。如果传入true能够自定义传入address_line_xx的值，否则address_line_xx跟随local_address_line_xx的值 示例值：true

请求体

名称	类型	必填	描述
country_region_id	string	是	国家 / 地区 ID - 可通过【查询国家/地区信息】接口获取 示例值："6862995757234914824"
region_id	string	是	主要行政区 ID - 可通过【查询省份/行政区信息】接口获取 示例值："6863326264296474119"
city_id	string	是	城市ID。 - 详情调用【查询城市信息】获取 示例值："6863333555859097096"
distinct_id	string	是	区/县ID - 详情可通过【查询区县信息】接口获取 示例值："6863333556291110408"
address_line1	string	否	地址行 1 示例值："丹佛测试地址-纽埃时区"
address_line2	string	否	地址行 2 示例值："PoewH"
address_line3	string	否	地址行 3 示例值："PoewH"
address_line4	string	否	地址行 4 示例值："jmwJc"
address_line5	string	否	地址行 5 示例值："jmwJc"
address_line6	string	否	地址行 6 示例值："jmwJc"
address_line7	string	否	地址行 7 示例值："jmwJc"
address_line8	string	否	地址行 8 示例值："rafSu"
address_line9	string	否	地址行 9 示例值："McPRG"
local_address_line1	string	否	地址行 1（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line2	string	否	地址行 2（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line3	string	否	地址行 3（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line4	string	否	地址行 4（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line5	string	否	地址行 5（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line6	string	否	地址行 6（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line7	string	否	地址行 7（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line8	string	否	地址行 8（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
local_address_line9	string	否	地址行 9（非拉丁语系的本地文字） - 填写规则可见【地址填写指南】 示例值："丹佛测试地址-纽埃时区"
postal_code	string	否	邮政编码 示例值："611530"
address_types	enum\[\]	否	地址类型，枚举值及详细信息可通过【枚举常量介绍】查询获得 数据校验规则： - 长度范围：0 ～ 5
└ enum_name	string	是	枚举值 示例值："phone_type"
is_primary	boolean	否	是否主要地址，一个地点只能存在一个主要地址，添加主要地址会将取消原主要地址 - true 表示地址是主要地址 - false 表示地址不是主要地址 示例值：true
is_public	boolean	否	是否公开地址 - true 表示地址是公开地址 - false 表示地址不是公开地址 示例值：true

请求体示例

{
    "country_region_id": "6862995757234914824",
    "region_id": "6863326264296474119",
    "city_id": "6863333555859097096",
    "distinct_id": "6863333556291110408",
    "address_line1": "丹佛测试地址-纽埃时区",
    "address_line2": "PoewH",
    "address_line3": "PoewH",
    "address_line4": "jmwJc",
    "address_line5": "jmwJc",
    "address_line6": "jmwJc",
    "address_line7": "jmwJc",
    "address_line8": "rafSu",
    "address_line9": "McPRG",
    "local_address_line1": "丹佛测试地址-纽埃时区",
    "local_address_line2": "丹佛测试地址-纽埃时区",
    "local_address_line3": "丹佛测试地址-纽埃时区",
    "local_address_line4": "丹佛测试地址-纽埃时区",
    "local_address_line5": "丹佛测试地址-纽埃时区",
    "local_address_line6": "丹佛测试地址-纽埃时区",
    "local_address_line7": "丹佛测试地址-纽埃时区",
    "local_address_line8": "丹佛测试地址-纽埃时区",
    "local_address_line9": "丹佛测试地址-纽埃时区",
    "postal_code": "611530",
    "address_types": [
        {
            "enum_name": "phone_type"
        }
    ],
    "is_primary": true,
    "is_public": true
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ address_id	string	地址 ID

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "address_id": "6862995757234914824"
    }
}