Skip to main content
PATCH
Update a Consultation Question

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string
required

Question ID from this school.

Body

application/json
title
string

Question title, up to 120 characters. Cannot be blank.

Maximum string length: 120
body
string

Question body as HTML or plain text. Cannot be empty. Embedded attachments and scripts are not supported.

Maximum string length: 200000
category_id
string

Published consultation category ID. A question assigned to a meeting must stay in that meeting's category.

Required string length: 1 - 255
tag_ids
string[]

Existing consultation tag IDs from your school. Omit to keep current tags or use [] to clear them.

Maximum array length: 100
Required string length: 1 - 255
treated_at
string<date-time> | null

Treatment date with a timezone in RFC 3339 format. Requires a question assigned to a meeting. Omit to keep the date or use null to clear it. Cannot be empty.

is_ready
boolean

Response

Successful response.

id
string
required
title
string
required
category_id
string
required
author_id
string | null
required
author_type
string | null
required
treated_at
string<date-time> | null
required
is_ready
boolean
required
created_at
string<date-time>
required
body
string
required

Question body as HTML.

tag_ids
string[]
required