Skip to main content
PATCH
Update Spec

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

spec_id
string
required

Body

application/json

Schema for updating a spec.

acceptance_criteria
string[] | null
api_contracts
ApiContract · object[] | null
assignee_id
string | null
business_rules
BusinessRule · object[] | null
context
string | null
decisions
Decision · object[] | null
description
string | null
functional_requirements
string[] | null
ideation_id
string | null
labels
string[] | null
refinement_id
string | null
screen_mockups
ScreenMockup · object[] | null
skip_decisions_coverage
boolean | null
skip_rules_coverage
boolean | null
skip_test_coverage
boolean | null
skip_trs_coverage
boolean | null
technical_requirements
(string | object)[] | null
test_scenarios
TestScenario · object[] | null
title
string | null
Required string length: 1 - 500

Response

Successful Response

Schema for full spec response.

acceptance_criteria
string[] | null
required
assignee_id
string | null
required
board_id
string
required
context
string | null
required
created_at
string<date-time>
required
created_by
string
required
description
string | null
required
functional_requirements
string[] | null
required
id
string
required
labels
string[] | null
required
status
enum<string>
required

Spec lifecycle status.

Available options:
draft,
review,
approved,
validated,
in_progress,
done,
cancelled
technical_requirements
(string | object)[] | null
required
title
string
required
updated_at
string<date-time>
required
version
integer
required
api_contracts
ApiContract · object[] | null
architecture_designs
ArchitectureDesignSummary · object[]
archived
boolean
default:false
business_rules
BusinessRule · object[] | null
cards
CardSummaryForSpec · object[]
decisions
Decision · object[] | null
ideation_id
string | null
knowledge_bases
SpecKnowledgeSummary · object[]
pre_archive_status
string | null
qa_items
SpecQAResponse · object[]
refinement_id
string | null
screen_mockups
ScreenMockup · object[] | null
skip_contract_coverage
boolean
default:false
skip_decisions_coverage
boolean
default:false
skip_rules_coverage
boolean
default:false
skip_test_coverage
boolean
default:false
skip_trs_coverage
boolean
default:false
test_scenarios
TestScenario · object[] | null
Last modified on May 17, 2026