API V2

Questions keyboard_arrow_down

Put /surveys/{{survey-id}}/questions/{{question-id}}

Example Request

https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/questions/{{question-id}}

The value of environment {{env}} variable depends upon your datacenter. Refer to the Environment page for more details.


Authorization

arrow_rightSecurity - API Key
Name : api-key
required
Location : Request Header
Type : string

Request Parameters

arrow_rightPath Parameters
survey-id integer
required
question-id integer
required

Request Body

arrow_rightPayload
application/json 

                        {
                          "type": "multiplechoice_maps",
                          "text": "What state were you born in?",
                          "code": "Q18",
                          "required": false,
                          "selectedCountry": "USA"
                        }

Example Code

arrow_rightcURL
Snippet copied successfully.
application/json 

curl --location --request PUT 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/questions/{{question-id}}' \
--header 'Content-Type: application/json' \
--header 'api-key: {{api-key}}' \
--data '
	{
	  "type": "multiplechoice_maps",
	  "text": "What state were you born in?",
	  "code": "Q18",
	  "required": false,
	  "selectedCountry": "USA"
	}'
arrow_rightPython
Snippet copied successfully.
application/json 

import requests
import json

url = "https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/questions/{{question-id}}"

payload = json.dumps({
  "type": "multiplechoice_maps",
  "text": "What state were you born in?",
  "code": "Q18",
  "required": False,
  "selectedCountry": "USA"
})
headers = {
  'Content-Type': 'application/json',
  'api-key': '{{api-key}}'
}

response = requests.request("PUT", url, headers=headers, data=payload)

print(response.text)
arrow_rightPHP - cURL
Snippet copied successfully.
application/json 

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.questionpro.{{env}}/a/api/v2/surveys/{{survey-id}}/questions/{{question-id}}',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'PUT',
  CURLOPT_POSTFIELDS =>'
	{
	  "type": "multiplechoice_maps",
	  "text": "What state were you born in?",
	  "code": "Q18",
	  "required": false,
	  "selectedCountry": "USA"
	}',
  CURLOPT_HTTPHEADER => array(
    'Content-Type: application/json',
    'api-key: {{api-key}}'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Responses

arrow_rightExample
application/json 

                            {
                                "response": {
                                    "questionID": 86065875,
                                    "blockID": 123456,
                                    "type": "multiplechoice_radio",
                                    "text": "What is your favorite color?",
                                    "code": "Q1",
                                    "orderNumber": 2,
                                    "required": false,
                                    "answers": [
                                        {
                                            "answerID": 462071199,
                                            "text": "Red",
                                            "excludeRandomization": false
                                        },
                                        {
                                            "answerID": 462071200,
                                            "text": "Blue",
                                            "excludeRandomization": false
                                        },
                                        {
                                            "answerID": 462071201,
                                            "text": "Green",
                                            "excludeRandomization": false
                                        },
                                        {
                                            "answerID": 462071202,
                                            "text": "Black",
                                            "excludeRandomization": false
                                        }
                                    ]
                                },
                            "requestID": "9012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
                            }
arrow_rightSchema
application/json 

                            {
                                "response": {
                                    "questionID": 86065875,
                                    "blockID": 123456,
                                    "type": "multiplechoice_radio",
                                    "text": "What is your favorite color?",
                                    "code": "Q1",
                                    "orderNumber": 2,
                                    "required": false,
                                    "answers": [
                                        {
                                            "answerID": 462071199,
                                            "text": "Red",
                                            "excludeRandomization": false
                                        },
                                        {
                                            "answerID": 462071200,
                                            "text": "Blue",
                                            "excludeRandomization": false
                                        },
                                        {
                                            "answerID": 462071201,
                                            "text": "Green",
                                            "excludeRandomization": false
                                        },
                                        {
                                            "answerID": 462071202,
                                            "text": "Black",
                                            "excludeRandomization": false
                                        }
                                    ]
                                },
                            "requestID": "9012fedc-e8ce-48ae-b800-6q5ce287987a7dje"
                            }
arrow_right400 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "BAD_REQUEST",
         "httpStatusCode": 400,
         "id" : "1000",
         "message": "Invalid URL parameters",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right401 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "UNAUTHORIZED",
         "httpStatusCode": 401,
         "id" : "1010",
         "message": "Incorrect API Key",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right403 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "FORBIDDEN",
         "httpStatusCode": 403,
         "id" : "1013",
         "message": "The user does not have permission to access the resource",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right404 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "NOT_FOUND",
         "httpStatusCode": 404,
         "id" : "1040",
         "message": "The resource that you're trying to access doesn't exist",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}
arrow_right500 example
application/json

{
    "response": {
     "error": {
         "docs": www.questionpro.com/api/error-codes.html
         "name": "INTERNAL_SERVER_ERROR",
         "httpStatusCode": 500,
         "id" : "1026",
         "message": "We are not able to process your request",
         "resourceUrl":"resource_url"
        }
    }
}
arrow_rightSchema
application/json

{
  "$schema": "http://json-schema.org/draft-06/schema#                                 ",
  "type": "object",
  "properties": {
    "response": {
      "type": "object",
      "properties": {
        "error": {
          "type": "object",
          "properties": {
            "docs": {
              "type": "string"
            },
            "resourceUrl": {
              "type": "string"
            },
            "name": {
              "type": "string"
            },
            "id": {
              "type": "string"
            },
            "message": {
              "type": "string"
            },
            "httpStatusCode": {
              "type": "integer"
            }
          },
          "additionalProperties": false,
          "required": [
            "docs",
            "resourceUrl",
            "name",
            "id",
            "message",
            "httpStatusCode"
          ]
        }
      },
      "additionalProperties": false,
      "required": [
        "error"
      ]
    }
  },
  "additionalProperties": false,
  "required": [
    "response"
  ]
}