Skip to main content
PATCH
Change a question

Authorizations

Authorization
string
header
required

An API key from Settings, API keys. It starts with rc_live_.

Path Parameters

id
string<uuid>
required

The form's record ID.

fieldId
string
required

The question's record ID.

Body

application/json

Send at least one field.

label
string

Cannot be empty. Anything past 200 characters is cut off.

help_text
string | null

Anything past 500 characters is cut off. Null or an empty string removes it.

required
boolean
section
string | null

The heading it sits under. Null or an empty string takes it out of its section, which is refused with 400 while the form is shown as tabs. Cut to 80 characters.

show_when
string | null

Ask it only when this yes/no question on the same form is Yes; null or an empty string asks it always. Refused with 400 for a question that is not yes/no, itself, or itself asked only when another is Yes, and for a field other questions wait for.

Response

The question, as it now is.

field
object
required

One question on a form.