| Required role: | Administrator | Requires any of the roles: | Agent, Administrator |
| GET,OPTIONS | /v1/EmailQueueSearch/{SearchTerm} | ||
|---|---|---|---|
| GET,OPTIONS | /v1/EmailQueueSearch |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| SearchTerm | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| QueueSearchResults | form | List<EmailQueue> | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmailQueueId | form | int | No | |
| Recipient | form | string | No | |
| Sender | form | string | No | |
| Subject | form | string | No | |
| Body | form | string | No | |
| IsBodyHTML | form | bool | No | |
| SendThroughAppEmail | form | bool | No | |
| SenderUserId | form | string | No | |
| EmailFromName | form | string | No | |
| DateCompleted | form | DateTime | No | |
| DateToSend | form | DateTime | No | |
| FailCount | form | int | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/EmailQueueSearch/{SearchTerm} HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
Content-Length: length
{"QueueSearchResults":[{"EmailQueueId":0,"Recipient":"String","Sender":"String","Subject":"String","Body":"String","IsBodyHTML":false,"SendThroughAppEmail":false,"SenderUserId":"String","EmailFromName":"String","DateCompleted":"0001-01-01T00:00:00.0000000","DateToSend":"0001-01-01T00:00:00.0000000","FailCount":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}