Appearance

Create Folders ​

Endpoint ​

http
POST /unified/emails/folders
Integrations supported
  • Outlook Mail

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

name
string

The name of the folder

Required in
  • Outlook Mail
is_hidden
boolean

Indicates whether the folder is hidden. The default value is false.

Supported in
  • Outlook Mail
parent
object

The folder where this folder belong

Supported in
  • Outlook Mail
id
string
REQUIRED · 

The unique identifier for folder

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
REQUIRED · 

The unique identifier for a folder

Supported in
  • Outlook Mail
name
string

The name of the folder

Supported in
  • Outlook Mail
folder_url
string

The URL of the folder

size
integer

The size of the folder

Supported in
  • Outlook Mail
description
string

The description of the folder

parent
object

The folder where this folder belong

Supported in
  • Outlook Mail
id
string

The unique identifier for folder

created_at
string · date-time

The date and time the folder was created

updated_at
string · date-time

The date and time the folder was last updated

remote_data
object

Raw data returned from the remote API call.