wakato-io Audiences API

openapi: 3.2.0
info:
  title: Wakato Space Audiences API
  version: 1.0.0
  description: 'The **Wakato Space API** lets an external agent or tool (Claude Code, Cursor,

    Zapier, a partner integration, your own scripts) operate a single Wakato

    **Space** using a scoped Bearer token (a *Space API key*, `wks_live_…`).


    The **same token** works two ways:

    - **REST** — the endpoints documented here (`/functions/v1/space-api/…`).

    - **MCP** — a Model Context Protocol server at `/functions/v1/space-mcp`

    that exposes the same operations as tools to MCP clients. MCP clients

    self-discover the tools via `tools/list`; see the Quickstart to connect.


    ### Authentication

    Send the key as a Bearer token: `Authorization: Bearer wks_live_…`.

    A key is locked to exactly one Space and cannot read or write any other

    Space, the wallet (beyond read), member permissions, or other users.


    ### Scopes

    Every key grants per-domain scopes with up to three actions:

    - `read` — list / inspect

    - `write` — create / edit

    - `run` — the *consequential* action (publish a page, send an SMS, post

    socially, run an automation). Public/billable actions are deliberately

    split into `run` so you grant them explicitly.


    Each operation below notes its required scope via `x-required-scope`.

    A call without the scope returns `403`.


    ### Safety model

    - Wallet, Finance, Integrations are **read-only**. Money is never moved.

    - Secrets returns **names only** — values are never exposed.

    - Social posts and ad campaigns default to **drafts**; going live requires

    the `run` scope. Connecting new OAuth accounts is never done by a key.'
servers:
- url: https://api.wakato.io/functions/v1/space-api
  description: Production
- url: https://pnwxrleocjbcvrrwrycq.supabase.co/functions/v1/space-api
  description: Development
security:
- bearerAuth: []
tags:
- name: Audiences
  description: Saved segments (lists) of your **Contacts**, used to target campaigns and messages across any channel. Audiences are part of Contacts (managed at `/spaces/:spaceId/contacts/audiences`) — not a separate system. Each audience is simply a named group of contacts.
paths:
  /audiences:
    get:
      tags:
      - Audiences
      summary: List audiences
      x-required-scope: contacts:read
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `contacts:read`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X GET \"https://api.wakato.io/functions/v1/space-api/audiences\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\""
      operationId: getAudiences
      x-operation-id-source: derived
    post:
      tags:
      - Audiences
      summary: Create a static (list) audience
      x-required-scope: contacts:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                description:
                  type: string
                contact_ids:
                  type: array
                  items:
                    type: string
      responses:
        '201':
          $ref: '#/components/responses/Created'
      description: '**Required scope:** `contacts:write`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X POST \"https://api.wakato.io/functions/v1/space-api/audiences\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"name\": \"Launch plan\"\n}'"
      operationId: postAudiences
      x-operation-id-source: derived
  /audiences/{id}:
    patch:
      tags:
      - Audiences
      summary: Rename an audience or add/remove member contacts
      x-required-scope: contacts:write
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                name:
                  type: string
                description:
                  type: string
                add_contact_ids:
                  type: array
                  items:
                    type: string
                remove_contact_ids:
                  type: array
                  items:
                    type: string
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `contacts:write`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X PATCH \"https://api.wakato.io/functions/v1/space-api/audiences/b7e4a1c2-9d3f-4e8a-b2c1-5f6d7e8a9b0c\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{}'"
      operationId: patchAudiencesById
      x-operation-id-source: derived
components:
  responses:
    Ok:
      description: Success
      content:
        application/json:
          schema:
            type: object
    Created:
      description: Created
      content:
        application/json:
          schema:
            type: object
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: A Space API key, e.g. `wks_live_…`.