Merge new values into an application's variable data. For example, you can use this API to update a loan amount after the applicant changes their request.
How the merge works
- Identify the application with
id, the application ID that Create application returns.sessionis accepted as an alias. - Each top-level key in
datareplaces the application's current value for that key, or adds it if it is new. Keys you don't send are left unchanged. - The merge is one level deep. If a value is an object or a list, the whole value is replaced, not merged.
- Values are saved as sent. They are not checked against your variable definitions, and no key is protected, so send only the variables you mean to change.
What it does not do
This call only saves data. It does not run a workflow or decision, recalculate derived variables, change the stage or send webhooks. It adds an entry to the application's activity: "Application data updated using Update API."
Environment and access
A key that starts with live_ updates live applications; any other key (for example test_...) updates sandbox applications. An application from the other environment returns Invalid App Id. The application must belong to the same account as your API key, or the call returns 403.
This endpoint does not change tags. tag_names is ignored here, unlike the older PUT /application/update/ route.
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Merge new values into an application's variable data. For example, you can use this API to update a loan amount after the applicant changes their request.
How the merge works
- Identify the application with
id, the application ID that Create application returns.sessionis accepted as an alias. - Each top-level key in
datareplaces the application's current value for that key, or adds it if it is new. Keys you don't send are left unchanged. - The merge is one level deep. If a value is an object or a list, the whole value is replaced, not merged.
- Values are saved as sent. They are not checked against your variable definitions, and no key is protected, so send only the variables you mean to change.
What it does not do
This call only saves data. It does not run a workflow or decision, recalculate derived variables, change the stage or send webhooks. It adds an entry to the application's activity: "Application data updated using Update API."
Environment and access
A key that starts with live_ updates live applications; any other key (for example test_...) updates sandbox applications. An application from the other environment returns Invalid App Id. The application must belong to the same account as your API key, or the call returns 403.
This endpoint does not change tags. tag_names is ignored here, unlike the older PUT /application/update/ route.
The API key is not recognised or is inactive. The body is empty.