Appearance

Update Emails ​

Endpoint ​

http
PATCH /unified/emails/emails/{id}
Integrations supported
  • Outlook Mail

Path parameters ​

id
string
REQUIRED · 

The ID of the resource.

Example: 23423523

Query parameters ​

Refer Specifying query parameters in Truto APIs

integrated_account_id
string · uuid
REQUIRED · 

The ID of the integrated account to use for the request.

Example: 62f44730-dd91-461e-bd6a-aedd9e0ad79d
truto_response_format
string

The format of the response.

  • unified returns the response with unified mappings applied.
  • raw returns the unprocessed, raw response from the remote API.
  • normalized applies the unified mappings and returns the data in a normalized format.
  • stream returns the response as a stream, which is ideal for transmitting large datasets, files, or binary data. Using streaming mode helps to efficiently handle large payloads or real-time data flows without requiring the entire data to be buffered in memory.

Defaults to unified.

All possible enum values:
  • unified
  • raw
  • normalized
  • stream
Example: unified
truto_ignore_remote_data
boolean

Excludes the remote_data attribute from the response.

truto_exclude_fields
array

Array of fields to exclude from the response.

Example: truto_exclude_fields[]=id&truto_exclude_fields[]=name
remote_query
object

Query parameters to pass to the underlying API without any transformations. Refer this guide to see how to structure the query parameters.

Example: remote_query[foo]=bar

Request Body ​

Refer Writing data using Unified APIs

from
string

Sender email address

Supported in
  • Outlook Mail
to
string[]

Recipient email addresses

Supported in
  • Outlook Mail
cc
string[]

CC email addresses

Supported in
  • Outlook Mail
bcc
string[]

BCC email addresses

Supported in
  • Outlook Mail
subject
string

Email subject

Supported in
  • Outlook Mail
content
object
Supported in
  • Outlook Mail
type
string
REQUIRED · 

Content type of the email

All possible enum values:
  • plain_text
  • html
value
string
REQUIRED · 

The body of the email in the selected format

reply_to
string

Reply-to email address

Supported in
  • Outlook Mail
priority
string

Priority of the email

All possible enum values:
  • high
  • normal
  • low
Enum support by integration
  • Outlook Mail
    • high
    • normal
    • low
Supported in
  • Outlook Mail
attachments
object[]

The attachments of the email

Supported in
  • Outlook Mail
id
string

The unique identifier for the attachment

file_name
string
REQUIRED · 

The attachment's name

file_url
string

The URL to download the attachment

content_type
string
REQUIRED · 

The content type of the attachment

created_at
string · date-time

The time when the attachment was created

content_bytes
string
REQUIRED · 

The content bytes of the attachment. This is base 64 encoded.

remote_data
object

Any additional data that should be passed as part of the request body. This data is not transformed by Truto and is passed as is to the remote API.

Response Body ​

id
string

The unique identifier for the email

Supported in
  • Outlook Mail
from
string

Sender email address

Supported in
  • Outlook Mail
to
string[]

Recipient email addresses

Supported in
  • Outlook Mail
cc
string[]

CC email addresses

Supported in
  • Outlook Mail
bcc
string[]

BCC email addresses

Supported in
  • Outlook Mail
subject
string

Email subject

Supported in
  • Outlook Mail
content
object
Supported in
  • Outlook Mail
type
string

Content type of the email

All possible enum values:
  • plain_text
  • html
value
string

The body of the email in the selected format

headers
object

Custom headers for the email

reply_to
string

Reply-to email address

Supported in
  • Outlook Mail
priority
string

Priority of the email

All possible enum values:
  • high
  • normal
  • low
Supported in
  • Outlook Mail
folder
object

The folder where the email is stored

Supported in
  • Outlook Mail
id
string

The unique identifier for a folder

is_draft
boolean

Indicates whether the email is saved as a draft (created but not sent yet). If true, the email is still edited or waiting to be sent

All possible enum values:
  • true
  • false
Supported in
  • Outlook Mail
attachments
object[]

The attachments of the email

Supported in
  • Outlook Mail
id
string

The unique identifier for the attachment

file_name
string

The attachment's name

file_url
string

The URL to download the attachment

content_type
string

The content type of the attachment

created_at
string · date-time

The time when the attachment was created

urls
object[]

The email's urls

Supported in
  • Outlook Mail
url
string

The email's URL

type
string

The email's URL type

created_at
string · date-time

The date and time the email was created

Supported in
  • Outlook Mail
updated_at
string · date-time

The date and time the email was last updated

Supported in
  • Outlook Mail
sent_at
string · date-time

The date and time the email was sent

Supported in
  • Outlook Mail
remote_data
object

Raw data returned from the remote API call.