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 · headerobligatorioA BillionSend API key (bs_…).
Parámetros de ruta
inbox_idstringobligatorioThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>obligatorioThe thread ID
Cuerpo de la solicitud
application/jsonreadbooleanMarks every message read or unread
folderstringsent is assigned, never chosen
Valores permitidos:
inboxarchivespamtrashRespuestas
200
Thread updated
objectstringobligatorioValores permitidos:
inbox_threadidstring<uuid>obligatoriosubjectstring | nullobligatoriofolderstringobligatorioValores permitidos:
inboxarchivespamsenttrashlabelsobject[]obligatorioMostrar propiedadesOcultar propiedades
Array de
objectidstring<uuid>obligatorionamestringobligatoriocolorstringobligatorioreadbooleanobligatorioquarantinedintegerobligatorioBillionSend extension: held messages; 0 for inbox-scoped keys
401
Missing, malformed, unknown or revoked API key
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio404
Inbox or thread not found
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio422
Validation error
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobligatorionamestringobligatoriomessagestringobligatorio