DELETE api/v1/UCTApi/BatchList/Agents/{AgentID}
UpdateBatchList
Request Information
Parameters
| Name | Description | Additional information |
|---|---|---|
| AgentID |
Define this parameter in the request URI. |
|
| trackingList |
Define this parameter in the request body. |
Request body formats
application/x-www-form-urlencoded
Sample:
Sample not available.
application/json, text/json
Sample:
{
"Queries": [
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
}
]
}
application/xml, text/xml
Sample:
<BatchListPutDTO>
<Queries>
<BatchListQueriesPutDTO>
<Query>
<Carrier>sample string 1</Carrier>
<SearchClass>sample string 2</SearchClass>
<SearchKey>sample string 3</SearchKey>
<SearchValue>sample string 4</SearchValue>
<Reference>sample string 5</Reference>
<UpdateUntil>2025-04-24T12:58:55.3615363+00:00</UpdateUntil>
<WebhookURL>sample string 6</WebhookURL>
</Query>
</BatchListQueriesPutDTO>
<BatchListQueriesPutDTO>
<Query>
<Carrier>sample string 1</Carrier>
<SearchClass>sample string 2</SearchClass>
<SearchKey>sample string 3</SearchKey>
<SearchValue>sample string 4</SearchValue>
<Reference>sample string 5</Reference>
<UpdateUntil>2025-04-24T12:58:55.3615363+00:00</UpdateUntil>
<WebhookURL>sample string 6</WebhookURL>
</Query>
</BatchListQueriesPutDTO>
<BatchListQueriesPutDTO>
<Query>
<Carrier>sample string 1</Carrier>
<SearchClass>sample string 2</SearchClass>
<SearchKey>sample string 3</SearchKey>
<SearchValue>sample string 4</SearchValue>
<Reference>sample string 5</Reference>
<UpdateUntil>2025-04-24T12:58:55.3615363+00:00</UpdateUntil>
<WebhookURL>sample string 6</WebhookURL>
</Query>
</BatchListQueriesPutDTO>
</Queries>
</BatchListPutDTO>
Response Information
Response body formats
application/json, text/json
Sample:
{
"summary": {
"created": 1,
"modified": 2,
"deleted": 3,
"failed": 4
},
"failed": [
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
},
"errors": [
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
},
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
},
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
}
]
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
},
"errors": [
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
},
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
},
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
}
]
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
},
"errors": [
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
},
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
},
{
"property": "sample string 1",
"message": "sample string 2",
"schema": {
"format": "sample string 1",
"type": "sample string 2",
"maxFutureMs": "sample string 3",
"description": "sample string 4",
"enum": [
"sample string 1",
"sample string 2",
"sample string 3"
]
},
"name": "sample string 3",
"argument": [
"sample string 1",
"sample string 2",
"sample string 3"
],
"stack": "sample string 4"
}
]
}
],
"created": [
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
}
],
"modified": [
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
}
],
"deleted": [
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
},
{
"Query": {
"Carrier": "sample string 1",
"SearchClass": "sample string 2",
"SearchKey": "sample string 3",
"SearchValue": "sample string 4",
"Reference": "sample string 5",
"UpdateUntil": "2025-04-24T12:58:55Z",
"WebhookURL": "sample string 6"
}
}
]
}