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

Set a thread's labels

Replaces the thread’s labels with exactly these (up to 100; [] takes them all off). The labels stay in the inbox. If any label is unknown, nothing changes (404). Answers every label on the thread afterwards.

PUT/inboxes/{inbox_id}/threads/{thread_id}/labels
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
requisapplication/json
labelsstring<uuid>[]requis

Up to 100 label IDs of the inbox: exactly the labels the thread ends up with

max 100 éléments
Réponses
200

The labels on the thread

objectstringrequis
Valeurs autorisées :list
dataobject[]requis

Every label on the thread after the change

Afficher les propriétés
Tableau de object
idstring<uuid>requis
namestringrequis
colorstringrequis
401

Missing, malformed, unknown or revoked API key

statusCodenumberrequis
namestringrequis
messagestringrequis
404

Inbox, thread or label 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 PUT 'https://api.billionsend.com/inboxes/string/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/labels' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "labels": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}'
Réponse
{
  "object": "list",
  "data": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "name": "string",
      "color": "string"
    }
  ]
}

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