| POST | /Letter/Send |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| FileName | body | string | No | |
| File | body | byte[] | No | |
| TestFlag | body | bool | No | |
| TestEMail | body | string | No | |
| TestShowRestrictedArea | body | bool | No | |
| BatchId | body | int | No | |
| CoverLetter | body | bool | No | |
| CoverFile | body | byte[] | No | |
| IsColor | body | bool | No | |
| IsDuplex | body | bool | No | |
| AddressLine1 | body | string | No | |
| AddressLine2 | body | string | No | |
| AddressLine3 | body | string | No | |
| AddressLine4 | body | string | No | |
| AddressLine5 | body | string | No | |
| ZipCode | body | string | No | |
| City | body | string | No | |
| Country | body | string | No | |
| SenderAdressLine1 | body | string | No | |
| SenderStreet | body | string | No | |
| SenderZipCode | body | string | No | |
| SenderCity | body | string | No | |
| Reference | body | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| MessageId | form | string | No | |
| Sender | form | string | No | |
| Receiver | form | string | No | |
| Status | form | Status | No | |
| ErrorMessage | form | string | No | |
| Configuration | form | string | No | |
| Retry | form | bool | No | |
| RetryCount | form | int | No |
| accepted | |
| queued | |
| sending | |
| sent | |
| failed | |
| delivered | |
| undelivered | |
| receiving | |
| received | |
| read | |
| pickedup | |
| unknown |
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /Letter/Send HTTP/1.1
Host: communicationhub.carelogic-cloud.de
Accept: text/csv
Content-Type: text/csv
Content-Length: length
{"FileName":"String","File":"AA==","TestFlag":false,"TestEMail":"String","TestShowRestrictedArea":false,"BatchId":0,"CoverLetter":false,"CoverFile":"AA==","IsColor":false,"IsDuplex":false,"AddressLine1":"String","AddressLine2":"String","AddressLine3":"String","AddressLine4":"String","AddressLine5":"String","ZipCode":"String","City":"String","Country":"String","SenderAdressLine1":"String","SenderStreet":"String","SenderZipCode":"String","SenderCity":"String","Reference":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"MessageId":"String","Sender":"String","Receiver":"String","Status":"accepted","ErrorMessage":"String","Configuration":"String","Retry":false,"RetryCount":0}