Sign in

v3

latestSwagger 2.02026-08-067506752.0 MB
question

Update an existing question

patch/v1/org/{orgId}/question/{questionId}

Path parameters

orgIdstring required

Org identifier (either id or slug)

questionIdstring required

Question id

Request body

questionstring

text of the question

fieldIdstring

if the question is linked to a field, the id of that field. Any question responses will be automatically saved to the field

type'ADDRESS' | 'AUDIO' | 'BOOLEAN' | 'COMP' | 'COMPOUND' | 'COMP_BAND' | 'CONTACTS' | 'CURRENCY' | 'DATE' | 'DECIMAL' | 'ELAPSED_DAYS' | 'ELAPSED_MONTHS' | 'ELAPSED_YEARS' | 'EMAIL' | 'ENUM' | 'ENUM_EXPR' | 'ENUM_MULTI' | 'ENUM_SCALE' | 'EXPR' | 'FILE' | 'GROUP' | 'GROUPS' | 'GROUP_ASSIGNMENTS' | 'GROUP_TYPE' | 'GROUP_POSITION_ASSIGNMENTS' | 'IMAGE' | 'INTEGER' | 'JOB' | 'JOB_CODE' | 'JOBS' | 'JOB_TIER' | 'LIST' | 'MAP' | 'MONEY' | 'NAME' | 'OBJECT' | 'PAY_INTERVAL' | 'PERCENT' | 'PERSON' | 'PERSONS' | 'PHONE' | 'STOCKGRANT' | 'STRING' | 'TABLE_REF' | 'TEXT' | 'TIMEOFF' | 'TIMESTAMP' | 'TRACKED_GROUP' | 'URL' | 'USER' | 'VARIABLE_COMP' | 'VARIABLE_COMPS'

datatype of the question

plural'SINGLE' | 'LIST' | 'SET'

plural type of the question datatype (either SINGLE, LIST, or SET)

placesinteger

number of decimal places for numeric values

Example request

{
  "question": "What is your favorite color?",
  "fieldId": "588f7ee98f138b19220041a7",
  "values": [
    {
      "id": "588f7ee98f138b19220041a7"
    }
  ]
}

Response

question updated