Create a folder

curl --request POST \
  --url https://{dsn}/api/v1/{account_id}/folders \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Customers"
}
'

import requests

url = "https://{dsn}/api/v1/{account_id}/folders"

payload = { "name": "Customers" }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Customers'})
};

fetch('https://{dsn}/api/v1/{account_id}/folders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/folders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Customers'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{dsn}/api/v1/{account_id}/folders"

	payload := strings.NewReader("{\n  \"name\": \"Customers\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{dsn}/api/v1/{account_id}/folders")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Customers\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{dsn}/api/v1/{account_id}/folders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Customers\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "Folder",
  "id": "<string>",
  "account_id": "<string>",
  "name": "<string>",
  "role": "INBOX",
  "parent_id": "<string>",
  "total_count": 123
}

{
  "status": 400,
  "type": "errors/invalid_parameters",
  "title": "Invalid parameters",
  "detail": "limit must be between 1 and 250"
}

{
  "status": 401,
  "type": "errors/invalid_credentials",
  "title": "Invalid credentials",
  "detail": "the mail provider rejected the credentials: invalid_grant"
}

{
  "status": 404,
  "type": "errors/not_found",
  "title": "Not found",
  "detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}

{
  "status": 422,
  "type": "errors/provider_rejected",
  "title": "Rejected by the provider",
  "detail": "Message too large"
}

{
  "status": 502,
  "type": "errors/provider_error",
  "title": "Mail provider error",
  "detail": "timed out talking to imap.example.com"
}

POST

{account_id}

folders

Create a folder

curl --request POST \
  --url https://{dsn}/api/v1/{account_id}/folders \
  --header 'Content-Type: application/json' \
  --header 'X-API-KEY: <api-key>' \
  --data '
{
  "name": "Customers"
}
'

import requests

url = "https://{dsn}/api/v1/{account_id}/folders"

payload = { "name": "Customers" }
headers = {
    "X-API-KEY": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({name: 'Customers'})
};

fetch('https://{dsn}/api/v1/{account_id}/folders', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{dsn}/api/v1/{account_id}/folders",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => 'Customers'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-API-KEY: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://{dsn}/api/v1/{account_id}/folders"

	payload := strings.NewReader("{\n  \"name\": \"Customers\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-API-KEY", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://{dsn}/api/v1/{account_id}/folders")
  .header("X-API-KEY", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Customers\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{dsn}/api/v1/{account_id}/folders")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Customers\"\n}"

response = http.request(request)
puts response.read_body

{
  "object": "Folder",
  "id": "<string>",
  "account_id": "<string>",
  "name": "<string>",
  "role": "INBOX",
  "parent_id": "<string>",
  "total_count": 123
}

{
  "status": 400,
  "type": "errors/invalid_parameters",
  "title": "Invalid parameters",
  "detail": "limit must be between 1 and 250"
}

{
  "status": 401,
  "type": "errors/invalid_credentials",
  "title": "Invalid credentials",
  "detail": "the mail provider rejected the credentials: invalid_grant"
}

{
  "status": 404,
  "type": "errors/not_found",
  "title": "Not found",
  "detail": "email email_94a0d77db739407e932c3b97fef44aac not found"
}

{
  "status": 422,
  "type": "errors/provider_rejected",
  "title": "Rejected by the provider",
  "detail": "Message too large"
}

{
  "status": 502,
  "type": "errors/provider_error",
  "title": "Mail provider error",
  "detail": "timed out talking to imap.example.com"
}

Authorizations

X-API-KEY

string

header

required

Your access token, from your dashboard under API keys.

Path Parameters

account_id

string

required

The account's acc_… id.

Body

application/json

name

string

required

parent_id

string

The fld_… id of the folder to create it in.

Response

The new folder.

object

string

Allowed value: "Folder"

string

fld_…

account_id

string

name

string

role

enum<string>

Available options:

INBOX,

SENT,

DRAFTS,

TRASH,

SPAM,

ARCHIVE,

ALL,

IMPORTANT,

STARRED,

UNKNOWN

parent_id

string | null

total_count

integer

Auth

Accounts

Emails

Attachments

Drafts

Folders

Contacts

Webhooks

API keys

Create a folder

Authorizations

Path Parameters

Body

Response