Create Inbox

curl --request POST \
  --url https://app.pixie.ai/api/email/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>"
}
'

import requests

url = "https://app.pixie.ai/api/email/accounts"

payload = {
    "username": "<string>",
    "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    username: '<string>',
    domain_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    display_name: '<string>',
    first_name: '<string>',
    last_name: '<string>'
  })
};

fetch('https://app.pixie.ai/api/email/accounts', 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://app.pixie.ai/api/email/accounts",
  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([
    'username' => '<string>',
    'domain_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'display_name' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.pixie.ai/api/email/accounts"

	payload := strings.NewReader("{\n  \"username\": \"<string>\",\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"display_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.pixie.ai/api/email/accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"<string>\",\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"display_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.pixie.ai/api/email/accounts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"<string>\",\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"display_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}"

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

{
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "email",
    "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email_address": "[email protected]",
    "agentmail_inbox_id": "<string>",
    "instantly_account_id": "<string>",
    "status": "pending",
    "warmup_status": "not_started",
    "is_default_sender": true,
    "display_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "signature": "<string>",
    "instantly_tag_id": "<string>",
    "instantly_warmup_tag_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "email_domains": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "status": "pending"
    }
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

POST

api

accounts

Create Inbox

curl --request POST \
  --url https://app.pixie.ai/api/email/accounts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "username": "<string>",
  "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "display_name": "<string>",
  "first_name": "<string>",
  "last_name": "<string>"
}
'

import requests

url = "https://app.pixie.ai/api/email/accounts"

payload = {
    "username": "<string>",
    "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "display_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    username: '<string>',
    domain_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    display_name: '<string>',
    first_name: '<string>',
    last_name: '<string>'
  })
};

fetch('https://app.pixie.ai/api/email/accounts', 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://app.pixie.ai/api/email/accounts",
  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([
    'username' => '<string>',
    'domain_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'display_name' => '<string>',
    'first_name' => '<string>',
    'last_name' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://app.pixie.ai/api/email/accounts"

	payload := strings.NewReader("{\n  \"username\": \"<string>\",\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"display_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://app.pixie.ai/api/email/accounts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"username\": \"<string>\",\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"display_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.pixie.ai/api/email/accounts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"username\": \"<string>\",\n  \"domain_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"display_name\": \"<string>\",\n  \"first_name\": \"<string>\",\n  \"last_name\": \"<string>\"\n}"

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

{
  "account": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "user_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "type": "email",
    "domain_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "email_address": "[email protected]",
    "agentmail_inbox_id": "<string>",
    "instantly_account_id": "<string>",
    "status": "pending",
    "warmup_status": "not_started",
    "is_default_sender": true,
    "display_name": "<string>",
    "first_name": "<string>",
    "last_name": "<string>",
    "signature": "<string>",
    "instantly_tag_id": "<string>",
    "instantly_warmup_tag_id": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "email_domains": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "domain": "<string>",
      "status": "pending"
    }
  }
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

{
  "error": "<string>"
}

CLI:

pixie email account create --username <username> --domain-id <domain-id>
pixie email account create --username <username> --domain-id <domain-id> --display-name <display-name> --first-name <first-name> --last-name <last-name>

Overview

Provisions a new inbox. The server creates the backing inbox on a verified custom domain, registers the account for warmup, creates/assigns the account tag, and inserts the row into the accounts table with type = "email". Warmup analytics live behind a separate endpoint — GET /api/email/accounts/warmup-analytics — and are not returned here.

This operation shares the URL path /api/email/accounts with the list verb. See List inboxes to enumerate existing inboxes.

AI agent notes

Prerequisite: a verified domain. createEmailAccount rejects any domain_id whose backing email_domains.status is not verified. The usual flow is:

createEmailDomain — register the domain, DNS auto-synced when Pixie can manage the zone.
Poll verifyEmailDomain with ?poll=true on a cadence until status === "verified" (or status === "failed").
Only then call createEmailAccount with that domain_id.

Side effects on create. Several external operations run in sequence: backing inbox creation, warmup registration, tag creation/assignment, and the final Supabase insert. If any step after inbox creation fails, the backing inbox is cleaned up when possible. Some backing providers block reusing the local part of a previously-deleted inbox — callers will see a 409 if they try.Warmup blocks sending. Accounts with status: "warming" will NOT send campaign emails until warmup completes (or is disabled). Plan for a warmup window before scheduling the first real campaign.

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Required: username + domain_id. The full address is composed as <username>@<domain>. Provisioning creates the backing inbox, registers warmup, creates or assigns tags, and inserts the DB row; partial failures trigger best-effort rollback.

username

string

required

Local part of the email (everything before @). Lowercased server-side. Only a-z, 0-9, ., -, _ are allowed.

Minimum string length: 1

domain_id

string<uuid>

required

UUID of an email_domains row owned by the caller. The domain's status must be verified — see POST /api/email/domains/{id}/verify.

display_name

string

Human-friendly sender name. If omitted and first_name/last_name are set, display_name is derived from them.

first_name

string

last_name

string

Response

Account created. If warmup enablement succeeded, status is warming and warmup_status is warming. If warmup failed, status is pending and the client can retry via retry-account-warmup.

account

object

required

A Pixie-managed email sending inbox. Each account row maps to one backing inbox and optional warmup registration.

Show child attributes

​Overview

​AI agent notes

Authorizations

Body

Response

Overview

AI agent notes