Sign in
Email

Update email

Update email object.

put/api/v1/emails/{emailID}

Path parameters

emailIDinteger required

Email ID

Request body

idinteger

ID of the email

urlstring uri

URL of the email

queuestring uri

Queue URL.

inboxstring uri

URL of the associated inbox

parentstring uri nullable

URL of the parent email

email_threadstring uri nullable

URL of the associated email thread

childrenstring[]

List of URLs of the children emails

documentsstring[]

List of documents attached to email

created_atstring date-time

Timestamp of incoming email

last_thread_email_created_atstring date-time nullable

(Deprecated) Timestamp of the most recent email in this email thread

subjectstring nullable

Email subject

body_text_plainstring nullable

Plain text email section (shortened to 4kB)

body_text_htmlstring nullable

HTML email section (shortened to 4kB)

metadataMetadata

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

type'incoming' | 'outgoing'

Email type. Can be incoming or outgoing

annotationsstring[]

List of URLs of annotations that arrived via email

related_annotationsstring[]

List of URLs of annotations that are related to the email (e.g. rejected by that, added as attachment etc.)

related_documentsstring[]

List of URLs of documents related to the email (e.g. by forwarding email containing document as attachment etc.)

creatorstring uri nullable

User that have sent the email. null if email has been received via SMTP

filtered_out_document_countinteger

This attribute is intended for INTERNAL use only and may be changed in the future without notice. Number of documents automatically filtered out by Rossum smart inbox (this feature can be configured in inbox settings).

labelsstring[]

List of email labels. Email objects can have assigned any number of labels.

Label nameDescription
rejectionOutgoing informative email sent by Rossum after email was manually rejected.
automatic_rejectionInformative automatic email sent by Rossum when no document was extracted from incoming email.
automatic_status_changed_infoInformative automatic email sent by Rossum about document status change.
rejectedIncoming email rejected together with all attached documents.
forwardedOutgoing email sent by forwarding other email.
replyOutgoing email sent by replying to another email.
contentstring uri

URL of the emails content.

Example request

{
  "id": 1234,
  "url": "https://example.rossum.app/api/v1/emails/1234",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "inbox": "https://example.rossum.app/api/v1/inboxes/1229",
  "parent": "https://example.rossum.app/api/v1/emails/1234",
  "email_thread": "https://example.rossum.app/api/v1/email_threads/456",
  "children": [
    "https://example.rossum.app/api/v1/emails/1244"
  ],
  "documents": [
    "https://example.rossum.app/api/v1/documents/5678"
  ],
  "created_at": "2021-03-26T14:31:46.993427Z",
  "last_thread_email_created_at": "2021-03-27T14:29:48.665478Z",
  "subject": "Some email subject",
  "from": {
    "email": "company@east-west.com",
    "name": "Company East"
  },
  "to": [
    {
      "email": "east-west-trading-co-a34f3a@example.rossum.app",
      "name": "East West Trading"
    }
  ],
  "cc": [],
  "bcc": [],
  "body_text_plain": "Some body",
  "body_text_html": "<div dir=\"ltr\">Some body</div>",
  "metadata": {
    "some_key": "some_value"
  },
  "type": "outgoing",
  "annotation_counts": {
    "annotations": 3,
    "annotations_processed": 1,
    "annotations_unprocessed": 1,
    "annotations_rejected": 1
  },
  "annotations": [
    "https://example.rossum.app/api/v1/annotations/1",
    "https://example.rossum.app/api/v1/annotations/2",
    "https://example.rossum.app/api/v1/annotations/4"
  ],
  "related_annotations": [],
  "related_documents": [
    "https://example.rossum.app/api/v1/documents/3"
  ],
  "creator": "https://example.rossum.app/api/v1/users/10775",
  "filtered_out_document_count": 2,
  "labels": [
    "rejected"
  ],
  "content": "https://example.rossum.app/api/v1/emails/1234"
}

Response

OK

idinteger required

ID of the email

urlstring uri required

URL of the email

queuestring uri required

Queue URL.

inboxstring uri required

URL of the associated inbox

parentstring uri nullable required

URL of the parent email

email_threadstring uri nullable required

URL of the associated email thread

childrenstring[] required

List of URLs of the children emails

documentsstring[] required

List of documents attached to email

created_atstring date-time required

Timestamp of incoming email

last_thread_email_created_atstring date-time nullable required

(Deprecated) Timestamp of the most recent email in this email thread

subjectstring nullable required

Email subject

body_text_plainstring nullable required

Plain text email section (shortened to 4kB)

body_text_htmlstring nullable required

HTML email section (shortened to 4kB)

metadataMetadata required

Client data. May be used to store e.g. external system object IDs. See Metadata for more details.

type'incoming' | 'outgoing' required

Email type. Can be incoming or outgoing

annotationsstring[] required

List of URLs of annotations that arrived via email

related_annotationsstring[] required

List of URLs of annotations that are related to the email (e.g. rejected by that, added as attachment etc.)

related_documentsstring[] required

List of URLs of documents related to the email (e.g. by forwarding email containing document as attachment etc.)

creatorstring uri nullable required

User that have sent the email. null if email has been received via SMTP

filtered_out_document_countinteger required

This attribute is intended for INTERNAL use only and may be changed in the future without notice. Number of documents automatically filtered out by Rossum smart inbox (this feature can be configured in inbox settings).

labelsstring[] required

List of email labels. Email objects can have assigned any number of labels.

Label nameDescription
rejectionOutgoing informative email sent by Rossum after email was manually rejected.
automatic_rejectionInformative automatic email sent by Rossum when no document was extracted from incoming email.
automatic_status_changed_infoInformative automatic email sent by Rossum about document status change.
rejectedIncoming email rejected together with all attached documents.
forwardedOutgoing email sent by forwarding other email.
replyOutgoing email sent by replying to another email.
contentstring uri

URL of the emails content.

Example response

{
  "id": 1234,
  "url": "https://example.rossum.app/api/v1/emails/1234",
  "queue": "https://example.rossum.app/api/v1/queues/8198",
  "inbox": "https://example.rossum.app/api/v1/inboxes/1229",
  "parent": "https://example.rossum.app/api/v1/emails/1234",
  "email_thread": "https://example.rossum.app/api/v1/email_threads/456",
  "children": [
    "https://example.rossum.app/api/v1/emails/1244"
  ],
  "documents": [
    "https://example.rossum.app/api/v1/documents/5678"
  ],
  "created_at": "2021-03-26T14:31:46.993427Z",
  "last_thread_email_created_at": "2021-03-27T14:29:48.665478Z",
  "subject": "Some email subject",
  "from": {
    "email": "company@east-west.com",
    "name": "Company East"
  },
  "to": [
    {
      "email": "east-west-trading-co-a34f3a@example.rossum.app",
      "name": "East West Trading"
    }
  ],
  "cc": [],
  "bcc": [],
  "body_text_plain": "Some body",
  "body_text_html": "<div dir=\"ltr\">Some body</div>",
  "metadata": {
    "some_key": "some_value"
  },
  "type": "outgoing",
  "annotation_counts": {
    "annotations": 3,
    "annotations_processed": 1,
    "annotations_unprocessed": 1,
    "annotations_rejected": 1
  },
  "annotations": [
    "https://example.rossum.app/api/v1/annotations/1",
    "https://example.rossum.app/api/v1/annotations/2",
    "https://example.rossum.app/api/v1/annotations/4"
  ],
  "related_annotations": [],
  "related_documents": [
    "https://example.rossum.app/api/v1/documents/3"
  ],
  "creator": "https://example.rossum.app/api/v1/users/10775",
  "filtered_out_document_count": 2,
  "labels": [
    "rejected"
  ],
  "content": "https://example.rossum.app/api/v1/emails/1234"
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.