This resource represents a relationships between a recipient and a Form. This is a strict 1 <> 1 relationship. For example, a Client can only be asked to complete a Form once.

Properties

This resources uses all common resource properties except items.

formID string
The ID of the associated Form that needs a response from the recipient

clientId string (optional)
The ID of the Client that this form is assigned to

responseStatus string
The status of the resource, one of PENDING, or COMPLETED. When a response has been requested it will first show as PENDING. When the recipient has answered all inputs in the form the status will be show as COMPLETED.

items array(InputResponse)
The response for each input in the form. This will contain a list of all the inputs that are present on the Form resource at the time this Form Response resource is created. If the form is updated after it is sent to a recipient, they will still see the original inputs. Each item consists of

  • inputId: The ID of the input
  • title: The title for the input shown to the recipient
  • inputType: The type of input. One of simple, multiple_choice, text_area or file
  • responseValue: The value submitted by the client for this input. The Form Response has two possible responseStatus values: PENDING | COMPLETED. When accessing this resource from the POST endpoint, responseValue will be null. When accessing this resource from a Webhook Event(ref:events), responseValue will contain the values submitted by the Client(ref:client) corresponding to the inputType for that item. For file input types the value is a path to the file. To download the file itself will require an additional API call. That functionality is currently not available.
{
    "id": "497b203e-2802-4212-947a-2bbc44c5f7d6",
    "object": "formResponse",
    "created": "2022-06-29T15:16:23Z",
    "formId": "a039b228-2745-4a2b-bcf7-aac56d6519bf",
    "clientId": "a076e863-a266-4efb-acea-11455779d466",
    "responseStatus": "PENDING",
    "items": [
        {
            "inputId": "8bc362c9-493c-4eb2-a2a1-9bbaff974fc0",
            "title": "What is your full name?",
            "inputType": "simple",
            "responseValue": null
        },
        {
            "inputId": "52cfbe87-5a50-467a-aab5-97e462d9d2b8",
            "title": "Please upload your photo ID.",
            "inputType": "file",
            "responseValue": null
        },
        {
            "inputId": "01cf1ea4-8f9e-4145-a84a-b7454888cc2b",
            "title": "When would you like to begin the project?",
            "inputType": "multiple_choice",
            "responseValue": null
        },
        {
            "inputId": "829a8663-85d3-407e-ba1a-3002115d5c65",
            "title": "What is your objective?",
            "inputType": "multiple_choice",
            "responseValue": null
        },
        {
            "inputId": "540816b0-8ac0-433c-8015-d5377a7277e6",
            "title": "Would you like to share any additional information?",
            "inputType": "textarea_select",
            "responseValue": null
        }
    ]
}