Skip to main content
PUT
/
v1
/
forms
/
{form_id}
Update Form
curl --request PUT \
  --url https://api.simplicity.ai/v1/forms/{form_id} \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "form_description": "<string>",
  "form_title": "<string>",
  "source_document_ids": [
    "<string>"
  ]
}
'
{
  "form_id": "<string>",
  "source_document_details": [
    {
      "file_key": "<string>",
      "external_document_id": "<string>",
      "document_id": "<string>",
      "extension": "<string>",
      "original_filename": "<string>",
      "metadata": {},
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "form_description": "<string>",
  "form_title": "<string>",
  "form_name": "<string>",
  "original_form_name": "<string>",
  "form_url": "<string>",
  "updated_at": "2023-11-07T05:31:56Z",
  "created_at": "2023-11-07T05:31:56Z",
  "last_filled_at": "2023-11-07T05:31:56Z",
  "file_size": 123,
  "fillable_field_count": 123
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
form_id
string
required

Body

application/json
​
form_description
string | null
​
form_title
string | null
​
source_document_ids
string[] | null

Response

Successful Response

​
form_id
string
required
​
source_document_details
SourceDocumentDetail · object[]
required
​
form_description
string | null
​
form_title
string | null
​
form_name
string | null
​
original_form_name
string | null
​
form_url
string | null
​
updated_at
string<date-time> | null
​
created_at
string<date-time> | null
​
last_filled_at
string<date-time> | null
​
file_size
number | null
​
fillable_field_count
integer | null