Update answer for a submission and field

Updates the answer for a specific field in a submission.
Supports updating file-type fields using form data.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
uuid
required

The ID of the submission.

string
required

Field reference of the question where the answer should be updated.

boolean
required

Indicates whether to append the file to existing files answer or replace them.

Body Params
file

File when File Upload field is used. For multiple files, use route "{id}/UpdateAnswer/{fieldRef}/true" to append files instead of replacing them.

string
length ≤ 8000

The answer value as a string. The required format depends on the field type.

🚧

JSON-encoded string required

For Name and Address fields the value must be a serialised JSON string — not a nested JSON object.

Name — "{\"first\":\"John\",\"middle\":\"Michael\",\"last\":\"Smith\"}" (omit middle unless UseMiddleName is true).

Address — "{\"address\":\"123 Main St\",\"city\":\"Brisbane\",\"state\":\"QLD\",\"zip\":\"4000\",\"country\":\"Australia\"}"

  • address and country are always required.
  • city, state and zip are required when country is Australia or United States. For other countries they are optional: leave them out or send an empty string.
  • address2 is optional. Put a second street line there, not as a line break in address.
  • Only the keys address, address2, city, state, zip and country are accepted, and every value must be a string (e.g. "zip": "6315", not "zip": 6315).

Other field types — send the value directly:

For Checkbox, Radio, Select, Linked and Office fields, leave Answer empty and use AnswerRef instead.

string
length ≤ 500

The option or linked record reference. Required when answering option-based or linked fields:

  • Checkbox — multiple option refs joined by semicolon, e.g. 123;1234;12345
  • Linked Field — multiple record refs joined by semicolon, e.g. 100912758;100912759. For repeatable fields, append the repeat index using ~, e.g. 100912758~1;100912759~2
  • Radio or Select/Dropdown — single option ref, e.g. 12345
  • Office — the office id, e.g. 12345. Retrieve the selectable offices from the Options of the Office field returned by the form fields API.
boolean

When true, the answer is rendered as a placeholder in the document rather than resolved to its final value.

string

ISO 4217 currency code for Currency-type fields (e.g. 'AUD', 'USD', 'GBP'). Required when the field type is Currency.

Responses
200

OK

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json