メインコンテンツへスキップ
POST
/
redeem
/
people
/
batch
cURL
curl --request POST \
  --url https://api.pubrio.com/redeem/people/batch \
  --header 'Content-Type: application/json' \
  --header 'pubrio-api-key: <api-key>' \
  --data '
{
  "profile_id": 123,
  "peoples": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "people_contact_types": [
    "email-personal",
    "email-work",
    "phone"
  ]
}
'
{
  "data": {
    "redeem_query_id": "a046c1da-b3d4-4ca1-aca6-1dd8c8055701",
    "is_completed": false,
    "estimated_time": 6,
    "estimated_time_type": "second"
  }
}

Authorizations

​
pubrio-api-key
string
header
required

API で実行する操作内容と、その操作に付与された権限を識別するための一意の API トークンです。このトークンはダッシュボードの 設定 画面から発行できます。

Body

application/json
​
profile_id
integer
required

リクエストを送信するチームを表す識別子です。この ID によって検索結果が特定のチーム（ワークスペース）に紐づけられ、データ取得およびクレジット利用状況の追跡が可能になります。詳しくは、チーム関連の「ユーザー詳細」エンドポイントを参照してください。

​
peoples
string<uuid>[]
required

ユーザー検索処理で利用する people_search_id の一覧です。

​
people_contact_types
enum<string>[]
required

取得する連絡先種別（勤務メール、個人メール、電話番号など）を制御するためのパラメーターで、1 つ以上を指定できます。

利用可能なオプション:
email-personal,
email-work,
phone
Example:
["email-personal", "email-work", "phone"]

Response

関連する詳細情報を含む成功レスポンスです。

​
data
object

エンドポイント固有のレスポンスをオブジェクト形式で格納する汎用コンテナです。