Update Inbox Address

PUT

api

conversations

inbox-address

curl --request PUT \
  --url https://api.sequenzy.com/api/v1/conversations/inbox-address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "localPart": {},
  "domain": {}
}
'

import requests

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

payload = {
    "localPart": {},
    "domain": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({localPart: {}, domain: {}})
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'localPart' => [
        
    ],
    'domain' => [
        
    ]
  ]),
  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.sequenzy.com/api/v1/conversations/inbox-address"

	payload := strings.NewReader("{\n  \"localPart\": {},\n  \"domain\": {}\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.sequenzy.com/api/v1/conversations/inbox-address")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"localPart\": {},\n  \"domain\": {}\n}")
  .asString();

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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"localPart\": {},\n  \"domain\": {}\n}"

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

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

{
  "error": "Use 1-64 letters, numbers, dots, dashes or underscores, starting and ending with a letter or number.",
  "code": "invalid_local_part"
}

{
  "error": "Choose one of your receiving domains.",
  "code": "domain_not_found"
}

{
  "error": "support@acme.com is already used by another workspace.",
  "code": "address_taken"
}

{
  "error": "A workspace has one receiving domain. Remove it first to use a different one.",
  "code": "limit_reached"
}

Choose a branded inbox address such as support@acme.com on one of your receiving domains, or clear it to use only the default address. The address is localPart@domain, and customAddress.address in the response is the exact address. Every other address on the receiving domain lands in your Inbox too; the branded one is the address to share. The branded address is active once the receiving domain is verified. Until then customAddress.status is pending and address stays the default inbox+{companyId}@inbound.sequenzy.com, which keeps working either way. Check the domain with Verify Receiving Domain. Removing the receiving domain clears the branded address. Changing or clearing an active branded address stops the old address immediately. Requires the companies:manage scope, like other workspace settings. Reading the address with Get Inbox Address only needs conversations:read.

Request

string | null

required

Name before the @, such as support. 1 to 64 letters, numbers, dots, dashes or underscores, starting and ending with a letter or number. Stored in lowercase. Some names such as postmaster and abuse are reserved. Send null together with domain: null to clear the branded address.

string | null

required

The name of one of your receiving domains, such as acme.com. It does not need to be verified yet. For compatibility, the name of a verified sending domain is still accepted: it uses that domain’s receiving domain, adding inbound.{root domain} (pending until its MX record is published) when it has none, as before receiving domains. Adding that host counts as your one receiving domain: when you already have a different receiving domain, the request fails with limit_reached. A host added this way does not turn the Inbox on or change your reply addresses when it verifies. Send null together with localPart: null to clear.

curl -X PUT "https://api.sequenzy.com/api/v1/conversations/inbox-address" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"localPart": "support", "domain": "acme.com"}'

Go back to the default address:

curl -X PUT "https://api.sequenzy.com/api/v1/conversations/inbox-address" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"localPart": null, "domain": null}'

The response has the same shape as Get Inbox Address.

Responses

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

{
  "error": "Use 1-64 letters, numbers, dots, dashes or underscores, starting and ending with a letter or number.",
  "code": "invalid_local_part"
}

{
  "error": "Choose one of your receiving domains.",
  "code": "domain_not_found"
}

{
  "error": "support@acme.com is already used by another workspace.",
  "code": "address_taken"
}

{
  "error": "A workspace has one receiving domain. Remove it first to use a different one.",
  "code": "limit_reached"
}

Update Inbox Address

curl --request PUT \
  --url https://api.sequenzy.com/api/v1/conversations/inbox-address \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "localPart": {},
  "domain": {}
}
'

import requests

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

payload = {
    "localPart": {},
    "domain": {}
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({localPart: {}, domain: {}})
};

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 => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'localPart' => [
        
    ],
    'domain' => [
        
    ]
  ]),
  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.sequenzy.com/api/v1/conversations/inbox-address"

	payload := strings.NewReader("{\n  \"localPart\": {},\n  \"domain\": {}\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.sequenzy.com/api/v1/conversations/inbox-address")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"localPart\": {},\n  \"domain\": {}\n}")
  .asString();

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::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"localPart\": {},\n  \"domain\": {}\n}"

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

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

{
  "error": "Use 1-64 letters, numbers, dots, dashes or underscores, starting and ending with a letter or number.",
  "code": "invalid_local_part"
}

{
  "error": "Choose one of your receiving domains.",
  "code": "domain_not_found"
}

{
  "error": "support@acme.com is already used by another workspace.",
  "code": "address_taken"
}

{
  "error": "A workspace has one receiving domain. Remove it first to use a different one.",
  "code": "limit_reached"
}