Zum Inhalt springen

UpdateInboxAddress

PUT
/api/v1/t/{tenant}/ingestion/addresses/{addressId}
curl --request PUT \
--url https://example.com/api/v1/t/example/ingestion/addresses/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
--header 'Content-Type: application/json' \
--data '{ "documentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "fileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "tagIds": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "confidential": true, "version": 1 }'
tenant
required
string

Tenant slug

addressId
required
string format: uuid
Media typeapplication/json
object
documentTypeId
required
null | string format: uuid
fileId
required
null | string format: uuid
tagIds
required
Array<string> | null
confidential
required
boolean
version
required
integer format: uint32
Examplegenerated
{
"documentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"fileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"tagIds": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"confidential": true,
"version": 1
}

OK

Media typeapplication/json
object
id
required
string format: uuid
tag
required
string
address
required
string
dottedAddress
required
string
documentTypeId
required
null | string format: uuid
fileId
required
null | string format: uuid
tagIds
required
Array<string>
confidential
required
boolean
messageCount
required
integer format: int32
createdBy
required
string format: uuid
createdAt
required
string format: date-time
version
required
integer format: uint32
Examplegenerated
{
"id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"tag": "example",
"address": "example",
"dottedAddress": "example",
"documentTypeId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"fileId": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"tagIds": [
"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
],
"confidential": true,
"messageCount": 1,
"createdBy": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
"createdAt": "2026-04-15T12:00:00Z",
"version": 1
}

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"
]
}
}

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"
}

Not Found

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"
}

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"
}