Update Agent Data
Overview
Update Agent Data for a process instance. Use this API to change shared business values while an agent is running. A workflow instance ID is not required.
Endpoint
POST /api/processinstance/submitAgentData
Use the service origin described in Getting started. The path above already includes /api.
Authentication
Send the access token obtained from Get Access Token in the Authorization header. Access is limited by the authenticated account’s permissions.
Request headers
Accept: application/json
Authorization: Bearer ACCESS_TOKEN
Content-Type: application/json
Request body
| Parameter | Type | Requirement | Description |
|---|---|---|---|
processInstanceId | string | Required | Execution ID returned by Create Process Instance. |
Data | object | Required | Field keys and values matching the data definitions in the process. |
{
"processInstanceId": "cab622a17f8d444bbbec0dff5583a564",
"Data": {
"CustomerName": "Acme Corp"
}
}
Request example
The following example uses cURL in a POSIX shell. Replace example credentials and IDs before running it. Replace the AI Command Center origin with your deployment address.
curl --request POST \
--url 'https://command-center.example.com/api/processinstance/submitAgentData' \
--header 'Accept: application/json' \
--header 'Authorization: Bearer ACCESS_TOKEN' \
--header 'Content-Type: application/json' \
--data '{
"processInstanceId": "cab622a17f8d444bbbec0dff5583a564",
"Data": {
"CustomerName": "Acme Corp"
}
}'
Response
Successful status: 200 OK.
The following is an illustrative response with synthetic contact and credential values. Arrays are shortened to one representative item.
{
"processInstanceId": "cab622a17f8d444bbbec0dff5583a564",
"automationAgentDataId": 157,
"status": "Success"
}
Agent Data is shared across workflows within one process execution. A workflow instance ID is not required. Field names and value types must match the agent’s definitions.
This operation changes runtime values, not design-time field definitions. Workflows that read a submitted field after the update use its updated value within the same execution. The example assumes a text field named CustomerName; use its field key, rather than its designer reference agentData.CustomerName.
Response fields
The table describes selected fields in the response. Types reflect the example; this is not an exhaustive schema or nullability contract.
| Field | Example type | Description |
|---|---|---|
processInstanceId | string | ID of the process execution. |
automationAgentDataId | integer | Identifier of the Agent Data record. |
status | string | Resource or operation status shown in the example; the complete allowed set is not defined here. |
Errors
Endpoint-specific error statuses and response bodies are not yet documented. See Usage and troubleshooting for general handling guidance.