Skip to main content
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

A unique API token that represents the actions you perform through the API and the corresponding permissions and operations. You can create it through the Settings section.

Body

application/json
​
profile_id
integer
required

An identifier for the user profile (workspace) making the request. This ID helps in associating the lookup with a specific user, allowing for data retrieval and credit tracking.

Check out user details endpoints under the Profile tab for more information.

​
peoples
string<uuid>[]
required

A list of unique identifiers (people_search_id) used for people search operations.

​
people_contact_types
enum<string>[]
required

This parameter controls the retrieval of various details such as work email address, personal email address, phone number. You can enter one or all.

Available options:
email-personal,
email-work,
phone
Example:
["email-personal", "email-work", "phone"]

Response

Successful response containing bulk redeem people status.

​
data
object

Response info depends on specific endpoint.