Forsta Email Distribution API

openapi: 3.2.0
info:
  title: Decipher Rest Email Distribution 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: Email Distribution
paths:
  /distribute/email:
    post:
      operationId: createDistributeEmail
      summary: Send API to Email
      description: 'This meta-API call requires you to specify another API call as input,

        although you can also omit the sub-calls and send an email with subject

        and body of your choosing.


        You can specify any number of API calls that generate attachments (i.e.

        non-JSON output). Some useful calls are:


        * saved crosstabs export

        * datamap

        * data out


        **Acceptable Use Policy**: all recipients must have given opt-in to

        receive the emails you sent. You may contact solely your business associates,

        i.e. not invite survey participants.'
      tags:
      - Email Distribution
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                sources:
                  description: 'any number of API data sources to call to get the data. Note that

                    URL arguments must be passed via args only.

                    '
                  type: array
                  items:
                    type: object
                    properties:
                      api:
                        type: string
                        description: the path of the api to call
                        example: /api/v1/surveys/your/survey/datamap
                      args:
                        type: object
                        description: arguments to pass to the api call
                      method:
                        type: string
                        description: the http method to use
                        default: GET
                recipients:
                  description: list of email addresses to send this to
                  type: array
                  items:
                    type: string
                    format: email address
                subject:
                  description: the subject of the email that will be sent out
                  type: string
                sender:
                  description: 'the name that will appear as sender. Defaults to the full name of

                    the account behind the API key

                    '
                  type: string
                body:
                  description: message to put in the body. HTML capable.
                  type: string
                colors:
                  description: set of colors to override the default email template.
                  type: object
                  properties:
                    linkTextColor:
                      type: string
                      format: css color
                      example: '#E15603'
                    emailBackgroundColor:
                      type: string
                      format: css color
                      example: '#2A4068'
                    emailForegroundColor:
                      type: string
                      format: css color
                      example: '#FFFFFF'
                    emailContentAlignment:
                      type: string
                      example: center
                    emailPageColor:
                      type: string
                      format: css color
                      example: '#FFFFFF'
                    linkButtonColor:
                      type: string
                      format: css color
                      example: '#5B9FFFF'
                    linkButtonTextColor:
                      type: string
                      format: css color
                      example: '#EDF8FF'
                    defaultTextColor:
                      type: string
                      format: css color
                      example: '#333'
              required:
              - sources
              - recipients
              - subject
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
components:
  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