Questionnaire Requests
post/api/questionnaires/{shortcode}/complete

Request

  • Base URL: https://api.openintake.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.openintake.ai/api/questionnaires/{shortcode}/complete
  • Auth: none declared

Path parameters

shortcodestring required

Request body

revisioninteger required

Response

Successful Response

status'active' | 'completed' | 'expired' | 'revoked' required
revisioninteger required
customer_namestring required
recipient_namestring nullable
accent_colorstring required
logo_urlstring nullable
page_titlestring
subtitlestring
completion_titlestring
completion_messagestring
review_before_completionboolean
expires_atstring date-time required
is_testboolean required
case_type_idinteger nullable
intro_summarystring nullable
adaptive_enabledboolean
adaptive_readyboolean
adaptive_processingboolean
adaptive_language'en' | 'es' nullable
adaptive_remaining_countinteger
inferred_field_idsinteger[]

Changes

    • breaking

      response property questions/items/value list-of-types was widened by adding types array to media type application/json of response 200

    • warning

      added the new multi_select enum value to the // response property for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property to the response with the status

    • info

      the response's property default value changed from The team can review your answers. You can close this page. to The team will review your answers and follow up with you as soon as possible. You can close this page. for the status

    • info

      added the optional property to the response with the status