campaigns

Search calendar windows

Read the scheduled customer interactions of up to 50 campaigns between two instants at most 48 hours apart, in one request: each campaign's lifecycle counts and at most 500 named interactions (entryCount says how many there are), in the calendar's order. Only the organization's active and paused campaigns are read, whichever ids are named; failed counts campaigns whose read failed, and the request fails when every read did.

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

Request

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

campaignIdsstring[] required

The campaigns the calendar shows; each is read through its own product.

fromstring date-time required
tostring date-time required
showPausedboolean

False leaves out paused activity: the work a paused campaign holds and will not start while it stays paused (a waiting interaction, or a Research interview its run has committed), from every count and name. Finished, failed, missed and started work always stays, and so does the work of an Active campaign whose subscription is paused. True when absent.

Headers

Point11-Organizationstring uuid

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

Response

Success.

failedinteger required

Campaigns whose read failed; the others still answered.

Changes

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