Skip to main content
PATCH
Update requirement

Authorizations

api_access_token
string
header
required

Path Parameters

id
integer
required

ID of the requirement

account_id
integer
required

The numeric ID of the account

Body

application/json
requirement
object
required

Response

Success

category
string

Public category resolved by the account country catalog; display labels are localized by the client.

id
integer
display_id
integer
account_id
integer
requirement_type
string
status
string
priority
string
source
string
title
string
description
string | null
responsible_party
string | null
tenant_share_percent
integer | null

The tenant's percentage (1-99) of a shared cost; the landlord's part is its complement. Set only while responsible_party is shared.

approval_status
string | null
approval_forced
boolean

The operator demanded the owner's authorization on top of the type's threshold. It can be switched on and never back off.

cost_estimate
number | null
classification
object

Per-type terms decided at triage beyond responsible_party and cost_estimate (custom_attributes.classification). Keys vary by type — e.g. payment_reason, property_tenancy_id, billing_cycle_id, termination_cause, delivery_date, termination_amount, document_kind, complaint_target, complaint_merit, complaint_response.

property_id
integer | null
conversation_id
integer | null
assignee_id
integer | null
reporter_contact_id
integer | null
duplicate_of_id
integer | null
approval_required
boolean

Whether the spend needs the owner's authorization, either because approval_forced is on or because the estimated cost reaches the type's threshold.

sign_off_required
boolean
owner_portal_enabled
boolean

Detail only. Whether the account's owners decide from the owner portal.

classification_editable
boolean

Detail only. Whether the classification (cost_estimate, responsible_party, tenant_share_percent, requirement_type, approval_forced) can still be corrected through update. True while the requirement is received or triaged and the owner has not approved the spend.

approval_requested_at
string | null

Detail only. When the requirement last moved into pending_approval.

classification_options
object[]

Detail only. Every type the requirement may be classified as, grouped under its public category in pack order. Display labels are localized by the client.

created_at
string
updated_at
string