wakato-io Phone API

openapi: 3.2.0
info:
  title: Wakato Space Phone 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: Phone
paths:
  /phone/numbers:
    get:
      tags:
      - Phone
      summary: List phone numbers
      x-required-scope: phone:read
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `phone:read`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X GET \"https://api.wakato.io/functions/v1/space-api/phone/numbers\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\""
      operationId: getPhoneNumbers
      x-operation-id-source: derived
  /phone/calls:
    get:
      tags:
      - Phone
      summary: List call history
      x-required-scope: phone:read
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `phone:read`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X GET \"https://api.wakato.io/functions/v1/space-api/phone/calls\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\""
      operationId: getPhoneCalls
      x-operation-id-source: derived
  /phone/sms:
    post:
      tags:
      - Phone
      summary: Send an SMS (consequential, billable)
      x-required-scope: phone:run
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - to
              - message
              properties:
                to:
                  type: string
                  description: E.164
                message:
                  type: string
                from:
                  type: string
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `phone:run`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X POST \"https://api.wakato.io/functions/v1/space-api/phone/sms\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"to\": \"example\",\n  \"message\": \"example\"\n}'"
      operationId: postPhoneSms
      x-operation-id-source: derived
  /phone/campaigns:
    get:
      tags:
      - Phone
      summary: List SMS campaigns
      x-required-scope: phone:read
      parameters:
      - in: query
        name: status
        schema:
          type: string
      - in: query
        name: limit
        schema:
          type: integer
          default: 50
          maximum: 200
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `phone:read`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X GET \"https://api.wakato.io/functions/v1/space-api/phone/campaigns\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\""
      operationId: getPhoneCampaigns
      x-operation-id-source: derived
    post:
      tags:
      - Phone
      summary: Create a DRAFT SMS campaign (broadcast or drip)
      description: '**Required scope:** `phone:write`


        Drafting never requires a connected phone number — the sender defaults to the space''s first SMS-capable number when one exists, else stays null until set. Sending is a separate run-scoped action.'
      x-required-scope: phone:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              properties:
                name:
                  type: string
                campaign_type:
                  type: string
                  enum:
                  - broadcast
                  - drip
                  default: broadcast
                body:
                  type: string
                  description: Broadcast body; supports {{merge_tags}}
                from_phone_number_id:
                  type: string
                audience_id:
                  type: string
                enrollment_mode:
                  type: string
                  enum:
                  - one_shot
                  - continuous
                trigger_audience_id:
                  type: string
                opt_out_footer:
                  type: boolean
                  default: true
                steps:
                  type: array
                  description: Drip steps in order
                  items:
                    type: object
                    required:
                    - body
                    properties:
                      delay_minutes:
                        type: integer
                      body:
                        type: string
      responses:
        '201':
          $ref: '#/components/responses/Created'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X POST \"https://api.wakato.io/functions/v1/space-api/phone/campaigns\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"name\": \"Launch plan\"\n}'"
      operationId: postPhoneCampaigns
      x-operation-id-source: derived
  /phone/campaigns/{id}:
    parameters:
    - in: path
      name: id
      required: true
      schema:
        type: string
    get:
      tags:
      - Phone
      summary: Get an SMS campaign (incl. drip steps)
      x-required-scope: phone:read
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `phone:read`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X GET \"https://api.wakato.io/functions/v1/space-api/phone/campaigns/b7e4a1c2-9d3f-4e8a-b2c1-5f6d7e8a9b0c\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\""
      operationId: getPhoneCampaignsById
      x-operation-id-source: derived
    patch:
      tags:
      - Phone
      summary: Update a draft/paused/scheduled SMS campaign
      description: '**Required scope:** `phone:write`


        Passing steps REPLACES all drip steps.'
      x-required-scope: phone:write
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X PATCH \"https://api.wakato.io/functions/v1/space-api/phone/campaigns/b7e4a1c2-9d3f-4e8a-b2c1-5f6d7e8a9b0c\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{}'"
      operationId: patchPhoneCampaignsById
      x-operation-id-source: derived
  /phone/campaigns/{id}/send:
    post:
      tags:
      - Phone
      summary: Send/start an SMS campaign (consequential, billable)
      description: '**Required scope:** `phone:run`


        Broadcast: schedules the send (scheduled_at defaults to now); the scheduler delivers it. Drip: starts the sequence. Requires a sender number, an audience, and message content.'
      x-required-scope: phone:run
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                scheduled_at:
                  type: string
                  description: ISO; omit to send ASAP
      responses:
        '202':
          $ref: '#/components/responses/Ok'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X POST \"https://api.wakato.io/functions/v1/space-api/phone/campaigns/b7e4a1c2-9d3f-4e8a-b2c1-5f6d7e8a9b0c/send\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{}'"
      operationId: postPhoneCampaignsByIdSend
      x-operation-id-source: derived
  /phone/templates:
    get:
      tags:
      - Phone
      summary: List SMS templates
      x-required-scope: phone:read
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `phone:read`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X GET \"https://api.wakato.io/functions/v1/space-api/phone/templates\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\""
      operationId: getPhoneTemplates
      x-operation-id-source: derived
    post:
      tags:
      - Phone
      summary: Create an SMS template
      x-required-scope: phone:write
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - name
              - body
              properties:
                name:
                  type: string
                body:
                  type: string
                  description: Supports {{merge_tags}}
                variables:
                  type: array
                  items:
                    type: object
      responses:
        '201':
          $ref: '#/components/responses/Created'
      description: '**Required scope:** `phone:write`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X POST \"https://api.wakato.io/functions/v1/space-api/phone/templates\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\n  \"name\": \"Launch plan\",\n  \"body\": \"example\"\n}'"
      operationId: postPhoneTemplates
      x-operation-id-source: derived
  /phone/templates/{id}:
    patch:
      tags:
      - Phone
      summary: Update an SMS template
      x-required-scope: phone:write
      parameters:
      - in: path
        name: id
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
      responses:
        '200':
          $ref: '#/components/responses/Ok'
      description: '**Required scope:** `phone:write`'
      x-codeSamples:
      - lang: bash
        label: cURL
        source: "curl -X PATCH \"https://api.wakato.io/functions/v1/space-api/phone/templates/b7e4a1c2-9d3f-4e8a-b2c1-5f6d7e8a9b0c\" \\\n  -H \"Authorization: Bearer wks_live_YOUR_TOKEN\" \\\n  -H \"Content-Type: application/json\" \\\n  -d '{}'"
      operationId: patchPhoneTemplatesById
      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_…`.