Request Headers
| Header | Value | Required | Description |
|---|---|---|---|
| ECI-ApiKey | string | Yes | Your API key. See Authentication. |
| Content-Type | application/json | Yes | All requests must specify JSON content type, including the request body. |
Path Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| entityType | The type of entity the flag issues are being request for. Supported values are: “Bill” | string | Required |
| entityId | The identifier of the entity | integer (int32) | Required |
Query Parameters
| Name | Description | Type | Required |
|---|---|---|---|
| flagResolveComment | Optional comment that will be recorded in the flag event when resolving the issue | string | Optional |
Request Body
Array of:
FlagIssueEdit
| Property | Description | Type |
|---|---|---|
| assignees | All users currently assigned to this flag issue Required (defined) | integer[] |
| comment | Comment about the flag issue Required (defined) | string |
| flagIssueId | The flag issue identifier Required (defined) | integer (int32) |
| flagIssueStatusId | Current status of the flag issue Must be a valid value for FlagStatusEnum: Unresolved = 1, Resolved = 2 Required (defined) | integer (int32) |
Example Request Body
[
{ "assignees": [
1
], "comment": "string", "flagIssueId": 1, "flagIssueStatusId": 1
}
]
Responses
200
OK
The request succeeded and the response body contains the requested data.
Response Body Parameters
Array of:
FlagIssueResponse
| Property | Description | Type | ||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| assignees | All users currently assigned to this issue | UserChild[] | ||||||||||||||||||||||||||||||||||||||||||||||||
|
UserChild properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| flagIssueEvents | All events and actions that have occurred with this issue | FlagIssueEventChild[] | ||||||||||||||||||||||||||||||||||||||||||||||||
|
FlagIssueEventChild properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| flagIssueId | The flag issue identifier | integer (int32) | ||||||||||||||||||||||||||||||||||||||||||||||||
| flagIssueStatus | FlagIssueStatusChild | |||||||||||||||||||||||||||||||||||||||||||||||||
|
FlagIssueStatusChild properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
| flagIssueType | FlagIssueTypeChild | |||||||||||||||||||||||||||||||||||||||||||||||||
|
FlagIssueTypeChild properties
|
||||||||||||||||||||||||||||||||||||||||||||||||||
Example Response
[
{ "assignees": [
{ "fullName": "string", "userCode": "string", "userId": 1
}
], "flagIssueEvents": [
{ "comment": "string", "createdBy": {}, "createdDate": "2026-03-30", "description": "string", "flagIssueAction": {}, "flagIssueEventId": 1
}
], "flagIssueId": 1, "flagIssueStatus": { "flagIssueStatusId": 1, "flagIssueStatusInfo": "string"
}, "flagIssueType": { "flagIssueCategory": "string", "flagIssueTypeDescription": "string", "flagIssueTypeId": 1, "flagIssueTypeInfo": "string"
}
}
]