| PATCH | /EmailMessages/{EmailMessageID} | Updates an email message. |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmailMessageID | path | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmailMessageID | form | string | No | |
| EmailNo | form | string | No | |
| DateCreated | form | DateTime? | No | |
| DateSent | form | DateTime? | No | |
| Reference | form | string | No | |
| SourceID | form | string | No | |
| SourceType | form | string | No | |
| SourceDisplayNo | form | string | No | |
| SourceForm | form | string | No | |
| Status | form | EmailStatuses? | No | |
| Staff | form | StaffMember | No | |
| EmailFrom | form | string | No | |
| EmailTo | form | string | No | |
| RequestReadReceipt | form | bool? | No | |
| EmailCC | form | string | No | |
| EmailBCC | form | string | No | |
| EmailSubject | form | string | No | |
| EmailBody | form | string | No | |
| Attachments | form | List<Document> | No | |
| BodyIsHTML | form | bool? | No | |
| LastSavedDateTime | form | DateTime? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| StaffID | form | string | No | |
| Title | form | string | No | |
| FirstName | form | string | No | |
| Surname | form | string | No | |
| Username | form | string | No | |
| IsActive | form | bool? | No | |
| IsEnabled | form | bool? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentID | form | string | No | |
| DocumentType | form | DocumentType | No | |
| FileID | form | string | No | |
| PhysicalFileName | form | string | No | |
| FullPhysicalFileName | form | string | No | |
| Description | form | string | No | |
| LastSavedDateTime | form | DateTime? | No | |
| LastModifiedByStaffID | form | string | No | |
| LastModifiedByStaffUsername | form | string | No | |
| LastModifiedByStaffTitle | form | string | No | |
| LastModifiedByStaffFirstName | form | string | No | |
| LastModifiedByStaffSurname | form | string | No | |
| FileBinary | form | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| DocumentTypeID | form | string | No | |
| Description | form | string | No | |
| DefaultType | form | bool? | No | |
| ItemNo | form | int? | No | |
| LastSavedDateTime | form | DateTime? | No | |
| RowHash | form | byte[] | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| EmailMessageID | form | string | No | |
| EmailNo | form | string | No | |
| DateCreated | form | DateTime? | No | |
| DateSent | form | DateTime? | No | |
| Reference | form | string | No | |
| SourceID | form | string | No | |
| SourceType | form | string | No | |
| SourceDisplayNo | form | string | No | |
| SourceForm | form | string | No | |
| Status | form | EmailStatuses? | No | |
| Staff | form | StaffMember | No | |
| EmailFrom | form | string | No | |
| EmailTo | form | string | No | |
| RequestReadReceipt | form | bool? | No | |
| EmailCC | form | string | No | |
| EmailBCC | form | string | No | |
| EmailSubject | form | string | No | |
| EmailBody | form | string | No | |
| Attachments | form | List<Document> | No | |
| BodyIsHTML | form | bool? | No | |
| LastSavedDateTime | form | DateTime? | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json
To embed the response in a jsonp callback, append ?callback=myCallback
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
PATCH /EmailMessages/{EmailMessageID} HTTP/1.1
Host: localhost
Accept: application/json
Content-Type: application/json
Content-Length: length
{"EmailMessageID":"String","Reference":"String","Status":"Entered","EmailFrom":"String","EmailTo":"String","RequestReadReceipt":false,"EmailCC":"String","EmailBCC":"String","EmailSubject":"String","EmailBody":"String","Attachments":[{"DocumentID":"String","DocumentType":{"DocumentTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA=="},"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","FileBinary":"AA=="}],"BodyIsHTML":false}
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length
{"EmailMessageID":"String","EmailNo":"String","DateCreated":"0001-01-01T00:00:00.0000000","DateSent":"0001-01-01T00:00:00.0000000","Reference":"String","SourceID":"String","SourceType":"String","SourceDisplayNo":"String","SourceForm":"String","Status":"Entered","Staff":{"StaffID":"String","Title":"String","FirstName":"String","Surname":"String","Username":"String","IsActive":false,"IsEnabled":false},"EmailFrom":"String","EmailTo":"String","RequestReadReceipt":false,"EmailCC":"String","EmailBCC":"String","EmailSubject":"String","EmailBody":"String","Attachments":[{"DocumentID":"String","DocumentType":{"DocumentTypeID":"String","Description":"String","DefaultType":false,"ItemNo":0,"LastSavedDateTime":"0001-01-01T00:00:00.0000000","RowHash":"AA=="},"FileID":"String","PhysicalFileName":"String","FullPhysicalFileName":"String","Description":"String","LastSavedDateTime":"0001-01-01T00:00:00.0000000","LastModifiedByStaffID":"String","LastModifiedByStaffUsername":"String","LastModifiedByStaffTitle":"String","LastModifiedByStaffFirstName":"String","LastModifiedByStaffSurname":"String","FileBinary":"AA=="}],"BodyIsHTML":false,"LastSavedDateTime":"0001-01-01T00:00:00.0000000"}