Conversations

Update inbox address

Changed on

Sets a branded inbox address {localPart}@{domain} on one of your receiving domains, or clears it when both fields are null. The address is active once the receiving domain is verified; the default address keeps working. Every other address on the domain reaches the inbox too; the branded one is the address to share. Returns the same body as Get Inbox Address.

put/conversations/inbox-address

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/conversations/inbox-address
  • Auth
    HTTP bearer

Request body

localPartstring nullable required

Name before the @, such as support. Letters, numbers, dots, dashes and underscores, starting and ending with a letter or number. Stored in lowercase. Null to clear.

domainstring nullable required

One of your receiving domains, by name, such as acme.com. For compatibility, the name of a sending domain whose earlier reply setup moved to a receiving domain is also accepted and uses that receiving domain. A verified sending domain with no earlier setup gets its inbound host (usually inbound.{root}) added as the workspace's one receiving domain, or fails with 409 limit_reached when the workspace already has a different one. Null to clear.

Response

Inbox address updated

successboolean
inboxobject

Same shape as Get Inbox Address.

Example response

{
  "success": true
}

Changes