POST api/ApnBulk/RunStart
Request Information
URI Parameters
None.
Body Parameters
BulkRunRequest| Name | Description | Type | Additional information |
|---|---|---|---|
| ActionKey | string |
None. |
|
| AccountIds | Collection of integer |
None. |
|
| AccountStatusId | integer |
None. |
|
| WriteOff | string |
None. |
|
| AccountManagerId | integer |
None. |
|
| AccountTypeId | integer |
None. |
|
| SecurityLevelId | integer |
None. |
|
| InterestPlanId | integer |
None. |
|
| ProductId | integer |
None. |
|
| MaxExpenditure | decimal number |
None. |
|
| NoteText | string |
None. |
|
| NoteEntryTypeId | integer |
None. |
|
| NoteEntryStatusId | integer |
None. |
|
| NoteDate | date |
None. |
|
| PoolId | integer |
None. |
|
| RemoveAllPools | boolean |
None. |
|
| TaskTypeId | integer |
None. |
|
| TaskText | string |
None. |
|
| TaskDue | date |
None. |
|
| TaskEntryTypeId | integer |
None. |
|
| TaskNote | string |
None. |
|
| TaskAssignTo | string |
None. |
|
| TaskUserGroupId | integer |
None. |
|
| TaskContactId | integer |
None. |
|
| ReassignToContactId | integer |
None. |
|
| ReassignTaskTypeId | integer |
None. |
|
| Confirm | string |
None. |
Request Formats
application/json, text/json
Sample:
{
"ActionKey": "sample string 1",
"AccountIds": [
1,
2
],
"AccountStatusId": 1,
"WriteOff": "sample string 2",
"AccountManagerId": 1,
"AccountTypeId": 1,
"SecurityLevelId": 1,
"InterestPlanId": 1,
"ProductId": 1,
"MaxExpenditure": 1.0,
"NoteText": "sample string 3",
"NoteEntryTypeId": 1,
"NoteEntryStatusId": 1,
"NoteDate": "2026-11-18T13:28:44.6216222+00:00",
"PoolId": 1,
"RemoveAllPools": true,
"TaskTypeId": 1,
"TaskText": "sample string 5",
"TaskDue": "2026-11-18T13:28:44.6216222+00:00",
"TaskEntryTypeId": 1,
"TaskNote": "sample string 6",
"TaskAssignTo": "sample string 7",
"TaskUserGroupId": 1,
"TaskContactId": 1,
"ReassignToContactId": 1,
"ReassignTaskTypeId": 1,
"Confirm": "sample string 8"
}
application/xml, text/xml
Sample:
<BulkRunRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Bulk">
<AccountIds xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</AccountIds>
<AccountManagerId>1</AccountManagerId>
<AccountStatusId>1</AccountStatusId>
<AccountTypeId>1</AccountTypeId>
<ActionKey>sample string 1</ActionKey>
<Confirm>sample string 8</Confirm>
<InterestPlanId>1</InterestPlanId>
<MaxExpenditure>1</MaxExpenditure>
<NoteDate>2026-11-18T13:28:44.6216222+00:00</NoteDate>
<NoteEntryStatusId>1</NoteEntryStatusId>
<NoteEntryTypeId>1</NoteEntryTypeId>
<NoteText>sample string 3</NoteText>
<PoolId>1</PoolId>
<ProductId>1</ProductId>
<ReassignTaskTypeId>1</ReassignTaskTypeId>
<ReassignToContactId>1</ReassignToContactId>
<RemoveAllPools>true</RemoveAllPools>
<SecurityLevelId>1</SecurityLevelId>
<TaskAssignTo>sample string 7</TaskAssignTo>
<TaskContactId>1</TaskContactId>
<TaskDue>2026-11-18T13:28:44.6216222+00:00</TaskDue>
<TaskEntryTypeId>1</TaskEntryTypeId>
<TaskNote>sample string 6</TaskNote>
<TaskText>sample string 5</TaskText>
<TaskTypeId>1</TaskTypeId>
<TaskUserGroupId>1</TaskUserGroupId>
<WriteOff>sample string 2</WriteOff>
</BulkRunRequest>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
ApiResultOfBulkRunStarted| Name | Description | Type | Additional information |
|---|---|---|---|
| Response | ApiResponse |
None. |
|
| Data | BulkRunStarted |
None. |
Response Formats
application/json, text/json
Sample:
{
"Response": {
"Success": true,
"ErrorMessage": "sample string 2"
},
"Data": {
"RunId": 1
}
}
application/xml, text/xml
Sample:
<ApiResultOfBulkRunStartedpqgyCYEG xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions">
<Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/Debtrak.ApnExtensions.Bulk">
<d2p1:RunId>1</d2p1:RunId>
</Data>
<Response>
<ErrorMessage>sample string 2</ErrorMessage>
<Success>true</Success>
</Response>
</ApiResultOfBulkRunStartedpqgyCYEG>