跳转到主要内容
POST
在你的 Primary Profile 底下建立一個新的 Profile。User Profile 建立成功後,API 回應會包含與新建立的 Profile 關聯的 Profile Key。請將 Profile Key 安全地儲存在你的系統中,因為之後代表該使用者呼叫 API 時會用到它。 請注意,基於安全考量,Profile Key 僅會在下列兩種情境下回傳:
  1. User Profile 建立時:當一個新的 User Profile 建立時。
  2. 在 Ayrshare 控制台中:你可以在 Ayrshare 控制台中查看每個 Profile 的 Profile Key。切換到該 User Profile,然後前往 Profile Key 頁面。
我們建議你將 Profile Key 安全地儲存在你的系統中。

管理社群網路

使用 disableSocial 欄位來管理(新增/移除)顯示的社群網路。詳情請參閱管理社群帳號

管理使用中的 User Profile

請參閱此處的管理使用中的 User Profile 建議。

重要的安全性注意事項

  • 請勿公開分享 Profile Key,或將其暴露於用戶端程式碼或公開的程式碼儲存庫中。
  • Profile Key 是敏感憑證,用於驗證與授權對 User Profile 的存取。
  • 務必將 Profile Key 安全地儲存在你的系統中,並設定適當的存取控管,以維護使用者資料的完整性與機密性。
  • 基於安全考量,Profile Key 無法再透過 API 取得。不過,你可以從控制台取得 Profile Key。
  • 也應儲存 refId,以便將 Profile 與端點回傳結果關聯起來。

標頭參數

Body 參數

title
string
必填
新 Profile 的標題。必須唯一。此標題會顯示在社群帳號連結頁面上。
messagingActive
boolean
默认值:false
設為 true 可為此 user profile 啟用私訊功能。你的 Ayrshare 帳號必須先啟用私訊功能。
hideTopHeader
boolean
默认值:false
在社群帳號連結頁面上隱藏頂部標題列。
僅在此 user profile 的社群帳號連結頁面上隱藏公司 Logo。其他 Profile 上的帳號層級 Logo 不受影響。適用於針對特定合作夥伴 Profile 進行白牌處理,同時保留其餘 Profile 的品牌識別。
topHeader
string
變更社群帳號連結頁面的標題。如果未設定,會顯示:「Social Accounts for “title”」,其中 “title” 為 Profile 的標題。
disableSocial
array
針對此使用者 Profile 停用的社群網路陣列。Primary Profile 的停用社群網路清單具有優先順序。可用網路:blueskyfacebookgmbinstagramlinkedinpinterestredditsnapchattelegramthreadstiktoktwitteryoutube更多資訊請參閱啟用或停用社群網路
team
boolean
默认值:false
team: true 設定為 true,即可將新的 user profile 建立為團隊成員。email 欄位會用於寄送邀請信。相關要求詳情請參閱邀請團隊成員
email
string
用於寄送團隊成員邀請的有效電子郵件地址。若 team: true 則必填。
subHeader
string
變更社群帳號連結頁面的副標題。目前顯示為「Click an icon to link a social network」。設為空字串可將其移除。參閱如何變更說明連結
tags
array
使用字串陣列為使用者 Profile 加上標籤。這些標籤是內部的組織工具,可有效地分類與管理你的使用者 Profile。