Aller au contenu
Esc
↑↓naviguer↵ouvrir⌘Japerçu

Update an inbox

Its name or from_name; BillionSend 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.

PATCH/inboxes/{inbox_id}
Autorisation
AuthorizationJeton Bearer · headerrequis

A BillionSend API key (bs_…).

Paramètres de chemin
inbox_idstringrequis

The inbox ID or its email address, such as support@example.com

Corps de la requête
application/json
namestring
from_namestring

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

expires_instring | null

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

Réponses
200

Inbox updated

objectstringrequis
Valeurs autorisées :inbox
idstring<uuid>requis
namestringrequis
email_addressstringrequis
domain_idstring<uuid>requis

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

receiving_addressstring | nullrequis
from_namestring | nullrequis
unreadintegerrequis

Threads with an unread message

draftsintegerrequis

Unsent drafts

last_receivedstring | nullrequis
created_atstringrequis
updated_atstringrequis
kindstringrequis
Valeurs autorisées :agenthuman
sharedbooleanrequis

On the shared inbox domain

expires_atstring | nullrequis
quarantinedintegerrequis

Held messages not yet released

pending_approvalintegerrequis

Drafts waiting for a person

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Too many names reviewed or refused on the shared domain today, or the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
503

A new from_name on the shared domain can't be reviewed right now; retry-after says when to try again

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Corpsapplication/json
Requête
curl -X PATCH 'https://api.billionsend.com/inboxes/string' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "from_name": "string",
  "expires_in": "string"
}'
Réponse
{
  "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",
  "updated_at": "string",
  "kind": "agent",
  "shared": true,
  "expires_at": "string",
  "quarantined": 0,
  "pending_approval": 0
}

Cette page vous a-t-elle été utile ?