跳转到主要内容
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 安全地存储在你的系统中,并设置适当的访问控制,以维护用户数据的完整性与保密性。
  • 出于安全考虑,无法通过 API 再次获取 Profile Key。不过你可以从控制台中获取。
  • 同时也应保存 refId,以便将 profile 与端点返回结果关联起来。

Header 参数

Body 参数

title
string
必填
新 profile 的标题。必须唯一。该标题将显示在社交账户关联页面上。
messagingActive
boolean
默认值:false
设为 true 可为该 user profile 启用私信 (DM) 功能。必须先在你的 Ayrshare 账户中启用私信功能。
hideTopHeader
boolean
默认值:false
在社交账户关联页面上隐藏顶部标题栏。
仅在该 user profile 的社交账户关联页面上隐藏公司 logo。其他 profile 上的账户级 logo 不受影响。适用于对特定合作伙伴 profile 进行白标处理,同时保留其余 profile 的品牌标识。
topHeader
string
更改社交账户关联页面的标题栏。若未设置,则显示:“Social Accounts for “title"",其中 “title” 为 profile 的标题。
disableSocial
array
为该 user profile 禁用的社交网络数组。Primary Profile 上禁用的社交网络列表优先生效。可用网络:blueskyfacebookgmbinstagramlinkedinpinterestredditsnapchattelegramthreadstiktoktwitteryoutube更多信息请参见启用或禁用社交网络
team
boolean
默认值:false
通过设置 team: true,将新的 user profile 创建为一个团队成员。email 字段将用于发送邀请邮件。相关要求详见邀请团队成员
email
string
用于发送团队成员邀请的有效电子邮件地址。当 team: true 时必填。
subHeader
string
更改社交账户关联页面的副标题。当前显示为 “Click an icon to link a social network”。设为空字符串可移除。请参阅如何修改帮助链接
tags
array
使用字符串数组为 user profile 添加标签。这些标签是用于对 user profile 进行有效分类与管理的内部组织工具。