PUT api/v1/emails/{id}

Request Information

URI Parameters

NameDescriptionTypeAdditional information
id

globally unique identifier

Required

Body Parameters

Email
NameDescriptionTypeAdditional 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": "abef8e33-7902-415f-83bd-e8bd5d644b9d",
  "user_id": "eb48b443-5c58-4ea0-ab08-ea9391f1e3e1",
  "error": "sample string 2",
  "user": {
    "full_name": "sample string 12 sample string 11",
    "id": "7586d178-eb51-4e2d-b81e-0a45662427bd",
    "image_id": "e268a1ea-5b81-4641-a492-0bb5d7a2e8a2",
    "id_user_work_position": "902640f8-4b7c-4052-ae34-7b170cb76fa7",
    "id_shift": "3ca4d859-43a8-41a9-95bf-30edf640aa34",
    "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": "2024-03-05T14:57:31Z",
  "date_of_sent": "2024-03-05T14:57:31Z",
  "state_id": 1,
  "mail_from": "sample string 3",
  "mail_to": "sample string 4",
  "subject": "sample string 5",
  "body": "sample string 6",
  "template": {
    "id": "607002c5-1280-47be-bbce-33952b77fa65",
    "name": "sample string 2",
    "deleted": true,
    "system_information": {
      "creation": {
        "user": {
          "full_name": "sample string 12 sample string 11",
          "id": "7586d178-eb51-4e2d-b81e-0a45662427bd",
          "image_id": "e268a1ea-5b81-4641-a492-0bb5d7a2e8a2",
          "id_user_work_position": "902640f8-4b7c-4052-ae34-7b170cb76fa7",
          "id_shift": "3ca4d859-43a8-41a9-95bf-30edf640aa34",
          "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": "2024-03-05T14:57:31Z"
      },
      "last_change": {
        "user": {
          "full_name": "sample string 12 sample string 11",
          "id": "7586d178-eb51-4e2d-b81e-0a45662427bd",
          "image_id": "e268a1ea-5b81-4641-a492-0bb5d7a2e8a2",
          "id_user_work_position": "902640f8-4b7c-4052-ae34-7b170cb76fa7",
          "id_shift": "3ca4d859-43a8-41a9-95bf-30edf640aa34",
          "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": "2024-03-05T14:57:31Z"
      }
    }
  },
  "deleted": true,
  "system_information": {
    "creation": {
      "user": {
        "full_name": "sample string 12 sample string 11",
        "id": "7586d178-eb51-4e2d-b81e-0a45662427bd",
        "image_id": "e268a1ea-5b81-4641-a492-0bb5d7a2e8a2",
        "id_user_work_position": "902640f8-4b7c-4052-ae34-7b170cb76fa7",
        "id_shift": "3ca4d859-43a8-41a9-95bf-30edf640aa34",
        "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": "2024-03-05T14:57:31Z"
    },
    "last_change": {
      "user": {
        "full_name": "sample string 12 sample string 11",
        "id": "7586d178-eb51-4e2d-b81e-0a45662427bd",
        "image_id": "e268a1ea-5b81-4641-a492-0bb5d7a2e8a2",
        "id_user_work_position": "902640f8-4b7c-4052-ae34-7b170cb76fa7",
        "id_shift": "3ca4d859-43a8-41a9-95bf-30edf640aa34",
        "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": "2024-03-05T14:57:31Z"
    }
  }
}

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>2024-03-05T15:57:31.1907699+01:00</date_of_create>
  <date_of_sent>2024-03-05T15:57:31.1907699+01:00</date_of_sent>
  <deleted>true</deleted>
  <error>sample string 2</error>
  <id>abef8e33-7902-415f-83bd-e8bd5d644b9d</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>2024-03-05T15:57:31.1907699+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>7586d178-eb51-4e2d-b81e-0a45662427bd</id>
        <id_shift>3ca4d859-43a8-41a9-95bf-30edf640aa34</id_shift>
        <id_user_work_position>902640f8-4b7c-4052-ae34-7b170cb76fa7</id_user_work_position>
        <image_id>e268a1ea-5b81-4641-a492-0bb5d7a2e8a2</image_id>
        <introduction>sample string 10</introduction>
        <last_name>sample string 12</last_name>
        <title>sample string 9</title>
      </user>
    </creation>
    <last_change>
      <date>2024-03-05T15:57:31.1907699+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>7586d178-eb51-4e2d-b81e-0a45662427bd</id>
        <id_shift>3ca4d859-43a8-41a9-95bf-30edf640aa34</id_shift>
        <id_user_work_position>902640f8-4b7c-4052-ae34-7b170cb76fa7</id_user_work_position>
        <image_id>e268a1ea-5b81-4641-a492-0bb5d7a2e8a2</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>607002c5-1280-47be-bbce-33952b77fa65</id>
    <name>sample string 2</name>
    <system_information>
      <creation>
        <date>2024-03-05T15:57:31.1907699+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>7586d178-eb51-4e2d-b81e-0a45662427bd</id>
          <id_shift>3ca4d859-43a8-41a9-95bf-30edf640aa34</id_shift>
          <id_user_work_position>902640f8-4b7c-4052-ae34-7b170cb76fa7</id_user_work_position>
          <image_id>e268a1ea-5b81-4641-a492-0bb5d7a2e8a2</image_id>
          <introduction>sample string 10</introduction>
          <last_name>sample string 12</last_name>
          <title>sample string 9</title>
        </user>
      </creation>
      <last_change>
        <date>2024-03-05T15:57:31.1907699+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>7586d178-eb51-4e2d-b81e-0a45662427bd</id>
          <id_shift>3ca4d859-43a8-41a9-95bf-30edf640aa34</id_shift>
          <id_user_work_position>902640f8-4b7c-4052-ae34-7b170cb76fa7</id_user_work_position>
          <image_id>e268a1ea-5b81-4641-a492-0bb5d7a2e8a2</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>7586d178-eb51-4e2d-b81e-0a45662427bd</id>
    <id_shift>3ca4d859-43a8-41a9-95bf-30edf640aa34</id_shift>
    <id_user_work_position>902640f8-4b7c-4052-ae34-7b170cb76fa7</id_user_work_position>
    <image_id>e268a1ea-5b81-4641-a492-0bb5d7a2e8a2</image_id>
    <introduction>sample string 10</introduction>
    <last_name>sample string 12</last_name>
    <title>sample string 9</title>
  </user>
  <user_id>eb48b443-5c58-4ea0-ab08-ea9391f1e3e1</user_id>
</Email>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Result
NameDescriptionTypeAdditional 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>