Skip to content

POST · Bearer

POST /api/v1/inboxes/:id/threads/move

Summary

Move 1 to 100 threads in this inbox to one folder. Body is {thread_ids, folder}. folder is inbox, archive, spam, or trash. The response is {moved, not_found} in request order. An unknown id in this inbox is not_found and is not an error. A thread already in that folder is listed in moved and does not emit thread.folder_updated. More than 100 ids is 400 too_many_ids. Duplicates are 400 duplicate_thread_ids. A bad folder is 400 invalid_folder. Same permission as PATCH thread labels (message_update). Another account's inbox is 404 inbox_not_found.

Request

{
  "thread_ids": [
    "thr_example"
  ],
  "folder": "archive"
}

Response

The OpenAPI document does not declare a JSON response schema for this call. The summary is the contract.

Errors

  • HTTP 400 too_many_ids
  • HTTP 400 duplicate_thread_ids
  • HTTP 400 invalid_folder
  • HTTP 404 inbox_not_found

Idempotency

This route does not document Idempotency-Key or client_id.