Forsta Campaign Sends API

openapi: 3.2.0
info:
  title: Decipher Rest Campaign Sends API
  version: '1.0'
  description: The Decipher REST API allows comprehensive automation of your private or shared Decipher instance.
servers:
- url: https://{server}/api/v1
  description: Replace server with your instance domain.
  variables:
    server:
      default: selfserve.decipherinc.com
      description: Server domain
security:
- APIKey: []
tags:
- name: Campaign Sends
paths:
  /surveys/{survey}/campaigns/{campaign}/sends:
    get:
      operationId: getSurveyCampaignSends
      summary: Get sends
      description: Retrieve a list of sends for a specific campaign.
      tags:
      - Campaign Sends
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: campaign
        description: 'numeric campaign ID. The ID can be seen when editing the campaign or

          retrieved using the GET method above.

          '
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
    post:
      operationId: createSurveyCampaignSend
      summary: Create a send
      description: Start a send for a specific campaign.
      tags:
      - Campaign Sends
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: campaign
        description: 'numeric campaign ID. The ID can be seen when editing the campaign or

          retrieved using the GET method above.

          '
        in: path
        required: true
        schema:
          type: string
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                type:
                  description: send type
                  type: string
                  enum:
                  - seed
                  - soft
                  - rest
                count:
                  description: 'number for participants to send (defaults to soft send maximum

                    if not specified).

                    '
                  type: integer
                when:
                  description: 'scheduled time in epoch format (default delay will be used

                    if not specified).

                    '
                  type: string
                reminder:
                  description: 'indicate reminder sends. must be used with reminderFor (not

                    required for reminder seed sends)

                    '
                  type: boolean
                reminderFor:
                  description: 'list of valid send_id(s) of reminders to be sent

                    '
                  type: array
                  items:
                    type: integer
                filters:
                  description: 'filter sends by variables in survey or campaign email list

                    '
                  type: array
                  items:
                    type: object
                suppressionListId:
                  description: add suppression email list to the send
                  type: string
                fullThrottle:
                  description: setting true turns off email throttling entirely
                  type: boolean
              required:
              - type
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
  /surveys/{survey}/campaigns/{campaign}/sends/{send}:
    get:
      operationId: getSurveyCampaignSend
      summary: Get a send
      description: Retrieve a send for a specific campaign.
      tags:
      - Campaign Sends
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: campaign
        description: numeric campaign ID. The ID can be seen when editing the campaign or retrieved using the GET method above.
        in: path
        required: true
        schema:
          type: string
      - name: send
        description: numeric send ID. The ID can be seen when editing the send, or retrieved using the GET method above.
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: array
                items:
                  type: object
  /surveys/{survey}/campaigns/{campaign}/sends/{send}/cancel:
    post:
      operationId: createSurveyCampaignSendCancel
      summary: Cancel a send
      description: Cancel a send for a specific campaign.
      tags:
      - Campaign Sends
      parameters:
      - $ref: '#/components/parameters/survey'
      - name: campaign
        description: 'numeric campaign ID. The ID can be seen when editing the campaign or

          retrieved using the GET method above.

          '
        in: path
        required: true
        schema:
          type: string
      - name: send
        description: 'numeric send ID. The ID can be seen when editing the send, or

          retrieved using the GET method above.

          '
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  success:
                    type: boolean
components:
  parameters:
    survey:
      name: survey
      in: path
      required: true
      description: The survey path.
      example: selfserve/1a/123456
      schema:
        type: string
        format: uri
  securitySchemes:
    APIKey:
      type: apiKey
      in: header
      name: x-apikey
      description: 'In order to access the api, you''ll need to generate an API key. Refer to the

        instructions [here](/docs/decipher/api#section/API-Keys) to generate and

        configure an API key with the appropriate permission sets. You can generate

        as many keys as required.


        Configure each request to include your API key in the request header. For example:


        ```

        x-apikey: dp48ss3mgsaucyjtybxw728h7s4cgnwzhejtszdwhf4xpe8yhmtdwpk2ntdhtwbs

        ```

        '
x-tagGroups:
- name: Autoclose
  tags:
  - Autoclose
- name: Data Input and Output
  tags:
  - Data
  - Data Feed
  - Response Summary
  - Modifying Data
  - Datasources
  - Datasources Data
  - Umerge
- name: Survey Metadata
  tags:
  - Simulated Data
  - Survey State
  - Survey Evaluate
  - Survey Quotas
  - Survey Files
  - Survey Warnings
  - Survey Terms
  - Survey Subscribers
  - Survey Users
  - Survey Tasks
- name: Panels
  tags:
  - Panel Data
  - Panel Datapoints
  - Survey Panels
- name: Research Hub
  tags:
  - Users
  - Companies
  - Categories
  - Surveys
  - Panels
  - Crosstabs
  - Archives
  - Archival Reports
  - API Keys
  - Usage
  - Warnings Summary
- name: Crosstabs
  tags:
  - Crosstabs Configuration
  - Crosstabs Execution
  - Crosstabs Nets
  - Saved Crosstabs
  - Crosstabs Table Settings
  - Crosstabs Validation
  - Crosstabs Rim Weighting
- name: Dashboards
  tags:
  - Dashboards
- name: DQ APIs
  tags:
  - DQ-Specific API Calls
  - MaxDiff API Calls
  - Discrete Choice Model API Calls
  - Media Testimonial API Calls
- name: Response Summary
  tags:
  - Share Link
- name: Sample Management
  tags:
  - Bounced Emails
  - Participant Sources
- name: Distribution
  tags:
  - Email Distribution
  - SFTP Distribution
  - Slack Distribution
- name: Campaign Manager
  tags:
  - Campaigns
  - Campaign Email Invites
  - Campaign Exports
  - Campaign Lists
  - Shared Campaign Lists
  - Campaign Sends
  - Campaign Status Lists
  - Supression Lists
- name: Question Library
  tags:
  - Company Element
  - Company Elements
  - Survey Elements
  - Survey Element Report Settings
- name: Language Manager
  tags:
  - LM Application Data
  - LM Application Translations
  - Translation Resources
  - Translations
  - Translation Deltas
  - Translation Reservations
  - Primary Survey Language
  - Other Survey Languages
  - Unused Survey Languages
- name: Project Parameters
  tags:
  - Available Project Parameters
  - Saved Project Parameters
  - Project Parameters Configuration
- name: Multi-User Editing
  tags:
  - Available Sections
  - Check Out Section
  - Check In Section
  - Sync Section
  - Section Editor
  - Abandon Section
  - Validate Section
- name: Video Management
  tags:
  - Videos
  - Watermarked Videos
- name: Miscellaneous
  tags:
  - System Information
  - Logic Nodes
  - Logic Events
  - CATI
  - Global Search
  - Miscellaneous