Sign in
Suggested Edit

Create suggested edit

Create a new suggested edit object.

post/api/v1/suggested_edits

Request body

idinteger

ID of the suggested edit.

urlstring url

URL of the suggested edit.

annotationstring url

Annotation that suggested edit is related to.

Example request

{
  "id": 314528,
  "url": "https://example.rossum.app/api/v1/suggested_edits/314528",
  "annotation": "https://example.rossum.app/api/v1/annotations/314528",
  "documents": [
    {
      "pages": [
        {
          "page": "https://example.rossum.app/api/v1/pages/314554"
        }
      ],
      "target_queue": "https://example.rossum.app/api/v1/queues/314528",
      "values": {
        "edit:document_type": "invoice"
      }
    }
  ]
}

Response

Created

idinteger required

ID of the suggested edit.

urlstring url required

URL of the suggested edit.

annotationstring url required

Annotation that suggested edit is related to.

Example response

{
  "id": 314528,
  "url": "https://example.rossum.app/api/v1/suggested_edits/314528",
  "annotation": "https://example.rossum.app/api/v1/annotations/314528",
  "documents": [
    {
      "pages": [
        {
          "page": "https://example.rossum.app/api/v1/pages/314554"
        }
      ],
      "target_queue": "https://example.rossum.app/api/v1/queues/314528",
      "values": {
        "edit:document_type": "invoice"
      }
    }
  ]
}

Changes

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