e-satisfaction API v3.2
  1. Questionnaire Instances
e-satisfaction API v3.2
  • Introduction
  • Applications
    • Get all applications
      GET
  • Questionnaires
    • Get all questionnaires
      GET
    • Get Questionnaire
      GET
  • Questionnaire Groups
    • Get all questionnaire groups
      GET
  • Questions
    • Get all group questions
      GET
    • Get Question Response Content
      GET
  • Questionnaire Instances
    • Create new questionnaire instance
      POST
    • Get Questionnaire Instance List by questionnaire id
      GET
    • Get Questionnaire Value List by questionnaire id
      GET
    • Get Questionnaire Value List by instance id
      GET
    • Get Responder Value List by questionnaire id
      GET
    • Get Responder Value List by responder id
      GET
  • Questionnaire Instances - Simplified
    • Get Questionnaire Instance
      GET
    • Update Questionnaire Instance
      PATCH
    • Delete Questionnaire Instance
      DELETE
    • Get Questionnaire Instance Url
      GET
    • Get Questionnaire Instance Content
      GET
    • Get Questionnaire Instance Response Content
      GET
  • Pipelines
    • Get all questionnaire pipelines
      GET
    • Get Pipeline
      GET
  • Queue
    • Create new queue item
      POST
    • Get Queue Item
      GET
    • Update Queue Item
      PATCH
    • Delete Queue Item
      DELETE
  • Queue - Simplified
    • Get Queue Item
    • Update Queue Item
    • Delete Queue Item
  • Alerts
    • Get all alerts
  • Alert Instance
    • Get all alert instances
    • Alert Instance List by monitor id Info
    • Get Alert Instance
  • Alert Statuses
    • Get all alert statuses
  • Schemas
    • User
    • Organization
    • Organization Billing
    • Application Type
    • Application Type Content
    • Application
    • Application Get List Request
    • Application Pager
    • Application Billing
    • Campaign Type
    • Questionnaire
    • Questionnaire Get List Request
    • Questionnaire Pager
    • Questionnaire Content
    • Questionnaire Group
    • Questionnaire Group Content
    • Question Type
    • Question
    • Question Content
    • Question Value
    • Question Value Content
    • Question Instance Response Content
    • Questionnaire Instance
    • Questionnaire Instance Request
    • Questionnaire Instance Content
    • Questionnaire Instance Response Content
    • Questionnaire Instance Get List Request
    • Questionnaire Instance Pager
    • Questionnaire Metadata Values Get List Request
    • Questionnaire Metadata Values Pager
    • Responder Metadata Values Get List Request
    • Responder Metadata Values Pager
    • Questionnaire Theme
    • Questionnaire Integration
    • Pipeline
    • Queue Item
    • Queue Item Request
    • Queue Item Metadata Request
    • Metadata Value
    • Alert
    • Alert Instance
    • Alert Instance Get List Request
    • Alert Status Get List Request
    • Alert Instance Pager
    • Alert Status Pager
    • FilterBy
    • Filter By Criteria
    • OrderBy
    • Order By Criteria
    • Pagination
    • Error
  1. Questionnaire Instances

Create new questionnaire instance

POST
/q/questionnaire/{questionnaire_id}/instance
Token scope Questionnaire Instance.Create

Request

Path Params

Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Successful Response
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.e-satisfaction.com/v3.2/q/questionnaire//instance' \
--header 'Content-Type: application/json' \
--data-raw '{
    "responder_id": "UBWI8fpmQRKifDN7OBooSw",
    "locale": "en",
    "valid_days": 30,
    "editable": true,
    "metadata": {
        "q_meta_name1": "q_meta_value1",
        "q_meta_name2": "q_meta_value2"
    }
}'
Response Response Example
{
    "instance_id": "IVWKHAmTuKMpft2YOGvmw",
    "questionnaire_id": "Oy45QZZCQByX9Fm41IMxyw",
    "responder_id": "UBWI8fpmQRKifDN7OBooSw",
    "locale": "en-us",
    "valid_days": 30,
    "editable": true,
    "desktop_collapsed": true,
    "non_collapsed_questions_count": 1,
    "questionnaire_icon_url": null,
    "key_question_id": null,
    "credits_accountable": true,
    "finalized": false,
    "created_time": "2018-01-01T00:00:00+03:00",
    "updated_time": "2018-01-01T00:00:00+03:00",
    "sent_time": null,
    "delivered_time": null,
    "viewed_time": null,
    "submitted_time": null,
    "completed_time": null,
    "collection_url": "http://collection.e-satisfaction.com/questionnaire/desktop/IVWKHAmTuKMpft2YOGvmw"
}
Modified at 2026-02-05 12:36:40
Previous
Get Question Response Content
Next
Get Questionnaire Instance List by questionnaire id
Built with