Saltar al contenido
Esc
↑↓navegar↵abrir⌘Jvista previa

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}
Autorización
AuthorizationToken Bearer · headerobligatorio

A BillionSend API key (bs_…).

Parámetros de ruta
inbox_idstringobligatorio

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

thread_idstring<uuid>obligatorio

The thread ID

Cuerpo de la solicitud
application/json
readboolean

Marks every message read or unread

folderstring

sent is assigned, never chosen

Valores permitidos:inboxarchivespamtrash
Respuestas
200

Thread updated

objectstringobligatorio
Valores permitidos:inbox_thread
idstring<uuid>obligatorio
subjectstring | nullobligatorio
folderstringobligatorio
Valores permitidos:inboxarchivespamsenttrash
labelsobject[]obligatorio
Mostrar propiedades
Array de object
idstring<uuid>obligatorio
namestringobligatorio
colorstringobligatorio
readbooleanobligatorio
quarantinedintegerobligatorio

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

401

Missing, malformed, unknown or revoked API key

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
404

Inbox or thread not found

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
422

Validation error

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
429

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

statusCodenumberobligatorio
namestringobligatorio
messagestringobligatorio
Pruébalo
Servidor
Autorización
Parámetros
Cuerpoapplication/json
Solicitud
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"
}'
Respuesta
{
  "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
}

¿Te ha resultado útil esta página?