Create email endpoint

curl --request POST \
  --url https://api.hq.zone/v1/api/email/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "<string>",
  "localpart": "<string>",
  "allow_escalation": true,
  "allow_patterns": [
    "<string>"
  ],
  "category_policy": "<unknown>",
  "court_intake_enabled": true,
  "court_secure_mail_password": "<string>",
  "default_reply_lang": "<string>",
  "deliver_to": "<unknown>",
  "enabled": true,
  "instructions": "<string>",
  "max_turns_per_day": 123,
  "max_turns_per_sender_day": 123,
  "plane": "<string>",
  "reply_policy": "<string>",
  "sender_policy": "<string>",
  "spam_score_max": 123,
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.hq.zone/v1/api/email/endpoints"

payload = {
    "kind": "<string>",
    "localpart": "<string>",
    "allow_escalation": True,
    "allow_patterns": ["<string>"],
    "category_policy": "<unknown>",
    "court_intake_enabled": True,
    "court_secure_mail_password": "<string>",
    "default_reply_lang": "<string>",
    "deliver_to": "<unknown>",
    "enabled": True,
    "instructions": "<string>",
    "max_turns_per_day": 123,
    "max_turns_per_sender_day": 123,
    "plane": "<string>",
    "reply_policy": "<string>",
    "sender_policy": "<string>",
    "spam_score_max": 123,
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    kind: '<string>',
    localpart: '<string>',
    allow_escalation: true,
    allow_patterns: ['<string>'],
    category_policy: '<unknown>',
    court_intake_enabled: true,
    court_secure_mail_password: '<string>',
    default_reply_lang: '<string>',
    deliver_to: '<unknown>',
    enabled: true,
    instructions: '<string>',
    max_turns_per_day: 123,
    max_turns_per_sender_day: 123,
    plane: '<string>',
    reply_policy: '<string>',
    sender_policy: '<string>',
    spam_score_max: 123,
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.hq.zone/v1/api/email/endpoints', 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://api.hq.zone/v1/api/email/endpoints",
  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([
    'kind' => '<string>',
    'localpart' => '<string>',
    'allow_escalation' => true,
    'allow_patterns' => [
        '<string>'
    ],
    'category_policy' => '<unknown>',
    'court_intake_enabled' => true,
    'court_secure_mail_password' => '<string>',
    'default_reply_lang' => '<string>',
    'deliver_to' => '<unknown>',
    'enabled' => true,
    'instructions' => '<string>',
    'max_turns_per_day' => 123,
    'max_turns_per_sender_day' => 123,
    'plane' => '<string>',
    'reply_policy' => '<string>',
    'sender_policy' => '<string>',
    'spam_score_max' => 123,
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://api.hq.zone/v1/api/email/endpoints"

	payload := strings.NewReader("{\n  \"kind\": \"<string>\",\n  \"localpart\": \"<string>\",\n  \"allow_escalation\": true,\n  \"allow_patterns\": [\n    \"<string>\"\n  ],\n  \"category_policy\": \"<unknown>\",\n  \"court_intake_enabled\": true,\n  \"court_secure_mail_password\": \"<string>\",\n  \"default_reply_lang\": \"<string>\",\n  \"deliver_to\": \"<unknown>\",\n  \"enabled\": true,\n  \"instructions\": \"<string>\",\n  \"max_turns_per_day\": 123,\n  \"max_turns_per_sender_day\": 123,\n  \"plane\": \"<string>\",\n  \"reply_policy\": \"<string>\",\n  \"sender_policy\": \"<string>\",\n  \"spam_score_max\": 123,\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.hq.zone/v1/api/email/endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"<string>\",\n  \"localpart\": \"<string>\",\n  \"allow_escalation\": true,\n  \"allow_patterns\": [\n    \"<string>\"\n  ],\n  \"category_policy\": \"<unknown>\",\n  \"court_intake_enabled\": true,\n  \"court_secure_mail_password\": \"<string>\",\n  \"default_reply_lang\": \"<string>\",\n  \"deliver_to\": \"<unknown>\",\n  \"enabled\": true,\n  \"instructions\": \"<string>\",\n  \"max_turns_per_day\": 123,\n  \"max_turns_per_sender_day\": 123,\n  \"plane\": \"<string>\",\n  \"reply_policy\": \"<string>\",\n  \"sender_policy\": \"<string>\",\n  \"spam_score_max\": 123,\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hq.zone/v1/api/email/endpoints")

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  \"kind\": \"<string>\",\n  \"localpart\": \"<string>\",\n  \"allow_escalation\": true,\n  \"allow_patterns\": [\n    \"<string>\"\n  ],\n  \"category_policy\": \"<unknown>\",\n  \"court_intake_enabled\": true,\n  \"court_secure_mail_password\": \"<string>\",\n  \"default_reply_lang\": \"<string>\",\n  \"deliver_to\": \"<unknown>\",\n  \"enabled\": true,\n  \"instructions\": \"<string>\",\n  \"max_turns_per_day\": 123,\n  \"max_turns_per_sender_day\": 123,\n  \"plane\": \"<string>\",\n  \"reply_policy\": \"<string>\",\n  \"sender_policy\": \"<string>\",\n  \"spam_score_max\": 123,\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "allow_escalation": true,
  "allow_patterns": [
    "<string>"
  ],
  "awaiting_review": 123,
  "court_intake_enabled": true,
  "court_secure_mail_password_set": true,
  "created_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "escalated": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_system": true,
  "kind": "<string>",
  "localpart": "<string>",
  "message_count": 123,
  "needs_attention": 123,
  "plane": "<string>",
  "received": 123,
  "replied": 123,
  "reply_languages": "<unknown>",
  "reply_policy": "<string>",
  "sender_policy": "<string>",
  "unrouted": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category_policy": "<unknown>",
  "default_reply_lang": "<string>",
  "deliver_to": "<unknown>",
  "instructions": "<string>",
  "last_occurred_at": "2023-11-07T05:31:56Z",
  "max_turns_per_day": 123,
  "max_turns_per_sender_day": 123,
  "spam_score_max": 123
}

POST

api

endpoints

Create email endpoint

curl --request POST \
  --url https://api.hq.zone/v1/api/email/endpoints \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "kind": "<string>",
  "localpart": "<string>",
  "allow_escalation": true,
  "allow_patterns": [
    "<string>"
  ],
  "category_policy": "<unknown>",
  "court_intake_enabled": true,
  "court_secure_mail_password": "<string>",
  "default_reply_lang": "<string>",
  "deliver_to": "<unknown>",
  "enabled": true,
  "instructions": "<string>",
  "max_turns_per_day": 123,
  "max_turns_per_sender_day": 123,
  "plane": "<string>",
  "reply_policy": "<string>",
  "sender_policy": "<string>",
  "spam_score_max": 123,
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'

import requests

url = "https://api.hq.zone/v1/api/email/endpoints"

payload = {
    "kind": "<string>",
    "localpart": "<string>",
    "allow_escalation": True,
    "allow_patterns": ["<string>"],
    "category_policy": "<unknown>",
    "court_intake_enabled": True,
    "court_secure_mail_password": "<string>",
    "default_reply_lang": "<string>",
    "deliver_to": "<unknown>",
    "enabled": True,
    "instructions": "<string>",
    "max_turns_per_day": 123,
    "max_turns_per_sender_day": 123,
    "plane": "<string>",
    "reply_policy": "<string>",
    "sender_policy": "<string>",
    "spam_score_max": 123,
    "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
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({
    kind: '<string>',
    localpart: '<string>',
    allow_escalation: true,
    allow_patterns: ['<string>'],
    category_policy: '<unknown>',
    court_intake_enabled: true,
    court_secure_mail_password: '<string>',
    default_reply_lang: '<string>',
    deliver_to: '<unknown>',
    enabled: true,
    instructions: '<string>',
    max_turns_per_day: 123,
    max_turns_per_sender_day: 123,
    plane: '<string>',
    reply_policy: '<string>',
    sender_policy: '<string>',
    spam_score_max: 123,
    agent_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  })
};

fetch('https://api.hq.zone/v1/api/email/endpoints', 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://api.hq.zone/v1/api/email/endpoints",
  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([
    'kind' => '<string>',
    'localpart' => '<string>',
    'allow_escalation' => true,
    'allow_patterns' => [
        '<string>'
    ],
    'category_policy' => '<unknown>',
    'court_intake_enabled' => true,
    'court_secure_mail_password' => '<string>',
    'default_reply_lang' => '<string>',
    'deliver_to' => '<unknown>',
    'enabled' => true,
    'instructions' => '<string>',
    'max_turns_per_day' => 123,
    'max_turns_per_sender_day' => 123,
    'plane' => '<string>',
    'reply_policy' => '<string>',
    'sender_policy' => '<string>',
    'spam_score_max' => 123,
    'agent_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
  ]),
  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://api.hq.zone/v1/api/email/endpoints"

	payload := strings.NewReader("{\n  \"kind\": \"<string>\",\n  \"localpart\": \"<string>\",\n  \"allow_escalation\": true,\n  \"allow_patterns\": [\n    \"<string>\"\n  ],\n  \"category_policy\": \"<unknown>\",\n  \"court_intake_enabled\": true,\n  \"court_secure_mail_password\": \"<string>\",\n  \"default_reply_lang\": \"<string>\",\n  \"deliver_to\": \"<unknown>\",\n  \"enabled\": true,\n  \"instructions\": \"<string>\",\n  \"max_turns_per_day\": 123,\n  \"max_turns_per_sender_day\": 123,\n  \"plane\": \"<string>\",\n  \"reply_policy\": \"<string>\",\n  \"sender_policy\": \"<string>\",\n  \"spam_score_max\": 123,\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\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://api.hq.zone/v1/api/email/endpoints")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"kind\": \"<string>\",\n  \"localpart\": \"<string>\",\n  \"allow_escalation\": true,\n  \"allow_patterns\": [\n    \"<string>\"\n  ],\n  \"category_policy\": \"<unknown>\",\n  \"court_intake_enabled\": true,\n  \"court_secure_mail_password\": \"<string>\",\n  \"default_reply_lang\": \"<string>\",\n  \"deliver_to\": \"<unknown>\",\n  \"enabled\": true,\n  \"instructions\": \"<string>\",\n  \"max_turns_per_day\": 123,\n  \"max_turns_per_sender_day\": 123,\n  \"plane\": \"<string>\",\n  \"reply_policy\": \"<string>\",\n  \"sender_policy\": \"<string>\",\n  \"spam_score_max\": 123,\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.hq.zone/v1/api/email/endpoints")

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  \"kind\": \"<string>\",\n  \"localpart\": \"<string>\",\n  \"allow_escalation\": true,\n  \"allow_patterns\": [\n    \"<string>\"\n  ],\n  \"category_policy\": \"<unknown>\",\n  \"court_intake_enabled\": true,\n  \"court_secure_mail_password\": \"<string>\",\n  \"default_reply_lang\": \"<string>\",\n  \"deliver_to\": \"<unknown>\",\n  \"enabled\": true,\n  \"instructions\": \"<string>\",\n  \"max_turns_per_day\": 123,\n  \"max_turns_per_sender_day\": 123,\n  \"plane\": \"<string>\",\n  \"reply_policy\": \"<string>\",\n  \"sender_policy\": \"<string>\",\n  \"spam_score_max\": 123,\n  \"agent_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n}"

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

{
  "allow_escalation": true,
  "allow_patterns": [
    "<string>"
  ],
  "awaiting_review": 123,
  "court_intake_enabled": true,
  "court_secure_mail_password_set": true,
  "created_at": "2023-11-07T05:31:56Z",
  "enabled": true,
  "escalated": 123,
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "is_system": true,
  "kind": "<string>",
  "localpart": "<string>",
  "message_count": 123,
  "needs_attention": 123,
  "plane": "<string>",
  "received": 123,
  "replied": 123,
  "reply_languages": "<unknown>",
  "reply_policy": "<string>",
  "sender_policy": "<string>",
  "unrouted": 123,
  "updated_at": "2023-11-07T05:31:56Z",
  "agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "category_policy": "<unknown>",
  "default_reply_lang": "<string>",
  "deliver_to": "<unknown>",
  "instructions": "<string>",
  "last_occurred_at": "2023-11-07T05:31:56Z",
  "max_turns_per_day": 123,
  "max_turns_per_sender_day": 123,
  "spam_score_max": 123
}

Authorizations

Authorization

string

header

required

Personal Access Token. Send as Authorization: Bearer hq_pat_....

Body

application/json

The editable behavior fields. All optional on PATCH (a full-form replace); on create, missing values fall back to the DB column defaults.

kind

string

required

localpart

string

required

allow_escalation

boolean | null

allow_patterns

string[] | null

Replaces the allowlist set wholesale when present.

category_policy

any

court_intake_enabled

boolean | null

Court-document intake on/off (docs/court-document-intake.md). Omitted = keep current.

court_secure_mail_password

string | null

Secure-mail password for the court portal. WRITE-ONLY: a non-empty value is vault-sealed and stored; it is never echoed back. Omitted/empty = keep the stored password.

default_reply_lang

string | null

deliver_to

any

enabled

boolean | null

instructions

string | null

max_turns_per_day

integer<int32> | null

max_turns_per_sender_day

integer<int32> | null

plane

string | null

reply_policy

string | null

sender_policy

string | null

spam_score_max

number<float> | null

agent_id

string<uuid> | null

Response

Endpoint created

allow_escalation

boolean

required

allow_patterns

string[]

required

awaiting_review

integer<int64>

required

court_intake_enabled

boolean

required

Court-document intake (docs/court-document-intake.md) is enabled on this inbox: an inbound carrying a securemail.domstol.se link additionally downloads the court documents into the library. Off by default.

court_secure_mail_password_set

boolean

required

A secure-mail password is stored (vault-sealed) for this inbox. The password is write-only; this flag is the only thing the API discloses.

created_at

string<date-time>

required

enabled

boolean

required

escalated

integer<int64>

required

string<uuid>

required

is_system

boolean

required

True for the workspace outbound mailbox (HQ-managed): not deletable, not a normal custom inbox - the UI renders it as the workspace mailbox.

kind

string

required

localpart

string

required

message_count

integer<int64>

required

Total mail (in + out) attributed to this endpoint.

needs_attention

integer<int64>

required

Items needing a human (handling_state <> 'handled').

plane

string

required

received

integer<int64>

required

Disposition counters (E7.2): inbound received, outbound replies sent, per-state queues, and threads escalated light -> agent.

replied

integer<int64>

required

reply_languages

any

required

Reply-language distribution: { "English": 12, "Swedish": 3 }.

reply_policy

string

required

sender_policy

string

required

unrouted

integer<int64>

required

updated_at

string<date-time>

required

agent_id

string<uuid> | null

category_policy

any

default_reply_lang

string | null

deliver_to

any

instructions

string | null

last_occurred_at

string<date-time> | null

max_turns_per_day

integer<int32> | null

max_turns_per_sender_day

integer<int32> | null

spam_score_max

number<float> | null

Authentication

Me

Agents

Conversations

Documents

Memory

Tables

Schedules

Notifications

Integrations

Billing

Tokens

Onboarding

Help

Admin

Runs

Search

Create email endpoint

Authorizations

Body

Response