Pular para o conteúdo
Esc
↑↓navegar↵abrir⌘Jpré-visualizar

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}
Autorização
AuthorizationToken Bearer · headerobrigatório

A BillionSend API key (bs_…).

Parâmetros de caminho
inbox_idstringobrigatório

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

thread_idstring<uuid>obrigatório

The thread ID

Corpo da requisição
application/json
readboolean

Marks every message read or unread

folderstring

sent is assigned, never chosen

Valores permitidos:inboxarchivespamtrash
Respostas
200

Thread updated

objectstringobrigatório
Valores permitidos:inbox_thread
idstring<uuid>obrigatório
subjectstring | nullobrigatório
folderstringobrigatório
Valores permitidos:inboxarchivespamsenttrash
labelsobject[]obrigatório
Mostrar propriedades
Array de object
idstring<uuid>obrigatório
namestringobrigatório
colorstringobrigatório
readbooleanobrigatório
quarantinedintegerobrigatório

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

401

Missing, malformed, unknown or revoked API key

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
404

Inbox or thread not found

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
422

Validation error

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
429

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

statusCodenumberobrigatório
namestringobrigatório
messagestringobrigatório
Experimentar
Servidor
Autorização
Parâmetros
Corpoapplication/json
Requisição
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"
}'
Resposta
{
  "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
}

Esta página foi útil?