Sonar Messages API

The Messages API from Sonar — 3 operation(s) for messages.

Operations 3

POST /v1/messages Send Message #
POST /v1/messages/doi_prompts Double Opt-In Prompt #
POST /v1/messages/{external_message_id}/tags Append Tag to An Existing Message #

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-messages-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-messages-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  title: Settings Messages API
  version: '1.0'
servers:
- url: https://www.sendsonar.com/api
security:
- sec0: []
  sec1: []
tags:
- name: Messages
paths:
  /v1/messages:
    post:
      summary: Send Message
      description: ''
      operationId: send-message
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - to
              properties:
                to:
                  type: string
                  description: The phone number of the person to whom you want to send an SMS.
                  default: '+13105551234'
                text:
                  type: string
                  description: The text of the SMS you want to send. Required unless `media_url` is provided
                media_url:
                  type: string
                  description: Url of image that you'd like to send as an MMS message OR VCF file you'd like to send along with the message. Required if `text` is not provided
                  default: http://images_website.com/some_url.png OR http://vcf_website.com/some_url.vcf
                tag_names:
                  type: array
                  description: List of tags you'd like to append to the message. All tags listed must already exist otherwise the message will not send.
                  items:
                    type: string
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  \"to\":\"+13105551234\",\n  \"text\":\"sent\",\n  \"status\": \"unsubscribed\"\n}"
              schema:
                type: object
                properties:
                  to:
                    type: string
                    example: '+13105551234'
                  text:
                    type: string
                    example: sent
                  status:
                    type: string
                    example: unsubscribed
        '202':
          description: '202'
          content:
            application/json:
              examples:
                Result:
                  value: '{

                    "to":"+13105551234",

                    "text":"Hello",

                    "tag_names":["attribution"],

                    "image_url":"http://images_website.com/some_url.png",

                    "status":"queued"

                    }'
              schema:
                type: object
                properties:
                  to:
                    type: string
                    example: '+13105551234'
                  text:
                    type: string
                    example: Hello
                  tag_names:
                    type: array
                    items:
                      type: string
                      example: attribution
                  image_url:
                    type: string
                    example: http://images_website.com/some_url.png
                  status:
                    type: string
                    example: queued
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{"error":"Tag with supplied name cannot be found, message not sent."}'
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Tag with supplied name cannot be found, message not sent.
      deprecated: false
      x-readme:
        code-samples:
        - language: curl
          code: "curl 'https://www.sendsonar.com/api/v1/messages' \\\n  -X POST \\\n  -H 'X-Token:XXXXXXXXXXXXXXXXXXXXXXXX' \\\n  -H \"Content-Type: application/json\" \\\n  -d '{\"to\": \"+13105551234\", \"text\": \"Hey there, how did you hear about us?\", \"tag_names\":[\"attribution\"], \"media_url\": \"http://images_website.com/some_url.png\"}'"
        samples-languages:
        - curl
      tags:
      - Messages
  /v1/messages/doi_prompts:
    post:
      summary: Double Opt-In Prompt
      description: ''
      operationId: double-opt-in-prompt
      parameters:
      - name: token
        in: header
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              required:
              - phone_number
              properties:
                phone_number:
                  type: string
                  description: The phone number of the customer you want to add. This is the unique identifier for a customer.
                  default: '+13105551234'
      responses:
        '400':
          description: '400'
          content:
            application/json:
              examples:
                Result:
                  value: '{}'
              schema:
                type: object
                properties: {}
      deprecated: false
      tags:
      - Messages
  /v1/messages/{external_message_id}/tags:
    post:
      summary: Append Tag to An Existing Message
      description: ''
      operationId: append-tag-to-message
      parameters:
      - name: external_message_id
        in: path
        description: the external_message_id can be found from our outbound, new assigned, and new unassigned webhook events.
        schema:
          type: string
        required: true
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                tag_name:
                  type: string
                  description: the name of the tag (unique)
      responses:
        '200':
          description: '200'
          content:
            application/json:
              examples:
                Result:
                  value: "{\n  'success':true, \n  'message':'Tag successfully added to message',\n  'external_message_id': 'AGjrndks=',\n  'external_tag_id': 'rjdSBE1'\n}"
        '404':
          description: '404'
          content:
            application/json:
              examples:
                Result:
                  value: '{"error": "Sorry, we couldn''t find a tag with that id."}'
              schema:
                type: object
                properties:
                  error:
                    type: string
                    example: Sorry, we couldn't find a tag with that id.
      deprecated: false
      tags:
      - Messages
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