Skip to main content
PATCH
Rename an interview campaign

Authorizations

Authorization
string
header
required

Use Authorization: Bearer

Path Parameters

project_id
string<uuid>
required

UUID of the project

campaign_id
string<uuid>
required

UUID of the interview campaign

Body

application/json
name
string
required

New campaign name (trimmed; must be unique in the project)

Response

Campaign renamed

A named group of interviews (a "wave"), with the progress aggregates the interviews page renders. Counts cover every interview in the campaign.

id
string<uuid>
read-only
name
string

Unique within the project, case-insensitively.

created_at
string<date-time>
read-only
interview_count
integer
read-only

Total interviews in the campaign. May exceed the sum of the per-status counts: interviews created before statuses existed have none.

completed_count
integer
read-only
in_progress_count
integer
read-only
pending_count
integer
read-only

Assigned but not yet started.

latest_activity
string<date-time>
read-only

Most recent update across the campaign's interviews, falling back to the campaign's own creation date when it has none. Interview timestamps also move on background writes (summaries, turn state), so treat this as approximate activity rather than message recency.

assignees
string<email>[]
read-only

Up to five recipient emails, for the avatar row. Self-assigned interviews contribute their creator.

assignee_count
integer
read-only

Total distinct recipients, which may exceed assignees length.