campaigns

Get campaign routes

Get the Discovery, Experience or Research campaign a route key names (its campaignKey, or its id), narrowly: its id, route key, product, name and lifecycle status, even while it is archived or still being set up. Pass settings: true to also get what its settings page decides by: its website, schedule, work counted by its entries, and setup readiness, as campaigns_summaries_get_v2 states them. A key the organization holds no campaign under is not found. Read its saved setup with its product's campaign-settings read, and its full list row with campaigns_summaries_get_v2.

get/api/v1/campaigns/campaign-routes/{id}

Request

  • Base URL: https://point11.ai
  • URL: https://point11.ai/api/v1/campaigns/campaign-routes/{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 campaign's id, or its route key (campaignKey).

Query parameters

settingsboolean

true also answers the campaign's website, schedule, work and setup readiness (settings); omit it for the campaign alone.

Headers

Point11-Organizationstring uuid

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

Response

Success.

idstring required
campaignKeystring nullable required
product'discovery' | 'research' | 'experience' required
namestring required
status'active' | 'paused' | 'archived' | 'deleted' required

Changes

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