discovery

Get roster quotes

Price adding customers to a Discovery campaign before adding them: how many are not on its roster yet, the conversations they bring every monthly refresh, their estimated cost at today's price (it accrues against the plan as they run; the add charges nothing), and Billing's refusal when it would not admit that work. Refused, as the add would be, on a campaign that is not active or paused, a one-time campaign whose run has finished, or one whose first run is still choosing its customers. id is the campaign's id or its campaign key.

get/api/v1/discovery/roster-quotes/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/discovery/roster-quotes/{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

idstring required

The Discovery campaign's id, or its campaign key.

Query parameters

customerIdsstring[] required

The customers' ids (1–1000)

Headers

Point11-Organizationstring uuid

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

Response

Success.

campaignIdstring uuid required
customerCountinteger required

Customers the add would put on the roster: those not on it already.

conversationsinteger required

Conversations they bring every monthly refresh.

Changes

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