Email Thread
An email thread object represents thread of related objects in Rossum's inbox.
Email thread
ID of the email thread.
URL of the email thread.
Organization URL.
Queue URL.
URL of the associated root email (first incoming email in the thread).
True if the thread has more than one incoming emails.
True if the thread has unread incoming emails.
True if the root email has been opened in Rossum UI at least once.
Timestamp of the creation of email thread (inherited from arrived_at timestamp of the root email).
Timestamp of the most recent email in this email thread.
Subject of the root email.
This attribute is intended for INTERNAL use only and may be changed without notice.
List of email thread labels set by root email. If root email is rejected and no other
incoming emails are in thread, labels field is set to [rejected]. Labels is an empty
list in all the other cases.
List email threads
GET api / v1 / email_threads
Retrieve all email thread objects.
curl -X GET "https://example.rossum.app/api/v1/email_threads"{
"pagination": {
"next": null,
"previous": null
},
"results": [
{
"id": 1244,
"url": "https://example.rossum.app/api/v1/email_threads/456",
"organization": "string",
"queue": "https://example.rossum.app/api/v1/queues/8198",
"root_email": "https://example.rossum.app/api/v1/emails/1234",
"has_replies": false,
"has_new_replies": false,
"root_email_read": false,
"created_at": "2021-06-10T12:38:44.866180Z",
"last_email_created_at": "2021-11-01T18:02:24.740600Z",
"subject": "Root email subject",
"from": {
"email": "satisfied.customer@rossum.ai",
"name": "Satisfied Customer"
},
"labels": [],
"annotation_counts": {
"annotations": 4,
"annotations_processed": 2,
"annotations_purged": 0,
"annotations_rejected": 1,
"annotations_unprocessed": 1
}
}
]
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Retrieve email thread
GET api / v1 / email_threads / {emailThreadID}
Get an email thread object.
curl -X GET "https://example.rossum.app/api/v1/email_threads/0"{
"id": 1244,
"url": "https://example.rossum.app/api/v1/email_threads/456",
"organization": "string",
"queue": "https://example.rossum.app/api/v1/queues/8198",
"root_email": "https://example.rossum.app/api/v1/emails/1234",
"has_replies": false,
"has_new_replies": false,
"root_email_read": false,
"created_at": "2021-06-10T12:38:44.866180Z",
"last_email_created_at": "2021-11-01T18:02:24.740600Z",
"subject": "Root email subject",
"from": {
"email": "satisfied.customer@rossum.ai",
"name": "Satisfied Customer"
},
"labels": [],
"annotation_counts": {
"annotations": 4,
"annotations_processed": 2,
"annotations_purged": 0,
"annotations_rejected": 1,
"annotations_unprocessed": 1
}
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Response
OK
ID of the email thread.
URL of the email thread.
Organization URL.
Queue URL.
URL of the associated root email (first incoming email in the thread).
True if the thread has more than one incoming emails.
True if the thread has unread incoming emails.
True if the root email has been opened in Rossum UI at least once.
Timestamp of the creation of email thread (inherited from arrived_at timestamp of the root email).
Timestamp of the most recent email in this email thread.
Subject of the root email.
This attribute is intended for INTERNAL use only and may be changed without notice.
List of email thread labels set by root email. If root email is rejected and no other
incoming emails are in thread, labels field is set to [rejected]. Labels is an empty
list in all the other cases.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Partial update email thread
PATCH api / v1 / email_threads / {emailThreadID}
Update part of email thread object.
curl -X PATCH "https://example.rossum.app/api/v1/email_threads/0" \ -H "Content-Type: application/json" \ -d '{}'{
"id": 1244,
"url": "https://example.rossum.app/api/v1/email_threads/456",
"organization": "string",
"queue": "https://example.rossum.app/api/v1/queues/8198",
"root_email": "https://example.rossum.app/api/v1/emails/1234",
"has_replies": false,
"has_new_replies": false,
"root_email_read": false,
"created_at": "2021-06-10T12:38:44.866180Z",
"last_email_created_at": "2021-11-01T18:02:24.740600Z",
"subject": "Root email subject",
"from": {
"email": "satisfied.customer@rossum.ai",
"name": "Satisfied Customer"
},
"labels": [],
"annotation_counts": {
"annotations": 4,
"annotations_processed": 2,
"annotations_purged": 0,
"annotations_rejected": 1,
"annotations_unprocessed": 1
}
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
URL of the email thread.
Organization URL.
Queue URL.
True if the thread has unread incoming emails.
Response
OK
ID of the email thread.
URL of the email thread.
Organization URL.
Queue URL.
URL of the associated root email (first incoming email in the thread).
True if the thread has more than one incoming emails.
True if the thread has unread incoming emails.
True if the root email has been opened in Rossum UI at least once.
Timestamp of the creation of email thread (inherited from arrived_at timestamp of the root email).
Timestamp of the most recent email in this email thread.
Subject of the root email.
This attribute is intended for INTERNAL use only and may be changed without notice.
List of email thread labels set by root email. If root email is rejected and no other
incoming emails are in thread, labels field is set to [rejected]. Labels is an empty
list in all the other cases.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error
Update email thread
PUT api / v1 / email_threads / {emailThreadID}
Update email thread object.
curl -X PUT "https://example.rossum.app/api/v1/email_threads/0" \ -H "Content-Type: application/json" \ -d '{ "has_new_replies": false }'{
"id": 1244,
"url": "https://example.rossum.app/api/v1/email_threads/456",
"organization": "string",
"queue": "https://example.rossum.app/api/v1/queues/8198",
"root_email": "https://example.rossum.app/api/v1/emails/1234",
"has_replies": false,
"has_new_replies": false,
"root_email_read": false,
"created_at": "2021-06-10T12:38:44.866180Z",
"last_email_created_at": "2021-11-01T18:02:24.740600Z",
"subject": "Root email subject",
"from": {
"email": "satisfied.customer@rossum.ai",
"name": "Satisfied Customer"
},
"labels": [],
"annotation_counts": {
"annotations": 4,
"annotations_processed": 2,
"annotations_purged": 0,
"annotations_rejected": 1,
"annotations_unprocessed": 1
}
}{
"detail": "Bad Request.",
"code": "bad_request"
}{
"detail": "Invalid token.",
"code": "authentication_failed"
}{
"detail": "Access to the requested resource is forbidden.",
"code": "access_forbidden"
}{
"detail": "Not found.",
"code": "not_found"
}{
"detail": "Conflict.",
"code": "conflict_status"
}{
"detail": "Payload Too Large.",
"code": "payload_too_large"
}{
"detail": "Request was rate limited.",
"code": "rate_limited",
"url": "https://rossum.app/api/docs/openapi/guides/overview/#rate-limiting"
}{
"detail": "Server error.",
"code": "error"
}{
"detail": "Bad Gateway.",
"code": "bad_gateway"
}{
"detail": "Service Unavailable.",
"code": "service_unavailable"
}{
"detail": "Gateway timeout.",
"code": "gateway_timeout"
}Request Body
application/json
URL of the email thread.
Organization URL.
Queue URL.
True if the thread has unread incoming emails.
Response
OK
ID of the email thread.
URL of the email thread.
Organization URL.
Queue URL.
URL of the associated root email (first incoming email in the thread).
True if the thread has more than one incoming emails.
True if the thread has unread incoming emails.
True if the root email has been opened in Rossum UI at least once.
Timestamp of the creation of email thread (inherited from arrived_at timestamp of the root email).
Timestamp of the most recent email in this email thread.
Subject of the root email.
This attribute is intended for INTERNAL use only and may be changed without notice.
List of email thread labels set by root email. If root email is rejected and no other
incoming emails are in thread, labels field is set to [rejected]. Labels is an empty
list in all the other cases.
Invalid input data.
Detail of the error
Code of the error
The username/password is invalid or token is invalid (e.g. expired).
Detail of the error
Code of the error
Insufficient permission, missing authentication, invalid CSRF token and similar issue.
Detail of the error
Code of the error
The specified resource was not found.
Detail of the error
Code of the error
Conflict
Detail of the error
Code of the error
Payload too large (especially for files uploaded).
Detail of the error
Code of the error
Request rate is too high, wait before sending more requests. See Rate Limiting for more details.
Detail of the error
Code of the error
Link to the rate limiting documentation
Server failure while processing the request.
Detail of the error
Code of the error
Invalid response from the upstream server.
Detail of the error
Code of the error
We're temporarily offline for maintenance. Please try again later.
Detail of the error
Code of the error
Upstream server could not complete the request in time.
Detail of the error
Code of the error