新增訪客
新增訪客。不會傳送邀請電子郵件。
- 即使禁用了空間功能或訪客空間功能,也可以執行。
- 如果要邀請他們加入訪客空間,請使用此 API 將他們添加到訪客空間,然後使用更新訪客空間的訪客成員的 API將他們新增到訪客空間
更新訪客空間的訪客API - 新增訪客時,將啟用電子郵件通知。
URL
https://sample.cybozu.com/k/v1/guests.json
HTTP 方法
POST
所需存取權限
- kintone的系統管理員
請求
參數
參數名稱 | 類型 | 必須 | 說明 |
---|---|---|---|
guests | 陣列 | 必須 | 要新增的訪客資訊陣列 |
guests[].code | 字串 | 必須 | 要新增的訪客用戶的電子郵件位址 |
guests[].password | 字串 | 必須 | 要新增的訪客用戶的密碼 |
guests[].timezone | 字串 | 必須 | 要添加的訪客用戶的時區 |
guests[].locale | 字串 | 可省略 | 要添加的來訪客戶的語言 您可以指定以下值
|
guests[].image | 字串 | 可省略 | 要新增的訪客用戶的圖像 使用上傳檔案API上傳圖片檔案,並指定獲取的檔鍵。 上傳檔案的 API 如果省略,則設置初始圖片。 |
guests[].name | 字串 | 必須 | 要添加的訪客用戶的顯示名稱 指定 1 到 128 個字元。 |
guests[].surNameReading | 字串 | 可省略 | 要新增的訪客名 指定不超過 64 個字元 如果省略,則設置空字元。 |
guests[].givenNameReading | 字串 | 可省略 | 要新增的訪客名 指定不超過 64 個字元 如果省略,則設置空字元。 |
guests[].company | 字串 | 可省略 | 要新增的訪客的公司名稱 指定不超過 100 個字元 如果省略,則設置空字元。 |
guests[].division | 字串 | 可省略 | 要新增的訪客用戶的名稱 指定不超過 100 個字元 如果省略,則設置空字元。 |
guests[].phone | 字串 | 可省略 | 要新增的訪客用戶的電話號碼 指定不超過 100 個字元 如果省略,則設置空字元。 |
guests[].callto | 字串 | 可省略 | 要新增的訪客的 Skype 名稱 指定不超過 256 個字元 如果省略,則設置空字元。 |
示例請求
標頭
|
|
有關請求頭的詳細資訊,請參閱通用規格。
kintone REST API通用規範
內文
|
|
回應
|
|
示例代碼
使用 curl 的請求
|
|
kintone.api()
請求使用
有關詳細的kintone.api()
,請參閱以下頁面。
發送kintone REST API請求
|
|