campaigns

Search calendar candidates

Search by name the customers a campaign could still admit and schedule from the calendar; empty for a product that schedules nothing by hand. Each search is charged to the caller's calendar search burst budget, shared with campaigns_calendars_search (429 RATE_LIMITED past it). A campaign that is unknown, another organization's, or not on the calendar (only active and paused campaigns are) is 404 RESOURCE_NOT_FOUND with details.resource "campaign" for every product, where a product that schedules nothing by hand once answered an empty list.

get/api/v1/campaigns/calendar-candidates/search

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/campaigns/calendar-candidates/search
  • 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

campaignType'discovery' | 'research' | 'experience' required
campaignIdstring uuid required
querystring required

Headers

Point11-Organizationstring uuid

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

Response

Success.

Changes

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