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

Update a thread

Mark every message read or unread, or move it to inbox, archive, spam or trash (moving out of trash restores it). Labels have their own routes: POST, PUT and DELETE /inboxes/{inbox_id}/threads/{thread_id}/labels.

PATCH/inboxes/{inbox_id}/threads/{thread_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

thread_idstring<uuid>requis

The thread ID

Corps de la requête
application/json
readboolean

Marks every message read or unread

folderstring

sent is assigned, never chosen

Valeurs autorisées :inboxarchivespamtrash
Réponses
200

Thread updated

objectstringrequis
Valeurs autorisées :inbox_thread
idstring<uuid>requis
subjectstring | nullrequis
folderstringrequis
Valeurs autorisées :inboxarchivespamsenttrash
labelsobject[]requis
Afficher les propriétés
Tableau de object
idstring<uuid>requis
namestringrequis
colorstringrequis
readbooleanrequis
quarantinedintegerrequis

BillionSend extension: held messages; 0 for inbox-scoped keys

401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Inbox or thread not found

statusCodenumberrequis
namestringrequis
messagestringrequis
422

Validation error

statusCodenumberrequis
namestringrequis
messagestringrequis
429

Over the rate limit (rate_limit_exceeded, with Retry-After)

statusCodenumberrequis
namestringrequis
messagestringrequis
Essayer
Serveur
Autorisation
Paramètres
Corpsapplication/json
Requête
curl -X PATCH 'https://api.billionsend.com/inboxes/string/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "read": true,
  "folder": "inbox"
}'
Réponse
{
  "object": "inbox_thread",
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "subject": "string",
  "folder": "inbox",
  "labels": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "color": "string"
    }
  ],
  "read": true,
  "quarantined": 0
}

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