business

Get campaign customer pools

Read which of a business profile's customers a new campaign can draw from (id "organization"): name the profile by businessProfileId, or pass url to find the active profile for that website. Answers the profile, whether it has a current forecast, how many customers can join, and each audience and source with its count; a profile that cannot launch campaigns answers no profile.

get/api/v1/business/campaign-customer-pools/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/business/campaign-customer-pools/{id}
  • 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)

Path parameters

id'organization' required

The literal "organization".

Query parameters

businessProfileIdstring uuid

The business profile.

urlstring

Without businessProfileId: the website whose active profile to read.

includeStoreCustomersboolean

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

Headers

Point11-Organizationstring uuid

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

Response

Success.

businessProfileIdstring uuid nullable required

Null when no profile can launch.

hasForecastboolean required
allEligibleCountinteger required

Changes

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