ROrossum
Email

Import email

Import an email as raw data. Calling this endpoint starts an asynchronous process of creating an email object and importing its contents to the specified recipient inbox in Rossum. This endpoint can be used only by admin and organization_group_admin roles and email can be imported only to inboxes within the organization. The caller of this endpoint will be specified as the creator of the email. The email sender specified in the from header will still receive any automated notifications targeted to the email recipients.

Import email endpoint is asynchronous and response contains created task url. Further information about the import status may be acquired by retrieving the email object or the task (for more information, please refer to task.

post/api/v1/emails/import

Request

Request body multipart/form-data

raw_messagestring binary required

Raw email data.

recipientstring email required

Email address of the inbox where the email will be imported.

metadatastring

JSON object with metadata to be set on created annotations.

valuesstring

JSON object with values to be set on created annotations. All keys must start with the emails_import: prefix (e.g., emails_import:customer_id).

Example request

{
  "metadata": "{\"source\":\"rossum\",\"batch_id\":\"12345\"}",
  "values": "{\"emails_import:customer_id\":\"CUST-001\",\"emails_import:order_number\":\"ORD-456\"}"
}

Response

Accepted

urlstring uri

URL of the created task

Example response

{
  "url": "https://example.rossum.app/api/v1/tasks/1"
}

Changes

No recorded changes to this operation across all 14 revisions of this API.