Skip to main content
POST
Batch redeem people contact details

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
peoples
string<uuid>[]
required

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

people_contact_types
enum<string>[]
required

Which contact details to redeem. Use exactly email-work, email-personal and/or phone — resolve the live list from the people contact type endpoint under the Filters tab.

Unrecognised values are not rejected. A misspelling such as work_email returns HTTP 200 with emails: null, phones: null and total_credit_cost: 0 — identical to a person genuinely having no contact data. If redemptions look universally empty, check these slugs first.

Available options:
email-work,
email-personal,
phone
Example:

Response

Successful response containing bulk redeem people status.

data
object | null

Response info depends on specific endpoint.