Stop Study

curl --request POST \
  --url https://api.userintuition.ai/api/public/v1/studies/{study_id}/stop \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.userintuition.ai/api/public/v1/studies/{study_id}/stop"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)

const options = {method: 'POST', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.userintuition.ai/api/public/v1/studies/{study_id}/stop', 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://api.userintuition.ai/api/public/v1/studies/{study_id}/stop",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.userintuition.ai/api/public/v1/studies/{study_id}/stop"

	req, _ := http.NewRequest("POST", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.userintuition.ai/api/public/v1/studies/{study_id}/stop")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.userintuition.ai/api/public/v1/studies/{study_id}/stop")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "id": "<string>",
  "study_type": "in-depth-interview",
  "provisioning_status": "draft",
  "fielding_status": "not_started",
  "name": "<string>",
  "use_case": "<string>",
  "recruiting_method": "panel",
  "interview_format": "chat",
  "voice": "male",
  "language": "<string>",
  "expected_duration_seconds": 900,
  "byop_config": {
    "incentive_amount": 123,
    "is_incentives_enabled": true,
    "auto_send_incentives": true
  },
  "study_link": "<string>",
  "dashboard_url": "<string>",
  "missing_requirements": [
    "<string>"
  ],
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "interview_count": 123,
  "report_status": "available",
  "study_plan": {
    "objectives": "<string>",
    "conversation_flow": "<string>",
    "background": "<string>",
    "learning_goals": "<string>",
    "learning_goals_structured": [
      {
        "id": "<string>",
        "question": "<string>",
        "evidence_needed": "<string>"
      }
    ],
    "study_specific_rules": "<string>",
    "study_improvements": "<string>"
  },
  "screener_questions": [
    {
      "id": "<string>",
      "text": "<string>",
      "type": "single_select",
      "order": 123,
      "options": [
        {
          "id": "<string>",
          "text": "<string>",
          "disqualify": true,
          "selection_rule": "must_select"
        }
      ],
      "input_mode": "integers_only",
      "numeric_ranges": [
        {
          "min": 1,
          "max": 1
        }
      ]
    }
  ],
  "targeting_attributes": [
    {
      "qualification_id": 123,
      "allowed_options": [
        123
      ],
      "disallowed_options": [
        123
      ]
    }
  ],
  "resolved_targeting": [
    {
      "qualification_id": 123,
      "attribute": "<string>",
      "active": true,
      "include": [
        "<string>"
      ],
      "exclude": [
        "<string>"
      ],
      "applies_to": "panel",
      "approximation_note": "<string>"
    }
  ],
  "concept_links": [
    {
      "id": "<string>",
      "url": "<string>",
      "label": "<string>",
      "embeddable": true
    }
  ],
  "concept_images": [
    {
      "id": "<string>",
      "url": "<string>",
      "label": "<string>"
    }
  ],
  "invitation_count": 123,
  "interview_attempt_count": 123,
  "quality_interview_count": 123
}

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}

{
  "detail": "<unknown>",
  "error": {
    "code": "<string>",
    "message": "<string>",
    "field": "<string>",
    "request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "outcome": "not_started",
    "recovery_action": "<string>",
    "docs_url": "<string>"
  }
}