PUT api/v1/emails/{id}
Request Information
URI Parameters
| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
Body Parameters
Email| Name | Description | Type | Additional information |
|---|---|---|---|
| id | globally unique identifier |
Required |
|
| user_id | globally unique identifier |
None. |
|
| error | string |
None. |
|
| user | UserSimple |
None. |
|
| date_of_create | date |
Required |
|
| date_of_sent | date |
None. |
|
| state_id | integer |
Required |
|
| mail_from | string |
Required |
|
| mail_to | string |
Required |
|
| subject | string |
Required |
|
| body | string |
Required |
|
| template | CodeList |
Required |
|
| deleted | boolean |
Required |
|
| system_information | SystemInformation |
None. |
Request Formats
application/json, text/json
Sample:
{
"id": "16cc5c47-bc64-42d9-8e62-8dd1ad67786f",
"user_id": "ad2cee3e-8717-4ddb-91d0-6298bfc7eb04",
"error": "sample string 2",
"user": {
"full_name": "sample string 12 sample string 11",
"id": "9082d065-0a5a-434f-b5c6-ff54a35e5df7",
"image_id": "eb0578b9-9263-4714-a866-140988bc2319",
"id_user_work_position": "a97412b1-ff02-4b37-aec9-58a7c7097991",
"id_shift": "13603527-6329-4220-ac62-2c313c28ec0c",
"code": "sample string 5",
"code2": "sample string 6",
"title": "sample string 9",
"introduction": "sample string 10",
"first_name": "sample string 11",
"last_name": "sample string 12"
},
"date_of_create": "2026-03-20T21:49:19Z",
"date_of_sent": "2026-03-20T21:49:19Z",
"state_id": 1,
"mail_from": "sample string 3",
"mail_to": "sample string 4",
"subject": "sample string 5",
"body": "sample string 6",
"template": {
"id": "671dca7f-3ace-4352-b12e-03e12a81a3f2",
"name": "sample string 2",
"deleted": true,
"system_information": {
"creation": {
"user": {
"full_name": "sample string 12 sample string 11",
"id": "9082d065-0a5a-434f-b5c6-ff54a35e5df7",
"image_id": "eb0578b9-9263-4714-a866-140988bc2319",
"id_user_work_position": "a97412b1-ff02-4b37-aec9-58a7c7097991",
"id_shift": "13603527-6329-4220-ac62-2c313c28ec0c",
"code": "sample string 5",
"code2": "sample string 6",
"title": "sample string 9",
"introduction": "sample string 10",
"first_name": "sample string 11",
"last_name": "sample string 12"
},
"date": "2026-03-20T21:49:19Z"
},
"last_change": {
"user": {
"full_name": "sample string 12 sample string 11",
"id": "9082d065-0a5a-434f-b5c6-ff54a35e5df7",
"image_id": "eb0578b9-9263-4714-a866-140988bc2319",
"id_user_work_position": "a97412b1-ff02-4b37-aec9-58a7c7097991",
"id_shift": "13603527-6329-4220-ac62-2c313c28ec0c",
"code": "sample string 5",
"code2": "sample string 6",
"title": "sample string 9",
"introduction": "sample string 10",
"first_name": "sample string 11",
"last_name": "sample string 12"
},
"date": "2026-03-20T21:49:19Z"
}
}
},
"deleted": true,
"system_information": {
"creation": {
"user": {
"full_name": "sample string 12 sample string 11",
"id": "9082d065-0a5a-434f-b5c6-ff54a35e5df7",
"image_id": "eb0578b9-9263-4714-a866-140988bc2319",
"id_user_work_position": "a97412b1-ff02-4b37-aec9-58a7c7097991",
"id_shift": "13603527-6329-4220-ac62-2c313c28ec0c",
"code": "sample string 5",
"code2": "sample string 6",
"title": "sample string 9",
"introduction": "sample string 10",
"first_name": "sample string 11",
"last_name": "sample string 12"
},
"date": "2026-03-20T21:49:19Z"
},
"last_change": {
"user": {
"full_name": "sample string 12 sample string 11",
"id": "9082d065-0a5a-434f-b5c6-ff54a35e5df7",
"image_id": "eb0578b9-9263-4714-a866-140988bc2319",
"id_user_work_position": "a97412b1-ff02-4b37-aec9-58a7c7097991",
"id_shift": "13603527-6329-4220-ac62-2c313c28ec0c",
"code": "sample string 5",
"code2": "sample string 6",
"title": "sample string 9",
"introduction": "sample string 10",
"first_name": "sample string 11",
"last_name": "sample string 12"
},
"date": "2026-03-20T21:49:19Z"
}
}
}
application/xml, text/xml
Sample:
<Email xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IO.Swagger.Models">
<body>sample string 6</body>
<date_of_create>2026-03-20T22:49:19.3418187+01:00</date_of_create>
<date_of_sent>2026-03-20T22:49:19.3418187+01:00</date_of_sent>
<deleted>true</deleted>
<error>sample string 2</error>
<id>16cc5c47-bc64-42d9-8e62-8dd1ad67786f</id>
<mail_from>sample string 3</mail_from>
<mail_to>sample string 4</mail_to>
<state_id>1</state_id>
<subject>sample string 5</subject>
<system_information>
<creation>
<date>2026-03-20T22:49:19.3418187+01:00</date>
<user>
<code>sample string 5</code>
<code2>sample string 6</code2>
<first_name>sample string 11</first_name>
<full_name>sample string 12 sample string 11</full_name>
<id>9082d065-0a5a-434f-b5c6-ff54a35e5df7</id>
<id_shift>13603527-6329-4220-ac62-2c313c28ec0c</id_shift>
<id_user_work_position>a97412b1-ff02-4b37-aec9-58a7c7097991</id_user_work_position>
<image_id>eb0578b9-9263-4714-a866-140988bc2319</image_id>
<introduction>sample string 10</introduction>
<last_name>sample string 12</last_name>
<title>sample string 9</title>
</user>
</creation>
<last_change>
<date>2026-03-20T22:49:19.3418187+01:00</date>
<user>
<code>sample string 5</code>
<code2>sample string 6</code2>
<first_name>sample string 11</first_name>
<full_name>sample string 12 sample string 11</full_name>
<id>9082d065-0a5a-434f-b5c6-ff54a35e5df7</id>
<id_shift>13603527-6329-4220-ac62-2c313c28ec0c</id_shift>
<id_user_work_position>a97412b1-ff02-4b37-aec9-58a7c7097991</id_user_work_position>
<image_id>eb0578b9-9263-4714-a866-140988bc2319</image_id>
<introduction>sample string 10</introduction>
<last_name>sample string 12</last_name>
<title>sample string 9</title>
</user>
</last_change>
</system_information>
<template>
<deleted>true</deleted>
<id>671dca7f-3ace-4352-b12e-03e12a81a3f2</id>
<name>sample string 2</name>
<system_information>
<creation>
<date>2026-03-20T22:49:19.3418187+01:00</date>
<user>
<code>sample string 5</code>
<code2>sample string 6</code2>
<first_name>sample string 11</first_name>
<full_name>sample string 12 sample string 11</full_name>
<id>9082d065-0a5a-434f-b5c6-ff54a35e5df7</id>
<id_shift>13603527-6329-4220-ac62-2c313c28ec0c</id_shift>
<id_user_work_position>a97412b1-ff02-4b37-aec9-58a7c7097991</id_user_work_position>
<image_id>eb0578b9-9263-4714-a866-140988bc2319</image_id>
<introduction>sample string 10</introduction>
<last_name>sample string 12</last_name>
<title>sample string 9</title>
</user>
</creation>
<last_change>
<date>2026-03-20T22:49:19.3418187+01:00</date>
<user>
<code>sample string 5</code>
<code2>sample string 6</code2>
<first_name>sample string 11</first_name>
<full_name>sample string 12 sample string 11</full_name>
<id>9082d065-0a5a-434f-b5c6-ff54a35e5df7</id>
<id_shift>13603527-6329-4220-ac62-2c313c28ec0c</id_shift>
<id_user_work_position>a97412b1-ff02-4b37-aec9-58a7c7097991</id_user_work_position>
<image_id>eb0578b9-9263-4714-a866-140988bc2319</image_id>
<introduction>sample string 10</introduction>
<last_name>sample string 12</last_name>
<title>sample string 9</title>
</user>
</last_change>
</system_information>
</template>
<user>
<code>sample string 5</code>
<code2>sample string 6</code2>
<first_name>sample string 11</first_name>
<full_name>sample string 12 sample string 11</full_name>
<id>9082d065-0a5a-434f-b5c6-ff54a35e5df7</id>
<id_shift>13603527-6329-4220-ac62-2c313c28ec0c</id_shift>
<id_user_work_position>a97412b1-ff02-4b37-aec9-58a7c7097991</id_user_work_position>
<image_id>eb0578b9-9263-4714-a866-140988bc2319</image_id>
<introduction>sample string 10</introduction>
<last_name>sample string 12</last_name>
<title>sample string 9</title>
</user>
<user_id>ad2cee3e-8717-4ddb-91d0-6298bfc7eb04</user_id>
</Email>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
Result| Name | Description | Type | Additional information |
|---|---|---|---|
| messages | Collection of ResultMessage |
None. |
|
| count_of_errors | integer |
None. |
|
| id | Object |
None. |
|
| name | string |
None. |
|
| data | Object |
None. |
|
| url | string |
None. |
|
| text | string |
None. |
|
| inner_exception | string |
None. |
Response Formats
application/json, text/json
Sample:
{
"messages": [
{
"type": 1,
"code": 1,
"message": "sample string 1",
"field": "sample string 2"
},
{
"type": 1,
"code": 1,
"message": "sample string 1",
"field": "sample string 2"
}
],
"count_of_errors": 1,
"id": {},
"name": "sample string 3",
"data": {},
"url": "sample string 5",
"text": "sample string 6",
"inner_exception": "sample string 7"
}
application/xml, text/xml
Sample:
<Result xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UP.Core.Data">
<count_of_errors>1</count_of_errors>
<data />
<id />
<inner_exception>sample string 7</inner_exception>
<messages>
<ResultMessage>
<code>1</code>
<field>sample string 2</field>
<message>sample string 1</message>
<type>1</type>
</ResultMessage>
<ResultMessage>
<code>1</code>
<field>sample string 2</field>
<message>sample string 1</message>
<type>1</type>
</ResultMessage>
</messages>
<name>sample string 3</name>
<text>sample string 6</text>
<url>sample string 5</url>
</Result>