ROrossum
Inbox

Update inbox

Changed on

Update inbox object.

put/api/v1/inboxes/{inboxID}

Request

Path parameters

inboxIDinteger required

ID of the inbox

Request body

idinteger

ID of the inbox.

namestring

Name of the inbox (not visible in UI).

urlstring url

URL of the inbox.

queuesstring[]

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

emailstring email

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefixstring

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

bounce_email_tostring email nullable

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachmentsboolean

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

bounce_postponed_annotationsboolean

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

bounce_deleted_annotationsboolean

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

bounce_email_with_no_attachmentsboolean

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

metadataMetadata

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

dmarc_check_action'accept' | 'drop'

Decides what to do with incoming emails, that don't pass the DMARC check.

modified_bystring uri nullable

User that last modified the object.

modified_atstring date-time nullable

Timestamp of last modification.

Example request

{
  "id": 1234,
  "name": "Receipts",
  "url": "https://example.rossum.app/api/v1/inboxes/1234",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "email": "east-west-trading-co-a34f3a@example.rossum.app",
  "email_prefix": "east-west-trading-co",
  "bounce_email_to": "bounces@east-west.com",
  "bounce_email_with_no_attachments": true,
  "metadata": {
    "some_key": "some_value"
  },
  "filters": {
    "allowed_senders": [
      "*@rossum.ai",
      "john.doe@company.com",
      "john.doe@company.??"
    ],
    "denied_senders": [
      "spam@*"
    ],
    "document_rejection_conditions": {
      "enabled": true,
      "resolution_lower_than_px": [
        1200,
        600
      ],
      "mime_types": [
        "image/gif"
      ]
    }
  },
  "dmarc_check_action": "accept",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Response

OK

idinteger required

ID of the inbox.

namestring required

Name of the inbox (not visible in UI).

urlstring url required

URL of the inbox.

queuesstring[] required

Queue that receives documents from inbox. Queue has to be passed in list due to backward compatibility. It is possible to have only one queue per inbox.

emailstring email required

Rossum email address (e.g. east-west-trading-co-a34f3a@example.rossum.app).

email_prefixstring required

Rossum email address prefix (e.g. east-west-trading-co). Maximum length allowed is 57 chars.

bounce_email_tostring email nullable required

(Deprecated) Email address to send notifications to (e.g. about failed import). Configuration moved to Email notifications settings.

bounce_unprocessable_attachmentsboolean required

(Deprecated) Whether return back unprocessable attachments (e.g. MS Word docx) or just silently ignore them. When true, minimum image size requirement does not apply. Configuration moved to Email notifications settings.

bounce_postponed_annotationsboolean required

(Deprecated) Whether to send notification when annotation is postponed. Configuration moved to Email notifications settings.

bounce_deleted_annotationsboolean required

(Deprecated) Whether to send notification when annotation is deleted. Configuration moved to Email notifications settings.

bounce_email_with_no_attachmentsboolean required

(Deprecated) Whether to send notification when no processable documents were found. Configuration moved to Email notifications settings.

metadataMetadata required

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

dmarc_check_action'accept' | 'drop' required

Decides what to do with incoming emails, that don't pass the DMARC check.

modified_bystring uri nullable required

User that last modified the object.

modified_atstring date-time nullable required

Timestamp of last modification.

Example response

{
  "id": 1234,
  "name": "Receipts",
  "url": "https://example.rossum.app/api/v1/inboxes/1234",
  "queues": [
    "https://example.rossum.app/api/v1/queues/8199"
  ],
  "email": "east-west-trading-co-a34f3a@example.rossum.app",
  "email_prefix": "east-west-trading-co",
  "bounce_email_to": "bounces@east-west.com",
  "bounce_email_with_no_attachments": true,
  "metadata": {
    "some_key": "some_value"
  },
  "filters": {
    "allowed_senders": [
      "*@rossum.ai",
      "john.doe@company.com",
      "john.doe@company.??"
    ],
    "denied_senders": [
      "spam@*"
    ],
    "document_rejection_conditions": {
      "enabled": true,
      "resolution_lower_than_px": [
        1200,
        600
      ],
      "mime_types": [
        "image/gif"
      ]
    }
  },
  "dmarc_check_action": "accept",
  "modified_by": "https://example.rossum.app/api/v1/users/10775",
  "modified_at": "2021-04-26T10:08:03.856648Z"
}

Changes

  • f1b5a910991dRevision changes
    • breaking

      the response's body type changed from object to no type for status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • warning

      removed the optional property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status