Sign in
Email Thread

Partial update email thread

Update part of email thread object.

patch/api/v1/email_threads/{emailThreadID}

Path parameters

emailThreadIDinteger required

ID of the email thread

Request body

idinteger

ID of the email thread.

urlstring uri

URL of the email thread.

organizationstring uri

Organization URL.

queuestring uri

Queue URL.

root_emailstring uri

URL of the associated root email (first incoming email in the thread).

has_repliesboolean

True if the thread has more than one incoming emails.

has_new_repliesboolean

True if the thread has unread incoming emails.

root_email_readboolean

True if the root email has been opened in Rossum UI at least once.

created_atstring date-time

Timestamp of the creation of email thread (inherited from arrived_at timestamp of the root email).

last_email_created_atstring date-time

Timestamp of the most recent email in this email thread.

subjectstring

Subject of the root email.

labelsstring[]

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.

Example request

{
  "id": 1244,
  "url": "https://example.rossum.app/api/v1/email_threads/456",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "root_email": "https://example.rossum.app/api/v1/emails/1234",
  "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
  }
}

Response

OK

idinteger required

ID of the email thread.

urlstring uri required

URL of the email thread.

organizationstring uri required

Organization URL.

queuestring uri required

Queue URL.

root_emailstring uri required

URL of the associated root email (first incoming email in the thread).

has_repliesboolean required

True if the thread has more than one incoming emails.

has_new_repliesboolean required

True if the thread has unread incoming emails.

root_email_readboolean required

True if the root email has been opened in Rossum UI at least once.

created_atstring date-time required

Timestamp of the creation of email thread (inherited from arrived_at timestamp of the root email).

last_email_created_atstring date-time required

Timestamp of the most recent email in this email thread.

subjectstring required

Subject of the root email.

labelsstring[] required

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.

Example response

{
  "id": 1244,
  "url": "https://example.rossum.app/api/v1/email_threads/456",
  "organization": "https://example.rossum.app/api/v1/organizations/406",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "root_email": "https://example.rossum.app/api/v1/emails/1234",
  "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
  }
}

Changes