business

List campaign pool customers (v3)

Page through the customers a new campaign on a business profile can pick, searched by name or job title and narrowed to audiences: each with its table attributes under the customer model's keys (a category, band, Product and Buyer type as id and label), its audiences, place, and why it cannot join when includeIneligible lists those too. customerIds pages only those customers instead, each without a reason. selectedAudienceIds also answers every customer in those audiences, across every page. Page with nextCursor at the same limit.

get/api/v1/business/campaign-pool-customers-v3

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/campaign-pool-customers-v3
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://auth.point11.ai/oauth2/authorize, token URL https://auth.point11.ai/oauth2/token)

Query parameters

limitinteger

Number of customers to return (1–100)

cursorstring

Opaque cursor returned as nextCursor by the previous page

businessProfileIdstring uuid required

The business profile.

searchstring

Words in a name or job title.

audienceIdsstring[]

Narrow to these audiences.

selectedAudienceIdsstring[]

Also answer every customer in these audiences as selectedCustomerIds.

customerIdsstring[]

Page only these customers (a campaign's hand-picked ones); they name no cohort, so each is listed without a reason.

includeIneligibleboolean

Also list the customers the pick cannot take, after the rest.

includeStoreCustomersboolean

Also admit the profile's store customers, as a Research campaign does.

filtersstring[]

Field conditions, each <field>:<operator>:<value>. Text fields (location, employer, trigger) take contains, does_not_contain, is or starts_with and the words. Number fields (age, householdIncome, companySize, annualRevenue) take gt, gte, lt, lte or eq and a number, or between and min..max. Classification fields, each band under its fact's key as <key>.band (gender, age.band, language, market, areaType, education, lifeStage, householdIncome.band, occupation, seniority, companySize.band, buyerType, audience, product, channel, buyerRole, intentStage, job, triggerType), take is_any_of or is_none_of and comma-separated ids from business_customer_filter_options_get_v2 (buyerType takes consumer or organization), none for a customer with no value. createdAt takes on_or_after or on_or_before and an ISO date, or between and from..to, read in UTC.

filterMatch'all' | 'any'

Whether a customer matches every condition (all, the default) or any one

Headers

Point11-Organizationstring uuid

Organization to act in. Required for OAuth bearers; an API key acts in the organization that owns it.

Response

Success.

nextCursorstring nullable required
totalCountinteger required
ineligibleCountinteger required

Customers the search keeps that the pick cannot take, listed or not.

selectedCustomerIdsstring[] required
audienceTypesstring[] required

The audience types of the customers this list draws from, each read as a Buyer type (b2c is B2C; b2b, prosumer and mixed are B2B); a column only another Buyer type carries is not a column.

Changes

No recorded changes to this operation across all 1 revision of this API.