Get Inbox Address

GET

api

conversations

inbox-address

Get Inbox Address

curl --request GET \
  --url https://api.sequenzy.com/api/v1/conversations/inbox-address \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/conversations/inbox-address"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/conversations/inbox-address', 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.sequenzy.com/api/v1/conversations/inbox-address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/conversations/inbox-address"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/conversations/inbox-address")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "inbox": {
    "enabled": true,
    "address": "support@support.example.com",
    "defaultAddress": "inbox+comp_abc123@inbound.sequenzy.com",
    "addresses": [
      "support@support.example.com",
      "inbox+comp_abc123@inbound.sequenzy.com",
      "inbox+comp_abc123@support.example.com"
    ],
    "customAddress": {
      "localPart": "support",
      "domain": "support.example.com",
      "address": "support@support.example.com",
      "status": "active"
    },
    "attachmentsAvailable": true,
    "retentionDays": 90
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: conversations:read"
}

Get the email address that delivers straight to your inbox. People, services and other AI agents can write to it; each message opens a new conversation, or joins the conversation it answers. Replies to your campaigns, sequences and transactional email arrive in the same inbox through their own reply-to addresses. The default address is inbox+{companyId}@inbound.sequenzy.com and always works. You can also choose a branded address such as support@acme.com on one of your receiving domains with Update Inbox Address. Once it is active, address returns it. addresses lists the address to share, the default address and the same inbox+ address on each verified receiving domain. Every other address on a receiving domain also lands here. Email only arrives while receiving is on (enabled). Turn it on in Settings → Inbox, or with Update Company and replyTrackingEnabled. Email sent to the inbox address does not trigger email.replied webhooks or automations and is not auto-forwarded; it fires the email.received webhook instead. Mail that fails the spam or virus scan goes to the Spam folder and fires no webhook. Requires the conversations:read scope.

Request

This endpoint takes no parameters.

curl "https://api.sequenzy.com/api/v1/conversations/inbox-address" \
  -H "Authorization: Bearer YOUR_API_KEY"

Response fields

boolean

Whether the company receives email. When false, replies and inbox address email are not stored.

string

The address to share: your branded address once it is active, otherwise the default address.

string

inbox+{companyId}@inbound.sequenzy.com. Always works while receiving is on.

string[]

Addresses that currently deliver to this inbox, starting with address, then defaultAddress and inbox+{companyId}@ each verified receiving domain. Other addresses on your receiving domains also arrive but are not listed.

object | null

The branded address you chose, or null: localPart, domain (the receiving domain), address (localPart@domain) and status (active once the receiving domain is verified, otherwise pending).

boolean

Whether attachment content is stored, so attachments can be downloaded, forwarded and sent with replies.

integer

Days received email and its attachments are kept. At least 90.

Responses

{
  "success": true,
  "inbox": {
    "enabled": true,
    "address": "support@support.example.com",
    "defaultAddress": "inbox+comp_abc123@inbound.sequenzy.com",
    "addresses": [
      "support@support.example.com",
      "inbox+comp_abc123@inbound.sequenzy.com",
      "inbox+comp_abc123@support.example.com"
    ],
    "customAddress": {
      "localPart": "support",
      "domain": "support.example.com",
      "address": "support@support.example.com",
      "status": "active"
    },
    "attachmentsAvailable": true,
    "retentionDays": 90
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: conversations:read"
}

Get Inbox Address

curl --request GET \
  --url https://api.sequenzy.com/api/v1/conversations/inbox-address \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://api.sequenzy.com/api/v1/conversations/inbox-address"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.sequenzy.com/api/v1/conversations/inbox-address', 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.sequenzy.com/api/v1/conversations/inbox-address",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

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

curl_close($curl);

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

package main

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

func main() {

	url := "https://api.sequenzy.com/api/v1/conversations/inbox-address"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

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

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

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.sequenzy.com/api/v1/conversations/inbox-address")

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

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

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

{
  "success": true,
  "inbox": {
    "enabled": true,
    "address": "support@support.example.com",
    "defaultAddress": "inbox+comp_abc123@inbound.sequenzy.com",
    "addresses": [
      "support@support.example.com",
      "inbox+comp_abc123@inbound.sequenzy.com",
      "inbox+comp_abc123@support.example.com"
    ],
    "customAddress": {
      "localPart": "support",
      "domain": "support.example.com",
      "address": "support@support.example.com",
      "status": "active"
    },
    "attachmentsAvailable": true,
    "retentionDays": 90
  }
}

{
  "success": false,
  "error": "Unauthorized"
}

{
  "success": false,
  "error": "API key is missing required scope: conversations:read"
}