Clarity

Clarity Scheduled Email Sends API

The scheduled_email_sends API from Clarity — 4 operation(s) for scheduled_email_sends.

GitHub OpenAPI

Operations 7

GET /api/v1/scheduled-email-sends List Scheduled Email Sends #
POST /api/v1/scheduled-email-sends Create Scheduled Email Send #
GET /api/v1/scheduled-email-sends/{scheduled_email_send_id} Get Scheduled Email Send #
PATCH /api/v1/scheduled-email-sends/{scheduled_email_send_id} Update Scheduled Email Send #
DELETE /api/v1/scheduled-email-sends/{scheduled_email_send_id} Cancel Scheduled Email Send #
POST /api/v1/scheduled-email-sends/{scheduled_email_send_id}/enable Enable Scheduled Email Send #
POST /api/v1/scheduled-email-sends/{scheduled_email_send_id}/disable Disable Scheduled Email Send #

Specifications

⚙
OpenAPI
https://artifacts.apis.io/onclarity-com/openapi/onclarity-com-scheduled-email-sends-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-dashboard-element-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-build-table-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-update-dashboard-element-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-admin-deeper-search-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-src-routers-admin-admin-search-request-schema.json
📊
JSONSchema
https://artifacts.apis.io/onclarity-com/json-schema/onclarity-com-agent-response-schema.json

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/onclarity-com:onclarity-com-scheduled-email-sends-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.

GitHub Google LinkedIn

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

OpenAPI Specification

onclarity-com-scheduled-email-sends-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Fast Scheduled Email Sends API
  version: 0.1.0
tags:
- name: scheduled_email_sends
paths:
  /api/v1/scheduled-email-sends:
    get:
      tags:
      - scheduled_email_sends
      summary: List Scheduled Email Sends
      description: List the current project's scheduled email sends (newest first).
      operationId: list_scheduled_email_sends_api_v1_scheduled_email_sends_get
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
      security:
      - HTTPBearer: []
    post:
      tags:
      - scheduled_email_sends
      summary: Create Scheduled Email Send
      description: Create a scheduled or recurring survey email send and its Cloud Scheduler/Tasks job.
      operationId: create_scheduled_email_send_api_v1_scheduled_email_sends_post
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateScheduledEmailSendRequest'
        required: true
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
      - HTTPBearer: []
  /api/v1/scheduled-email-sends/{scheduled_email_send_id}:
    get:
      tags:
      - scheduled_email_sends
      summary: Get Scheduled Email Send
      description: Get a single scheduled email send by id.
      operationId: get_scheduled_email_send_api_v1_scheduled_email_sends__scheduled_email_send_id__get
      security:
      - HTTPBearer: []
      parameters:
      - name: scheduled_email_send_id
        in: path
        required: true
        schema:
          type: string
          title: Scheduled Email Send Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    patch:
      tags:
      - scheduled_email_sends
      summary: Update Scheduled Email Send
      description: Update a scheduled email send, syncing its Cloud Scheduler/Tasks job if changed.
      operationId: update_scheduled_email_send_api_v1_scheduled_email_sends__scheduled_email_send_id__patch
      security:
      - HTTPBearer: []
      parameters:
      - name: scheduled_email_send_id
        in: path
        required: true
        schema:
          type: string
          title: Scheduled Email Send Id
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UpdateScheduledEmailSendRequest'
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
    delete:
      tags:
      - scheduled_email_sends
      summary: Cancel Scheduled Email Send
      description: 'Cancel a scheduled email send: delete its Cloud Scheduler/Tasks job + mark cancelled.'
      operationId: cancel_scheduled_email_send_api_v1_scheduled_email_sends__scheduled_email_send_id__delete
      security:
      - HTTPBearer: []
      parameters:
      - name: scheduled_email_send_id
        in: path
        required: true
        schema:
          type: string
          title: Scheduled Email Send Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/scheduled-email-sends/{scheduled_email_send_id}/enable:
    post:
      tags:
      - scheduled_email_sends
      summary: Enable Scheduled Email Send
      description: Resume a paused schedule.
      operationId: enable_scheduled_email_send_api_v1_scheduled_email_sends__scheduled_email_send_id__enable_post
      security:
      - HTTPBearer: []
      parameters:
      - name: scheduled_email_send_id
        in: path
        required: true
        schema:
          type: string
          title: Scheduled Email Send Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /api/v1/scheduled-email-sends/{scheduled_email_send_id}/disable:
    post:
      tags:
      - scheduled_email_sends
      summary: Disable Scheduled Email Send
      description: Pause a schedule (no sends until re-enabled).
      operationId: disable_scheduled_email_send_api_v1_scheduled_email_sends__scheduled_email_send_id__disable_post
      security:
      - HTTPBearer: []
      parameters:
      - name: scheduled_email_send_id
        in: path
        required: true
        schema:
          type: string
          title: Scheduled Email Send Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema: {}
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    RecipientModel:
      properties:
        email:
          type: string
          pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
          title: Email
        attributes:
          anyOf:
          - additionalProperties:
              type: string
            type: object
          - type: 'null'
          title: Attributes
      type: object
      required:
      - email
      title: RecipientModel
    CreateScheduledEmailSendRequest:
      properties:
        anecdote_survey_id:
          type: integer
          title: Anecdote Survey Id
        sender:
          type: string
          pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
          title: Sender
        schedule_expression:
          type: string
          title: Schedule Expression
        schedule_timezone:
          type: string
          title: Schedule Timezone
          default: UTC
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        subject:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject
        template_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Template Id
        contact_list_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact List Id
        recipients:
          anyOf:
          - items:
              $ref: '#/components/schemas/RecipientModel'
            type: array
          - type: 'null'
          title: Recipients
        is_recurring:
          type: boolean
          title: Is Recurring
          default: false
      type: object
      required:
      - anecdote_survey_id
      - sender
      - schedule_expression
      title: CreateScheduledEmailSendRequest
    UpdateScheduledEmailSendRequest:
      properties:
        name:
          anyOf:
          - type: string
          - type: 'null'
          title: Name
        sender:
          anyOf:
          - type: string
            pattern: ^[a-zA-Z0-9_.+-]+@[a-zA-Z0-9-]+\.[a-zA-Z0-9-.]+$
          - type: 'null'
          title: Sender
        subject:
          anyOf:
          - type: string
          - type: 'null'
          title: Subject
        template_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Template Id
        contact_list_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Contact List Id
        recipients:
          anyOf:
          - items:
              $ref: '#/components/schemas/RecipientModel'
            type: array
          - type: 'null'
          title: Recipients
        schedule_expression:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Expression
        schedule_timezone:
          anyOf:
          - type: string
          - type: 'null'
          title: Schedule Timezone
      type: object
      title: UpdateScheduledEmailSendRequest
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer
    HTTPBasic:
      type: http
      scheme: basic