Update Response

Update an existing response for example when you want to mark a response as finished or you want to change an existing response’s value. Note - Environments are deprecated. Use Workspace/workspaceId terminology.

PUT /client/{workspaceId}/responses/{responseId}

Update Response

cURL

curl --request PUT \
  --url https://app.formbricks.com/api/v2/client/{workspaceId}/responses/{responseId} \
  --header 'Content-Type: application/json' \
  --data '
{
  "data": {
    "tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?"
  },
  "finished": true
}
'

import requests

url = "https://app.formbricks.com/api/v2/client/{workspaceId}/responses/{responseId}"

payload = {
    "data": { "tcgls0063n8ri7dtrbnepcmz": "Who? Who? Who?" },
    "finished": True
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({data: {tcgls0063n8ri7dtrbnepcmz: 'Who? Who? Who?'}, finished: true})
};

fetch('https://app.formbricks.com/api/v2/client/{workspaceId}/responses/{responseId}', 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://app.formbricks.com/api/v2/client/{workspaceId}/responses/{responseId}",
  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([
    'data' => [
        'tcgls0063n8ri7dtrbnepcmz' => 'Who? Who? Who?'
    ],
    'finished' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$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://app.formbricks.com/api/v2/client/{workspaceId}/responses/{responseId}"

	payload := strings.NewReader("{\n  \"data\": {\n    \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n  },\n  \"finished\": true\n}")

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

	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://app.formbricks.com/api/v2/client/{workspaceId}/responses/{responseId}")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n  },\n  \"finished\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.formbricks.com/api/v2/client/{workspaceId}/responses/{responseId}")

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

request = Net::HTTP::Put.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"tcgls0063n8ri7dtrbnepcmz\": \"Who? Who? Who?\"\n  },\n  \"finished\": true\n}"

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

200

{
  "data": {}
}

{
  "code": "not_found",
  "details": {
    "resource_type": "Response"
  },
  "message": "Response not found"
}

Path Parameters

workspaceId · string · required

The ID of the Workspace. Deprecated alias environmentId.

responseId · string · required

Body

application/json

The body is of type object.

Response

200

application/json

OK

The response is of type object.