Documentation Powered by ReDoc

OX MIM - Mail Injection Middleware (1.1.0)

Download OpenAPI specification:Download

OX Software GmbH: info@open-xchange.com URL: http://open-xchange.com License: License of API

Mail Injection Middleware

behavior-tracking-api

Behavior Tracking Api

Tracking - Track an event

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

payload

end_time
string <date-time>
object (BehaviorTrackingPayload)
hostname
string
start_time
string <date-time>

Responses

Request samples

Content type
application/json
{
  • "end_time": "2019-08-24T14:15:22Z",
  • "fields": {
    },
  • "hostname": "string",
  • "start_time": "2019-08-24T14:15:22Z"
}

Response samples

Content type
application/json
{
  • "end_time": "2019-08-24T14:15:22Z",
  • "fields": {
    },
  • "hostname": "string",
  • "start_time": "2019-08-24T14:15:22Z"
}

campaign-api

Campaign Api

Campaign - List campaigns by tenant

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Campaign - Read campaign

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ],
  • "emailBody": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "positionFixed": true,
  • "positions": [
    ],
  • "sender": "string",
  • "sharedId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "subject": "string"
}

Campaign - Read campaign metadata

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
  • "categories": [
    ],
  • "endDate": "2019-08-24T14:15:22Z",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "positionFixed": true,
  • "positions": [
    ],
  • "sender": "string",
  • "sharedId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "subject": "string"
}

Campaign - Read campaign status

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "status": "string"
}

Campaign - Set status

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

Request Body schema: application/json

payload

status
string

Responses

Request samples

Content type
application/json
{
  • "status": "string"
}

Response samples

Content type
application/json
{
  • "status": "string"
}

campaign-import-api

Campaign Import Api

Campaign Import - List campaign import status

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Campaign Import - Trigger update of a specific campaign

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

query Parameters
dataSourceId
string

dataSourceId

Request Body schema: application/json

payload

date
string
hash
string

Responses

Request samples

Content type
application/json
{
  • "date": "string",
  • "hash": "string"
}

Response samples

Content type
application/json
{
  • "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608"
}

Campaign Import - Upload 3 import files (metadata.json, template.json, placeholders.json) to trigger import

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

Request Body schema: multipart/form-data
date
required
string

date

hash
required
string

hash

metadata
required
string <binary>

metadata

placeholders
required
string <binary>

placeholders

template
required
string <binary>

template

Responses

Response samples

Content type
application/json
{
  • "importId": "84402506-7f34-4409-8ec1-a4e0ffb6b608"
}

Campaign Import - Read campaign import status

path Parameters
campaignId
required
string <uuid>

campaignId

importId
required
string <uuid>

importId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "campaignId": "13f8bf6d-dc27-4a04-bffe-6e5b13c19ddf",
  • "endDate": "yyyy-MM-dd hh:mm:ss",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "importCount": 0,
  • "lastActivityDate": "yyyy-MM-dd hh:mm:ss",
  • "message": "string",
  • "metadataFilePath": "string",
  • "placeholdersFilePath": "string",
  • "result": "string",
  • "startDate": "yyyy-MM-dd hh:mm:ss",
  • "status": "string",
  • "templateFilePath": "string"
}

compatibility-api

Compatibility Api

COMPAT - Read campaign

query Parameters
guid
required
string

guid

Responses

Response samples

Content type
application/json
{
  • "categories": [
    ],
  • "emailBody": "string",
  • "endDate": "2019-08-24T14:15:22Z",
  • "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  • "lastModified": "2019-08-24T14:15:22Z",
  • "positionFixed": true,
  • "positions": [
    ],
  • "sender": "string",
  • "sharedId": "string",
  • "startDate": "2019-08-24T14:15:22Z",
  • "status": "string",
  • "subject": "string"
}

COMPAT - List all active campaigns

Responses

Response samples

Content type
application/json
[
  • {
    }
]

COMPAT - List campaigns per user

query Parameters
user_hash
required
string

user_hash

Responses

Response samples

Content type
application/json
[
  • {
    }
]

COMPAT - Save list of log entries.

Request Body schema: application/json

logEntries

Array
action
string
guid
string
tenantId
string
timestamp
integer <int64>
user_hash
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
{
  • "count": 0
}

debug-api

Debug Api

Debug - Show tenant status

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "dataSourceResultList": [
    ],
  • "tenant": {
    }
}

Debug - Show campaign status

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "campaign": {
    },
  • "campaignImports": [
    ]
}

Debug - Show user status

path Parameters
campaignId
required
string <uuid>

campaignId

tenantId
required
string

tenantId

userId
required
string

userId

Responses

Response samples

Content type
application/json
{
  • "activeCampaigns": [
    ],
  • "campaign": {
    },
  • "campaignLogs": [
    ],
  • "user": {
    }
}

tenant-api

Tenant Api

Tenant - List all

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tenant - Create - If createDB = true a new keyspace and tables are created

query Parameters
createDB
boolean

createDB

Request Body schema: application/json

payload

object (TenantConfiguration)
Array of objects (ConversionPoint) [ items ]
Array of objects (DataSource) [ items ]
id
string
keyspaceName
string
name
string

Responses

Request samples

Content type
application/json
{
  • "configuration": {
    },
  • "conversionPoints": [
    ],
  • "dataSources": [
    ],
  • "id": "string",
  • "keyspaceName": "string",
  • "name": "string"
}

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "conversionPoints": [
    ],
  • "dataSources": [
    ],
  • "id": "string",
  • "keyspaceName": "string",
  • "name": "string"
}

Tenant - Shutdown service for all tenants - No imports will be started

Request Body schema: application/json

payload

shutdown
boolean

Responses

Request samples

Content type
application/json
{
  • "shutdown": true
}

Response samples

Content type
application/json
{
  • "shutdown": true
}

Tenant - Get one

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "conversionPoints": [
    ],
  • "dataSources": [
    ],
  • "id": "string",
  • "keyspaceName": "string",
  • "name": "string"
}

Tenant - Delete tenant. Keyspace will remain untouched.

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "conversionPoints": [
    ],
  • "dataSources": [
    ],
  • "id": "string",
  • "keyspaceName": "string",
  • "name": "string"
}

Tenant - config - Get

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "configuration": {
    },
  • "conversionPoints": [
    ],
  • "dataSources": [
    ],
  • "id": "string",
  • "keyspaceName": "string",
  • "name": "string"
}

Tenant - config - Update - always provide complete config object

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

payload

secretKey
string
shutdown
boolean

Responses

Request samples

Content type
application/json
{
  • "secretKey": "string",
  • "shutdown": true
}

Response samples

Content type
application/json
{
  • "secretKey": "string",
  • "shutdown": true
}

Tenant - conversionPoints - Get list

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tenant - conversionPoints - Update - All conversionPoints have to be provided

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

payload

Array
object (TenantConversionPointConnectionInformation)
description
string
eventType
string
Enum: "INJECTED" "REINJECTED" "READ" "EXPUNGED"
id
string
type
string
Value: "ONGAGE"

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Tenant - conversionPoints - Get by Id

path Parameters
conversionPointId
required
string

conversionPointId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "connectionInformation": {
    },
  • "description": "string",
  • "eventType": "INJECTED",
  • "id": "string",
  • "type": "ONGAGE"
}

Tenant - dataSources - Get

path Parameters
tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Tenant - datasources - Update - All dataSources have to be provided

path Parameters
tenantId
required
string

tenantId

Request Body schema: application/json

payload

Array
object (TenantAWSConnectionInformation)
defaultDataSource
boolean
deleteTemporaryImportFiles
boolean
id
string
metadataFilename
string
placeholdersFilename
string
templateFilename
string
type
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Tenant - dataSources - Get

path Parameters
dataSourceId
required
string

dataSourceId

tenantId
required
string

tenantId

Responses

Response samples

Content type
application/json
{
  • "awsConnectionInformation": {
    },
  • "defaultDataSource": true,
  • "deleteTemporaryImportFiles": true,
  • "id": "string",
  • "metadataFilename": "string",
  • "placeholdersFilename": "string",
  • "templateFilename": "string",
  • "type": "string"
}

user-api

User Api

User - List active campaigns per user

path Parameters
tenantId
required
string

tenantId

userHash
required
string

userHash

Responses

Response samples

Content type
application/json
[
  • {
    }
]