Update questionnaire instance

curl --request PUT \
  --url https://{your-prod-endpoint}/api/v1/questionnaire-status \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "questionnaireInstanceId": "<string>",
  "isReviewed": true,
  "score": 123
}
'

import requests

url = "https://{your-prod-endpoint}/api/v1/questionnaire-status"

payload = {
    "questionnaireInstanceId": "<string>",
    "isReviewed": True,
    "score": 123
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({questionnaireInstanceId: '<string>', isReviewed: true, score: 123})
};

fetch('https://{your-prod-endpoint}/api/v1/questionnaire-status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{your-prod-endpoint}/api/v1/questionnaire-status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'questionnaireInstanceId' => '<string>',
    'isReviewed' => true,
    'score' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{your-prod-endpoint}/api/v1/questionnaire-status"

	payload := strings.NewReader("{\n  \"questionnaireInstanceId\": \"<string>\",\n  \"isReviewed\": true,\n  \"score\": 123\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{your-prod-endpoint}/api/v1/questionnaire-status")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"questionnaireInstanceId\": \"<string>\",\n  \"isReviewed\": true,\n  \"score\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{your-prod-endpoint}/api/v1/questionnaire-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"questionnaireInstanceId\": \"<string>\",\n  \"isReviewed\": true,\n  \"score\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "message": "<string>",
    "instanceId": "<string>"
  }
}

{
  "status": "error",
  "code": 123,
  "error_code": "<string>",
  "message": "<string>"
}

PUT

api

questionnaire-status

Update questionnaire instance

curl --request PUT \
  --url https://{your-prod-endpoint}/api/v1/questionnaire-status \
  --header 'Content-Type: application/json' \
  --header 'X-Api-Key: <api-key>' \
  --data '
{
  "questionnaireInstanceId": "<string>",
  "isReviewed": true,
  "score": 123
}
'

import requests

url = "https://{your-prod-endpoint}/api/v1/questionnaire-status"

payload = {
    "questionnaireInstanceId": "<string>",
    "isReviewed": True,
    "score": 123
}
headers = {
    "X-Api-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {'X-Api-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({questionnaireInstanceId: '<string>', isReviewed: true, score: 123})
};

fetch('https://{your-prod-endpoint}/api/v1/questionnaire-status', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{your-prod-endpoint}/api/v1/questionnaire-status",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'questionnaireInstanceId' => '<string>',
    'isReviewed' => true,
    'score' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Api-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{your-prod-endpoint}/api/v1/questionnaire-status"

	payload := strings.NewReader("{\n  \"questionnaireInstanceId\": \"<string>\",\n  \"isReviewed\": true,\n  \"score\": 123\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("X-Api-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{your-prod-endpoint}/api/v1/questionnaire-status")
  .header("X-Api-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"questionnaireInstanceId\": \"<string>\",\n  \"isReviewed\": true,\n  \"score\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{your-prod-endpoint}/api/v1/questionnaire-status")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["X-Api-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"questionnaireInstanceId\": \"<string>\",\n  \"isReviewed\": true,\n  \"score\": 123\n}"

response = http.request(request)
puts response.read_body

{
  "success": true,
  "data": {
    "message": "<string>",
    "instanceId": "<string>"
  }
}

{
  "status": "error",
  "code": 123,
  "error_code": "<string>",
  "message": "<string>"
}

Authorizations

X-Api-Key

string

header

required

API Key provided by Omniloy. The same key is used for inbound and outbound calls.

Body

application/json

questionnaireInstanceId

string

required

status

enum<string>

Available options:

pending,

started,

completed,

rejected,

wrong_number,

call_failed,

canceled

isReviewed

boolean

score

number

Response

Instance updated

success

boolean

data

object

Show child attributes

Events & Integrations

API Reference

Update questionnaire instance

Authorizations

Body

Response