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órioA BillionSend API key (bs_…).
Parâmetros de caminho
inbox_idstringobrigatórioThe inbox ID or its email address, such as support@example.com
thread_idstring<uuid>obrigatórioThe thread ID
Corpo da requisição
application/jsonreadbooleanMarks every message read or unread
folderstringsent is assigned, never chosen
Valores permitidos:
inboxarchivespamtrashRespostas
200
Thread updated
objectstringobrigatórioValores permitidos:
inbox_threadidstring<uuid>obrigatóriosubjectstring | nullobrigatóriofolderstringobrigatórioValores permitidos:
inboxarchivespamsenttrashlabelsobject[]obrigatórioMostrar propriedadesOcultar propriedades
Array de
objectidstring<uuid>obrigatórionamestringobrigatóriocolorstringobrigatórioreadbooleanobrigatórioquarantinedintegerobrigatórioBillionSend extension: held messages; 0 for inbox-scoped keys
401
Missing, malformed, unknown or revoked API key
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório404
Inbox or thread not found
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório422
Validation error
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório429
Over the rate limit (rate_limit_exceeded, with Retry-After)
statusCodenumberobrigatórionamestringobrigatóriomessagestringobrigatório