campaigns

Get calendars

Read the organization's commercial calendar (id "organization") at one zoom level (day, week, month or agenda around anchor, bucketed in timeZone): its active and paused campaigns of every product (at most 50; truncated when more exist), each shown campaign's UTC months with exact hourly counts and a few named customer interactions, the campaigns whose read failed, every interaction of customerId when given, and the entry to open on (entryCampaignId with entryId). The organization's own id is also accepted as id.

get/api/v1/campaigns/calendars/{id}

Request

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

Always "organization"; the organization's own id is also accepted.

Query parameters

view'day' | 'week' | 'month' | 'agenda' required
anchorstring required

The day the grid is drawn around, on timeZone's clock.

timeZonestring required

The zone days and hours are bucketed in.

defaultTimeZonestring

The zone a viewer's choice replaces; timeZone when absent.

productsstring[]

Keep only these products' campaigns; none keeps every product.

profilesstring[]

Keep only these business profiles' campaigns; none keeps every profile.

hiddenCampaignIdsstring[]

Campaigns listed but switched off: never read.

customerIdstring uuid

Read every interaction of this customer.

onlyboolean

With customerId: draw only that customer, so months name nobody.

entryCampaignIdstring uuid

With entryId: the campaign of the entry the calendar opens on.

entryIdstring

With entryCampaignId: the entry the calendar opens on, read whatever showPaused says.

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.

truncatedboolean required
subscriptionPausedboolean required

Changes

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