Partner API changelog

Every change to the partner API, newest first. Paths are relative to /api/v1/channel. A date is the day the change entered the API.

API reference

  • Added
    • GET /usage

    What this key used of the AI tools, with the share of its daily allowance.

  • Added
    • POST /templates

    Create a reusable template from questions and publish it to a workspace.

  • Changed
    • GET /orgs
    • GET /webhooks

    Lists are cursor-paged. Every operation and webhook event now carries a stability label (stable, experimental or coming soon).

  • Added
    • DELETE /test-data

    Delete a workspace's test data.

  • Changed
    • POST /webhooks
    • PATCH /webhooks/{id}

    A webhook can subscribe only to documented event types; any other value is refused with a validation error that names the allowed values.

  • Changed
    • GET /campaigns/{id}/results

    Results carry aggregates only, with no verbatim quotes.

  • Added
    • GET /devices

    The workspace's app devices, cursor-paged. Never an email or phone number.

  • Added
    • GET /campaigns/{id}/installs

    App installs registered against a campaign, cursor-paged.

  • Added
    • POST /campaigns/{id}/exports
    • GET /exports/{id}
    • GET /downloads/{token}/{filename}

    Request a campaign export as JSON or PDF, poll its status, and download it through a signed link that expires.

  • Added
    • POST /orgs

    Create the workspace for one of your own clients, idempotent on your own reference.

  • Added
    • POST /launch

    Mint a one-time link for one respondent session, carrying your own context.

  • Added
    • GET /webhooks
    • POST /webhooks
    • GET /webhooks/{id}
    • PATCH /webhooks/{id}
    • DELETE /webhooks/{id}
    • POST /webhooks/{id}/simulate
    • GET /webhooks/{id}/deliveries
    • GET /openapi.json

    Manage webhook subscriptions, send a test delivery, read the delivery trail, and fetch the OpenAPI document.

  • Added
    • GET /orgs

    Which workspaces this key may act on.

  • Added
    • POST /campaigns
    • POST /campaigns/{id}/respondents
    • POST /campaigns/{id}/launch
    • GET /campaigns/{id}
    • GET /campaigns/{id}/results

    Provision a campaign, attach an audience, go live, read status, and read aggregate results.

  • Added
    • GET /whoami

    The calling key's own identity: the first call any integration makes.