openapi: 3.2.0
info:
  title: Decipher Rest Survey Subscribers 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: Survey Subscribers
paths:
  /surveys/{survey}/subscribers:
    post:
      operationId: addSurveySubscribers
      summary: Add Survey Subscribers
      description: Subscribe users to a project by email address.
      tags:
      - Survey Subscribers
      parameters:
      - $ref: '#/components/parameters/survey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  description: List of user emails to be added as subscribers.
                  type: array
                  items:
                    type: string
                    format: email address
              required:
              - emails
              example:
                emails:
                - gooduser1@decipherinc.com
                - gooduser2@decipherinc.com
                - baduser1@decipherinc.com
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  total_added:
                    type: integer
                    description: number of subscriber emails added
                  errors:
                    type: array
                    description: list of unadded emails and reason
                    items:
                      type: object
                      properties:
                        details:
                          type: string
                          description: the reason for failure to add
                        email:
                          type: string
                          format: email
                          description: the email that could not be added
              example:
                total_added: 2
                errors:
                - details: user must be active and have permission to view the project
                  email: baduser1@decipherinc.com
    delete:
      operationId: removeSurveySubscribers
      summary: Remove Survey Subscribers
      description: Unsubscribe users from a survey by email address.
      tags:
      - Survey Subscribers
      parameters:
      - $ref: '#/components/parameters/survey'
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                emails:
                  description: List of user emails to be removed from survey subscribers.
                  type: array
                  items:
                    type: string
                    format: email address
              required:
              - emails
              example:
                emails:
                - gooduser1@decipherinc.com
                - gooduser2@decipherinc.com
                - baduser1@decipherinc.com
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
    get:
      operationId: getSurveySubscribers
      summary: Get Survey Subscribers
      description: List of emails belonging to users subscribed to a survey.
      tags:
      - Survey Subscribers
      parameters:
      - $ref: '#/components/parameters/survey'
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  subscribers:
                    type: array
                    description: list of emails with timestamp
                    items:
                      type: object
                      properties:
                        date_added:
                          type: string
                          format: date-time
                          description: date when the user was subscribed to the survey
                        email:
                          type: string
                          format: email
                          description: email address of the user subscribed to the survey
              example:
                subscribers:
                - date_added: '2022-03-08T22:23:06Z'
                  email: user@example.com
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