Skip to content
AcrivaDocs

DiscardInboxMessage

POST
/api/v1/t/{tenant}/ingestion/messages/{messageId}/discard
curl --request POST \
  --url https://example.com/api/v1/t/example/ingestion/messages/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/discard \
  --header 'Content-Type: application/json' \
  --data '{ "version": 1 }'

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters”
tenant
required
string

Tenant slug

messageId
required
string format: uuid

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
version
required
integer format: uint32
Examplegenerated
{
  "version": 1
}

Responses

Section titled “ Responses ”

200

Section titled “200”

OK

Media typeapplication/json
object
id
required
string format: uuid
receivedAt
required
string format: date-time
sender
required
null | string
headerFrom
required
null | string
subject
required
null | string
addressId
required
null | string format: uuid
tag
required
null | string
otherTags
required
Array<string>
sizeBytes
required
null | integer format: int64
state
required
Allowed values: Accepted Processed WithoutAttachment Held Failed Discarded Refused
refusalReason
required
One of:
null
heldReason
required
One of:
null
verdicts
required
One of:
null
documents
required
Array<object>
object
documentId
required
string format: uuid
attachmentIndex
required
integer format: int32
fileName
required
null | string
hiddenDocumentCount
required
integer format: int32
processedAt
required
null | string format: date-time
releasedBy
required
null | string format: uuid
releasedAt
required
null | string format: date-time
discardedBy
required
null | string format: uuid
discardedAt
required
null | string format: date-time
recordAvailable
required
boolean
version
required
integer format: uint32
failureReason
required
One of:
null
failedAt
required
null | string format: date-time
retriedBy
required
null | string format: uuid
retriedAt
required
null | string format: date-time
skippedAttachments
required
Array<object>
object
reason
required
Allowed values: TooMany NotAllowed
count
required
integer format: int32
Example
{
  "state": "Accepted",
  "refusalReason": "SenderRefused",
  "heldReason": "AuthenticationFailed",
  "verdicts": {
    "spf": "None",
    "dkim": "None",
    "dmarc": "None",
    "action": "NoAction"
  },
  "failureReason": "GaveUp",
  "skippedAttachments": [
    {
      "reason": "TooMany"
    }
  ]
}

400

Section titled “400”

Bad Request

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
errors
object
key
additional properties
Array<string>
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example",
  "errors": {
    "additionalProperty": [
      "example"
    ]
  }
}

403

Section titled “403”

Forbidden

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

404

Section titled “404”

Not Found

409

Section titled “409”

Conflict

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

429

Section titled “429”

Too Many Requests

Media typeapplication/problem+json
object
type
null | string
title
null | string
status
null | integer format: int32
detail
null | string
instance
null | string
Examplegenerated
{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}