メインコンテンツへスキップ
POST
Primary Profile の下に新しいプロファイルを作成します。User Profile が正常に作成されると、API レスポンスには新しく作成されたプロファイルに関連付けられた Profile Key が含まれます。ユーザーの代わりに API 呼び出しを行うために必要になるため、Profile Key はシステム内に安全に保管してください。 セキュリティ上の理由から、Profile Keys は次の 2 つの特定のケースでのみ返されます。
  1. User Profile 作成時: 新しい User Profile が作成されたとき。
  2. Ayrshare Dashboard 内: Ayrshare Dashboard 内で各プロファイルの Profile Key を確認できます。User Profile に切り替え、Profile Key ページに移動します。
Profile Key はシステム内に安全に保管することをお勧めします。

ソーシャルネットワークの管理

disableSocial フィールドを使用して、表示から(追加/削除)ソーシャルネットワークを管理します。詳細は Manage Social Accounts を参照してください。

アクティブな User Profiles の管理

アクティブな User Profiles の管理 に関する推奨事項をこちらで参照してください。

重要なセキュリティ上の考慮事項

  • Profile Keys を公開して共有したり、クライアントサイドコードや公開リポジトリで公開したりしないでください。
  • Profile Keys は、User Profiles へのアクセスの認証と承認に使用される機密資格情報です。
  • ユーザーデータの整合性と機密性を維持するために、適切なアクセス制御を持つシステム内に Profile Keys を安全に保管することが重要です。
  • セキュリティ上の理由から、Profile Key は API を使用して再度取得することはできません。ただし、ダッシュボード から Profile Key を取得できます。
  • refId も、プロファイルをエンドポイントの戻り値に関連付けるために保管してください。

Header Parameters

Body Parameters

title
string
必須
新しいプロファイルのタイトル。一意である必要があります。このタイトルはソーシャルアカウントリンクページに表示されます。
messagingActive
boolean
デフォルト:false
このユーザープロファイルに対してメッセージング機能を有効化するには true に設定します。事前に Ayrshare アカウントでメッセージング機能が有効になっている必要があります。
hideTopHeader
boolean
デフォルト:false
ソーシャルアカウントリンクページのトップヘッダーを非表示にします。
このユーザープロファイルのみ、ソーシャルアカウントリンクページの会社ロゴを非表示にします。他のプロファイルのアカウント全体のロゴには影響しません。他のプロファイルではブランディングを維持したまま、個々のパートナープロファイルをホワイトラベル化するのに便利です。
topHeader
string
ソーシャルアカウントリンクページのヘッダーを変更します。設定されていない場合、“Social Accounts for “title"" と表示されます(“title” はプロファイルのタイトル)。
disableSocial
array
このユーザーのプロファイルで無効化されたソーシャルネットワークの配列。プライマリプロファイルの無効化されたソーシャルネットワークのリストが優先されます。利用可能なネットワーク: blueskyfacebookgmbinstagramlinkedinpinterestredditsnapchattelegramthreadstiktoktwitteryoutube詳細は ソーシャルネットワークの有効化または無効化 を参照してください。
team
boolean
デフォルト:false
team: true を設定して、チームメンバーとして新しいユーザープロファイルを作成します。email フィールドは招待メールの送信に使用されます。要件の詳細については、チームメンバーの招待 を参照してください。
email
string
チームメンバー招待が送信される有効なメールアドレス。team: true の場合は必須です。
subHeader
string
ソーシャルアカウントリンクページのサブヘッダーを変更します。現在は “Click an icon to link a social network” と表示されています。削除するには空の文字列を設定します。ヘルプリンク の変更方法を参照してください。
tags
array
文字列の配列を使用してユーザープロファイルにタグを付けます。これらのタグは、ユーザープロファイルを効果的に分類・管理するための内部組織ツールとして機能します。