MillionSend Docs

Update an inbox

PATCH
/inboxes/{inbox_id}

Its name or from_name; MillionSend extension: expires_in, a new lifetime counted from now. On a shared-domain inbox a new from_name is reviewed first (503 while that review is unavailable). Returns the full inbox.

Path Parameters

inbox_id*string

The inbox ID

Formatuuid

Request Body

application/json
  1. body
name?string
from_name?string

"" removes it. On the shared domain a new one may not imitate a brand, and it is reviewed first where the instance reviews names (503 with retry-after while that review is unavailable).

expires_in?string

MillionSend extension: a new lifetime counted from now, "1h" to "365d"; null never expires

Response Body

Inbox updated

application/json
  1. response
object*"inbox"
Value in"inbox"
id*string
Formatuuid
name*string
email_address*string
domain_id*string

A shared address's is its team's shared subdomain: the GET /domains row with shared: true

Formatuuid
receiving_address*string
from_name*string
unread*integer

Threads with an unread message

drafts*integer

Unsent drafts

last_received*string
created_at*string
kind*string
Value in"agent""human"
shared*boolean

On the shared inbox domain

expires_at*string
quarantined*integer

Held messages not yet released

pending_approval*integer

Drafts waiting for a person

Example Request
curl -X PATCH 'https://api.millionsend.com/inboxes/497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "object": "inbox",  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "email_address": "string",  "domain_id": "b2f7354f-b74d-4332-ab10-1a5e3c56466c",  "receiving_address": "string",  "from_name": "string",  "unread": 0,  "drafts": 0,  "last_received": "string",  "created_at": "string",  "kind": "agent",  "shared": true,  "expires_at": "string",  "quarantined": 0,  "pending_approval": 0}