Update an interview draft

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/"

payload = {
    "topic": "<string>",
    "interview_type": "interview",
    "questions": ["<string>"],
    "topics": [
        {
            "title": "<string>",
            "description": "<string>",
            "skill_id": "<string>"
        }
    ],
    "assignee_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "invite_emails": ["[email protected]"],
    "write_scope": "local",
    "focused_mode": False,
    "language": "<string>",
    "custom_message": "<string>",
    "scheduled_send_at": "2023-11-07T05:31:56Z",
    "reminders_enabled": False,
    "reminder_start_after_days": 2,
    "reminder_interval_days": 3,
    "reminder_max_count": 3,
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    topic: '<string>',
    interview_type: 'interview',
    questions: ['<string>'],
    topics: [{title: '<string>', description: '<string>', skill_id: '<string>'}],
    assignee_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    invite_emails: ['[email protected]'],
    write_scope: 'local',
    focused_mode: false,
    language: '<string>',
    custom_message: '<string>',
    scheduled_send_at: '2023-11-07T05:31:56Z',
    reminders_enabled: false,
    reminder_start_after_days: 2,
    reminder_interval_days: 3,
    reminder_max_count: 3,
    campaign_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    campaign_name: '<string>'
  })
};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PATCH \
  --url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topic": "<string>",
  "interview_type": "interview",
  "questions": [
    "<string>"
  ],
  "topics": [
    {
      "title": "<string>",
      "description": "<string>",
      "skill_id": "<string>"
    }
  ],
  "assignee_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "invite_emails": [
    "[email protected]"
  ],
  "write_scope": "local",
  "focused_mode": false,
  "language": "<string>",
  "custom_message": "<string>",
  "scheduled_send_at": "2023-11-07T05:31:56Z",
  "reminders_enabled": false,
  "reminder_start_after_days": 2,
  "reminder_interval_days": 3,
  "reminder_max_count": 3,
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_name": "<string>"
}
'

{
  "topic": "<string>",
  "interview_type": "interview",
  "questions": [
    "<string>"
  ],
  "topics": [
    {
      "title": "<string>",
      "description": "<string>",
      "skill_id": "<string>"
    }
  ],
  "assignee_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "invite_emails": [
    "[email protected]"
  ],
  "write_scope": "local",
  "focused_mode": false,
  "language": "<string>",
  "custom_message": "<string>",
  "scheduled_send_at": "2023-11-07T05:31:56Z",
  "reminders_enabled": false,
  "reminder_start_after_days": 2,
  "reminder_interval_days": 3,
  "reminder_max_count": 3,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_email": "[email protected]",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "User not found"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

PATCH

projects

{project_id}

interview-drafts

{draft_id}

Update an interview draft

import requests

url = "https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/"

payload = {
    "topic": "<string>",
    "interview_type": "interview",
    "questions": ["<string>"],
    "topics": [
        {
            "title": "<string>",
            "description": "<string>",
            "skill_id": "<string>"
        }
    ],
    "assignee_ids": ["3c90c3cc-0d44-4b50-8888-8dd25736052a"],
    "invite_emails": ["[email protected]"],
    "write_scope": "local",
    "focused_mode": False,
    "language": "<string>",
    "custom_message": "<string>",
    "scheduled_send_at": "2023-11-07T05:31:56Z",
    "reminders_enabled": False,
    "reminder_start_after_days": 2,
    "reminder_interval_days": 3,
    "reminder_max_count": 3,
    "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "campaign_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    topic: '<string>',
    interview_type: 'interview',
    questions: ['<string>'],
    topics: [{title: '<string>', description: '<string>', skill_id: '<string>'}],
    assignee_ids: ['3c90c3cc-0d44-4b50-8888-8dd25736052a'],
    invite_emails: ['[email protected]'],
    write_scope: 'local',
    focused_mode: false,
    language: '<string>',
    custom_message: '<string>',
    scheduled_send_at: '2023-11-07T05:31:56Z',
    reminders_enabled: false,
    reminder_start_after_days: 2,
    reminder_interval_days: 3,
    reminder_max_count: 3,
    campaign_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    campaign_name: '<string>'
  })
};

fetch('https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

curl --request PATCH \
  --url https://eu.app.clarifeye.ai/api/v1/projects/{project_id}/interview-drafts/{draft_id}/ \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "topic": "<string>",
  "interview_type": "interview",
  "questions": [
    "<string>"
  ],
  "topics": [
    {
      "title": "<string>",
      "description": "<string>",
      "skill_id": "<string>"
    }
  ],
  "assignee_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "invite_emails": [
    "[email protected]"
  ],
  "write_scope": "local",
  "focused_mode": false,
  "language": "<string>",
  "custom_message": "<string>",
  "scheduled_send_at": "2023-11-07T05:31:56Z",
  "reminders_enabled": false,
  "reminder_start_after_days": 2,
  "reminder_interval_days": 3,
  "reminder_max_count": 3,
  "campaign_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "campaign_name": "<string>"
}
'

{
  "topic": "<string>",
  "interview_type": "interview",
  "questions": [
    "<string>"
  ],
  "topics": [
    {
      "title": "<string>",
      "description": "<string>",
      "skill_id": "<string>"
    }
  ],
  "assignee_ids": [
    "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  ],
  "invite_emails": [
    "[email protected]"
  ],
  "write_scope": "local",
  "focused_mode": false,
  "language": "<string>",
  "custom_message": "<string>",
  "scheduled_send_at": "2023-11-07T05:31:56Z",
  "reminders_enabled": false,
  "reminder_start_after_days": 2,
  "reminder_interval_days": 3,
  "reminder_max_count": 3,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "campaign": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>"
  },
  "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "created_by_email": "[email protected]",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

{
  "error": "User not found"
}

{
  "error": "Authentication credentials were not provided."
}

{
  "error": "You do not have permission to perform this action."
}

{
  "error": "Not found."
}

Authorizations

Authorization

string

header

required

Use Authorization: Bearer

Path Parameters

project_id

string<uuid>

required

UUID of the project

draft_id

string<uuid>

required

UUID of the interview draft

Body

application/json

Writable fields of an interview draft. Everything is optional — drafts are deliberately permissive and only sending (assign with draft_id) enforces the real assignment rules.

topic

string

The interview focus. When set, a short title is generated from it.

interview_type

enum<string>

default:interview

Which conversation type the draft fans out to when sent. Set at creation (form type cards, or the scoping conversation's draft tool) and immutable afterwards — updates that change it are rejected (400).

Available options:

interview,

guided-interview

questions

string[]

Optional specific topics or questions (max 10). Rejected on guided-interview drafts — their topics structure the conversation.

topics

object[]

Guided drafts only (rejected otherwise): the ordered, editable topics the interview walks through (max 12). The scoping conversation's draft tool pre-seeds them from the standard guide.

Show child attributes

assignee_ids

string<uuid>[]

UUIDs of project members to interview. May go stale; re-validated at send.

invite_emails

string<email>[]

Emails of people not yet on the project. Nobody is contacted until the draft is sent.

write_scope

enum<string>

default:local

Available options:

local,

global

focused_mode

boolean

default:false

Simplified interview: recipients open the distraction-free full-page chat instead of the app. Best for external or mobile respondents.

language

string | null

ISO language code (e.g. fr) the interviews created from this draft must be conducted in. Null (the default) adapts to each recipient's own preferred language. Unknown codes are rejected (400).

custom_message

string

Optional note replacing the default invitation email copy.

scheduled_send_at

string<date-time> | null

reminders_enabled

boolean

default:false

reminder_start_after_days

integer

default:2

Required range: 1 <= x <= 30

reminder_interval_days

integer

default:3

Required range: 1 <= x <= 30

reminder_max_count

integer

default:3

Required range: 1 <= x <= 10

campaign_id

string<uuid> | null

write-only

Existing campaign (of the same project) to group the draft's interviews under; null removes the draft from its campaign. Wins over campaign_name when both are sent.

campaign_name

string

write-only

Campaign to group the draft's interviews under, by name: reuses the project's campaign with that name (case-insensitive) or creates it.

Response

Draft updated

A saved, unsent interview-assignment payload. Becomes one interview per recipient when sent via the assign endpoint (with draft_id), which also deletes the draft.

topic

string

The interview focus. When set, a short title is generated from it.

interview_type

enum<string>

default:interview

Available options:

interview,

guided-interview

questions

string[]

Optional specific topics or questions (max 10). Rejected on guided-interview drafts — their topics structure the conversation.

topics

object[]

Guided drafts only (rejected otherwise): the ordered, editable topics the interview walks through (max 12). The scoping conversation's draft tool pre-seeds them from the standard guide.

Show child attributes

assignee_ids

string<uuid>[]

UUIDs of project members to interview. May go stale; re-validated at send.

invite_emails

string<email>[]

Emails of people not yet on the project. Nobody is contacted until the draft is sent.

write_scope

enum<string>

default:local

Available options:

local,

global

focused_mode

boolean

default:false

Simplified interview: recipients open the distraction-free full-page chat instead of the app. Best for external or mobile respondents.

language

string | null

ISO language code (e.g. fr) the interviews created from this draft must be conducted in. Null (the default) adapts to each recipient's own preferred language. Unknown codes are rejected (400).

custom_message

string

Optional note replacing the default invitation email copy.

scheduled_send_at

string<date-time> | null

reminders_enabled

boolean

default:false

reminder_start_after_days

integer

default:2

Required range: 1 <= x <= 30

reminder_interval_days

integer

default:3

Required range: 1 <= x <= 30

reminder_max_count

integer

default:3

Required range: 1 <= x <= 10

string<uuid>

read-only

name

string

read-only

Title generated from the topic at save time; empty when the draft has no topic (clients show "Untitled draft interview").

campaign

object | null

Campaign the interviews created from this draft will belong to; null when none. Set via campaign_id / campaign_name.

Show child attributes

created_by

string<uuid> | null

read-only

created_by_email

string<email> | null

read-only

created_at

string<date-time>

read-only

updated_at

string<date-time>

read-only

Delete an interview draft Duplicate an interview draft

Concepts

Endpoints

Update an interview draft

Authorizations

Path Parameters

Body

Response