Sonar Campaigns API

The Campaigns API from Sonar — 2 operation(s) for campaigns.

Operations 2

POST /v1/campaigns Send Campaign #
POST /v1/campaigns/send_personalized_campaign Send Personalized Campaign #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/sendsonar-com:sendsonar-com-campaigns-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

sendsonar-com-campaigns-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Settings Campaigns API
  version: '1.0'
servers:
- url: https://www.sendsonar.com/api
security:
- sec0: []
  sec1: []
tags:
- name: Campaigns
paths:
  /v1/campaigns:
    post:
      summary: Send Campaign
      description: ''
      operationId: send-campaign
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - campaign_id
              - to
              properties:
                campaign_id:
                  type: string
                  description: The campaign_id or "slug" can be found in the <a href="http://docs.sendsonar.com/docs/campaigns#define" target="_blank">Define</a> tab of the specific campaign you're trying to send.
                  default: test_campaign_CxkoWx
                to:
                  type: string
                  description: The phone number of the person to whom you want to send the Campaign.
                  default: '+13105551234'
                send_at:
                  type: string
                  description: 'Timestamp in the format: ISO-8601 to schedule a campaign to go out in the future.'
      responses:
        '202':
          description: '202'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"to\":\"+13105551234\",\n  \"text\":\"This is a test message.\",\n  \"status\":\"queued\",\n  \"step_variant_id\": 2\n}"
              schema:
                type: object
                properties:
                  to:
                    type: string
                    example: '+13105551234'
                  text:
                    type: string
                    example: This is a test message.
                  status:
                    type: string
                    example: queued
                  step_variant_id:
                    type: integer
                    example: 2
                    default: 0
        '400':
          description: '400'
          content:
            application/json:
              examples:
                No Campaign Id:
                  value: "{\n    \"error\": \"Campaign not found with slug: \"\n}"
                No To Number:
                  value: "{\n    \"error\": \"Invalid Phone Number\"\n}"
              schema:
                oneOf:
                - title: No Campaign Id
                  type: object
                  properties:
                    error:
                      type: string
                      example: 'Campaign not found with slug: '
                - title: No To Number
                  type: object
                  properties:
                    error:
                      type: string
                      example: Invalid Phone Number
        '401':
          description: '401'
          content:
            application/json:
              examples:
                Unauthorized:
                  value: "{\n    \"error\": \"Token or publishable_key not found\"\n}"
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Token or publishable_key not found
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl 'https://www.sendsonar.com/api/v1/campaigns' \\\n\t-X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"campaign_id\": \"XXXXXXXX_XXXX_XXXX\", \"to\": \"+13105551234\"}'"
        samples-languages:
        - curl
      tags:
      - Campaigns
  /v1/campaigns/send_personalized_campaign:
    post:
      summary: Send Personalized Campaign
      description: ''
      operationId: personalized-campaign
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - campaign_id
              - to
              properties:
                campaign_id:
                  type: string
                  description: Campaign slug from edit campaign page
                to:
                  type: string
                  description: The number of the customer to send the campaign to
                first_name:
                  type: string
                  description: The customer's first name
                last_name:
                  type: string
                  description: The customer's last name
                timezone:
                  type: string
                  description: The customer's time zone
                zipcode:
                  type: string
                  description: The customer's zipcode
                customer_properties:
                  type: object
                  description: Custom properties to add to the customer. Can be used in the campaign message
                  properties: {}
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"to\":\"+13105551234\",\n  \"text\":\"sent\",\n  \"status\":\"queued\",\n  \"step_variant_id\": \"2\"\n}"
              schema:
                type: object
                properties:
                  to:
                    type: string
                    example: '+13105551234'
                  text:
                    type: string
                    example: sent
                  status:
                    type: string
                    example: queued
                  step_variant_id:
                    type: string
                    example: '2'
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl 'https://www.sendsonar.com/api/v1/campaigns/send_personalized_campaign' \\\n  -X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"campaign_id\": \"MyCampaign_123abc\", \"to\": \"+13105551234\", \"first_name\": \"John\", \"last_name\": \"Wayne\", \"customer_properties\": {\"preferred_greeting\": \"Howdy!\"}'"
        samples-languages:
        - curl
      tags:
      - Campaigns
components:
  securitySchemes:
    sec0:
      type: apiKey
      name: X-Token
      in: header
      x-default: ''
    sec1:
      type: apiKey
      name: token
      in: query
      x-default: ''
x-readme-fauxas: true
x-provenance:
  method: searched
  source: https://docs.sendsonar.com/reference
  harvested: '2026-10-25'
  tool: harvest-readme-openapi.py
  note: Assembled verbatim from the OpenAPI definition ReadMe embeds in each operation page of the provider's developer portal; paths and components merged by API title, nothing authored.
  assembled_from:
  - https://docs.sendsonar.com/reference/addupdate-customer.md
  - https://docs.sendsonar.com/reference/append-tag-to-message.md
  - https://docs.sendsonar.com/reference/available-phone-number.md
  - https://docs.sendsonar.com/reference/close-customer.md
  - https://docs.sendsonar.com/reference/create-new-role-permission.md
  - https://docs.sendsonar.com/reference/create-new-sonar-account.md
  - https://docs.sendsonar.com/reference/create-webhook.md
  - https://docs.sendsonar.com/reference/delete-customer-properties.md
  - https://docs.sendsonar.com/reference/delete-webhooks.md
  - https://docs.sendsonar.com/reference/double-opt-in-prompt.md
  - https://docs.sendsonar.com/reference/events.md
  - https://docs.sendsonar.com/reference/follow-up-endpoint.md
  - https://docs.sendsonar.com/reference/gdpr-delete-request.md
  - https://docs.sendsonar.com/reference/gdpr-get-request.md
  - https://docs.sendsonar.com/reference/get-account-roles.md
  - https://docs.sendsonar.com/reference/get-all-users-from-account.md
  - https://docs.sendsonar.com/reference/get-conversation-by-id.md
  - https://docs.sendsonar.com/reference/get-customer.md
  - https://docs.sendsonar.com/reference/get-specific-user-by-id.md
  - https://docs.sendsonar.com/reference/get-webhook.md
  - https://docs.sendsonar.com/reference/invite-new-user.md
  - https://docs.sendsonar.com/reference/personalized-campaign.md
  - https://docs.sendsonar.com/reference/remove-follow-up.md
  - https://docs.sendsonar.com/reference/send-campaign.md
  - https://docs.sendsonar.com/reference/send-message.md
  - https://docs.sendsonar.com/reference/unassign-agent.md
  - https://docs.sendsonar.com/reference/update-webhook.md
  merge:
    pages: 27
    deduped: 52
    conflicts_kept_first: 0