Documentation Powered by ReDoc

Mailingwork Event-tool API (1.0.0)

Download OpenAPI specification:Download

Mailingwork GmbH: info@mailingwork.de URL: https://www.mailingwork.de License: proprietary

This is our Event-tool API specification.

Find out more about mailingwork

Authentication

bearer_auth

Security Scheme Type HTTP
HTTP Authorization Scheme bearer
Bearer format "JWT"

mw3_session

Security Scheme Type API Key
Query parameter name: mw3_session

authorization

Authorization Operations

Create access token by user credentials

Create access token by user credentials

Request Body schema: application/json
username
string
password
string

Responses

Request samples

Content type
application/json
{
  • "username": "username",
  • "password": "password"
}

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "expires_in": 3600,
  • "access_token": "ayJ0DXAiWiJKV1QiLCJhbGciOiJS",
  • "refresh_token": "czZCaGRSa3F0MzpnWDFmQmF0M2JW"
}

Revoke Token (Logout)

Revoke a token

Authorizations:
bearer_auth
Request Body schema: application/json
token
string
token_type
string

Responses

Request samples

Content type
application/json
{
  • "token": "ayJ0DXAiWiJKV1QiLCJhbGciOiJS",
  • "token_type_hint": "access_token"
}

Response samples

Content type
application/json
{
  • "hint": "Check the token parameter."
}

createTokenByMwSession

Create access token by an valid mailingwork session id

Request Body schema: application/json
accountId
integer
sessionId
string

Responses

Request samples

Content type
application/json
{
  • "accountId": 1234,
  • "sessionId": "34d70c5a2d5a098b93cadfd815a613aa3892ceda"
}

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "expires_in": 3600,
  • "access_token": "ayJ0DXAiWiJKV1QiLCJhbGciOiJS",
  • "refresh_token": "czZCaGRSa3F0MzpnWDFmQmF0M2JW"
}

Create access token by refresh token

create access token by refresh token

Authorizations:
bearer_auth
Request Body schema: application/json
refresh_token
string

Responses

Request samples

Content type
application/json
{
  • "refresh_token": "czZCaGRSa3F0MzpnWDFmQmF0M2JW"
}

Response samples

Content type
application/json
{
  • "token_type": "Bearer",
  • "expires_in": 3600,
  • "access_token": "ayJ0DXAiWiJKV1QiLCJhbGciOiJS",
  • "refresh_token": "czZCaGRSa3F0MzpnWDFmQmF0M2JW"
}

user

Operations about user

Get information about the current user

Get information about the current user

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "id": 1,
  • "mwId": 2,
  • "mwAccountId": 3,
  • "username": "kmuster",
  • "firstName": "Karl",
  • "lastName": "Mustermann",
  • "email": "example@example.org"
}

event

Operation regarding one or multiple events

Get one event by its id

Get information of one event

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "Summer Workshop",
  • "slug": "summer-workshop",
  • "subscriberListId": 23,
  • "startDate": "2022-07-24",
  • "endDate": "2022-07-24",
  • "settingsId": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7",
  • "locationIds": [
    ],
  • "internalNotes": "Here are some internal eventnotes",
  • "maxGuestCount": 3,
  • "status": "ACTIVE",
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one event by its id

Delete one event

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "hint": "Check the id parameter."
}

Update on event by its id

Update information of one event

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered event object

id
string <uuid>
name
string
slug
string
subscriberListId
integer
startDate
string
endDate
string
settingsId
string
locationIds
Array of strings
internalNotes
string
maxGuestCount
integer
status
string
Enum: "ACTIVE" "ARCHIVE" "TRASH" "DRAFT"
createdAt
string
updatedAt
string
mwOptInSetupId
integer
mwOptInMailingId
integer

Responses

Request samples

Content type
application/json
{
  • "name": "Summer Workshop",
  • "slug": "summer-workshop",
  • "subscriberListId": 23,
  • "startDate": "2022-07-24",
  • "endDate": "2022-07-24",
  • "settingsId": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7",
  • "locationIds": [
    ],
  • "internalNotes": "Here are some internal eventnotes",
  • "maxGuestCount": 3,
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "id": "d11438fd-10b8-4d91-b9ca-2906e3c03da9"
}

Get a list of events

Get a list of all events

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new event

Create a new event

Authorizations:
bearer_auth
Request Body schema: application/json

Submit a event.

name
string
slug
string
mwSubscriberListId
integer
startDate
string
endDate
string
settingsId
string
locationIds
Array of any
internalNotes
string
maxGuestCount
integer
status
string

Responses

Request samples

Content type
application/json
Example
New Event Example (full payload)
New Event Example (full payload)
New Event Example (minimum payload)
{
  • "name": "Summer Workshop",
  • "slug": "summer-workshop",
  • "subscriberListId": 23,
  • "startDate": "2022-07-24",
  • "endDate": "2022-07-24",
  • "settingsId": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7",
  • "locationIds": [
    ],
  • "internalNotes": "Here are some internal eventnotes",
  • "maxGuestCount": 3,
  • "status": "ACTIVE"
}

Response samples

Content type
application/json
{
  • "id": "d11438fd-10b8-4d91-b9ca-2906e3c03da9"
}

ticket

Operation regarding one or multiple tickets

Get one ticket by its id

Get information of one ticket

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "fad2bea6-073c-4f11-90ad-b95fd72dfd23",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "parentId": null,
  • "mwSubscriberId": 2372,
  • "bookedSessions": [
    ],
  • "attendedSessions": [ ],
  • "details": [
    ],
  • "bookedTransfers": [ ],
  • "bookedRooms": [ ],
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one ticket by its id

Delete one ticket

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "hint": "Check the id parameter."
}

Update on ticket by its id

Update information of one ticket

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered ticket object

id
string
eventId
string
parentId
nullstring
mwSubscriberId
integer
bookedSessions
Array of strings
attendedSessions
Array of strings
details
Array of objects
bookedTransfers
Array of strings
bookedRooms
Array of strings
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "fad2bea6-073c-4f11-90ad-b95fd72dfd23",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "parentId": null,
  • "mwSubscriberId": 2372,
  • "bookedSessions": [
    ],
  • "attendedSessions": [ ],
  • "details": [
    ],
  • "bookedTransfers": [ ],
  • "bookedRooms": [ ]
}

Response samples

Content type
application/json
{
  • "id": "fad2bea6-073c-4f11-90ad-b95fd72dfd23"
}

Get a list of tickets

Get a list of all tickets of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new ticket

Create a new ticket

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a name for the ticket.

mwSubscriberId
integer

Responses

Request samples

Content type
application/json
{
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "parentId": null,
  • "mwSubscriberId": 2372,
  • "bookedSessions": [
    ],
  • "details": [
    ],
  • "bookedTransfers": [ ],
  • "bookedRooms": [ ]
}

Response samples

Content type
application/json
{
  • "id": "fad2bea6-073c-4f11-90ad-b95fd72dfd23"
}

landingpage

Operation regarding one or multiple landingpage

Get one landingpage by its id

Get information of one landingpage

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "b043de1f-db6a-4a83-a70c-9f16c29ae6ee",
  • "isPublic": true,
  • "disabledAt": "2020-09-11 09:41",
  • "title": "Eventpage",
  • "elements": [
    ],
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one landingpage by its id

Delete one landingpage

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "b043de1f-db6a-4a83-a70c-9f16c29ae6ee"
}

Update a landingpage by its id

Update information of one landingpage

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered landingpage object

id
string
isPublic
boolean
disabledAt
string
title
string
elements
Array of objects
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "b043de1f-db6a-4a83-a70c-9f16c29ae6ee",
  • "isPublic": true,
  • "disabledAt": "2020-09-11 09:41",
  • "title": "Eventpage",
  • "elements": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b043de1f-db6a-4a83-a70c-9f16c29ae6ee"
}

Get a list of landingpage

Get a list of all landingpages

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new landingpage

Create a new landingpage

Authorizations:
bearer_auth
Request Body schema: application/json

Submit a title for the Landingpage.

title
string

Responses

Request samples

Content type
application/json
{
  • "title": "Eventpage"
}

Response samples

Content type
application/json
{
  • "id": "b043de1f-db6a-4a83-a70c-9f16c29ae6ee"
}

setting

Operation regarding one or multiple settings

Get one setting by its id

Get information of one setting

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7",
  • "eventId": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7",
  • "name": "Standard Setup DE",
  • "redirectUrl": "https://mailingwork.events",
  • "fallbackUrl": "https://mailingwork.de",
  • "textMailTemplateId": 1,
  • "mailTemplateId": 15,
  • "faviconUrl": "https://expample.org/favicon",
  • "language": "DE",
  • "landingPageHead": "<style></style>",
  • "landingPageHeader": "<div>Header</div>",
  • "landingPageFooter": "<div>Footer</div>",
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one setting by its id

Delete one setting

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "hint": "Check the id parameter."
}

Update a setting by its id

Update information of one setting

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered setting object

id
string
eventId
string
name
string
redirectUrl
string
fallbackUrl
string
textMailTemplateId
integer
mailTemplateId
integer
faviconUrl
string
language
string
Enum: "DE" "EN"
landingPageHead
string
landingPageHeader
string
landingPageFooter
string
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7",
  • "name": "Standard Setup DE",
  • "redirectUrl": "https://mailingwork.events",
  • "fallbackUrl": "https://mailingwork.de",
  • "textMailTemplateId": 1,
  • "mailTemplateId": 15,
  • "faviconUrl": "https://expample.org/favicon",
  • "language": "DE",
  • "landingpageHead": "<style></style>",
  • "landingoageHeader": "<div>Header</div>",
  • "landingpageFooter": "<div>Footer</div>"
}

Response samples

Content type
application/json
{
  • "id": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7"
}

Get a list of setting

Get a list of all settings

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new setting

Create a new setting

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a name for the Setting.

id
string
eventId
string
name
string
redirectUrl
string
fallbackUrl
string
textMailTemplateId
integer
mailTemplateId
integer
faviconUrl
string
language
string
Enum: "DE" "EN"
landingPageHead
string
landingPageHeader
string
landingPageFooter
string
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{}

Response samples

Content type
application/json
{
  • "id": "e994a0fb-0a49-477f-8ebc-bd8ac9e023c7"
}

address

Operation regarding one or multiple addresses

Get one address by its id

Get information of one address

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "6006467e-9163-4858-806f-c567c3cb19d1",
  • "address": "Schönherrstr. 8",
  • "zip": "09113",
  • "city": "Chemnitz",
  • "country": "Germany",
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one address by its id

Delete one address

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "6006467e-9163-4858-806f-c567c3cb19d1"
}

Update a address by its id

Update information of one address

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered address object

id
string
address
string
zip
string
city
string
country
string
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "6006467e-9163-4858-806f-c567c3cb19d1",
  • "address": "Schönherrstr. 8",
  • "zip": "09113",
  • "city": "Chemnitz",
  • "country": "Germany"
}

Response samples

Content type
application/json
{
  • "id": "6006467e-9163-4858-806f-c567c3cb19d1"
}

Get a list of address

Get a list of all addresses

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new address

Create a new address

Authorizations:
bearer_auth
Request Body schema: application/json

Submit the Address.

address
string non-empty
zip
string non-empty
city
string non-empty
country
string non-empty

Responses

Request samples

Content type
application/json
{
  • "address": "Schönherrstr. 8",
  • "zip": "09113",
  • "city": "Chemnitz",
  • "country": "Germany"
}

Response samples

Content type
application/json
{
  • "id": "6006467e-9163-4858-806f-c567c3cb19d1"
}

session

Operation regarding one or multiple sessions

Get one session by its id

Get information of one session

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "OKR-Workshop",
  • "type": "workshop",
  • "speaker": "John Doe",
  • "locationId": "84b09851-e51f-4e4e-bebd-3cc6546dca8a",
  • "description": "We are going to talk about dos and donts with the OKR method.",
  • "isMandatory": true,
  • "date": "2021-07-24",
  • "timeSlotId": "da22a02f-030a-4d0f-a420-9e80ce01b6c9",
  • "groupId": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7",
  • "maxGuests": 15,
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one session by its id

Delete one session

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

Update on session by its id

Update information of one session

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered session object

id
string
eventId
string
name
string
type
string
speaker
string
locationId
string
description
string
isMandatory
boolean
date
string
timeSlotId
string
groupId
string
maxGuests
integer
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "OKR-Workshop",
  • "type": "workshop",
  • "speaker": "John Doe",
  • "locationId": "84b09851-e51f-4e4e-bebd-3cc6546dca8a",
  • "description": "We are going to talk about dos and donts with the OKR method.",
  • "isMandatory": true,
  • "date": "2021-07-24",
  • "timeSlotId": "da22a02f-030a-4d0f-a420-9e80ce01b6c9",
  • "groupId": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7",
  • "maxGuests": 15
}

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

Get a list of sessions

Get a list of all sessions of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new session

Create a new session

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a name for the session.

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "OKR-Workshop"
}

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

transfer

Operation regarding one or multiple transfers

Get one transfer by its id

Get information of one transfer

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "7779b924-360d-40c6-86b2-be26fff8170f",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "Train Station Shuttle",
  • "description": "Starts in front of the main entrance of th train station",
  • "type": "SHUTTLE",
  • "start": "2020-09-21 09:41:52",
  • "duration": 30,
  • "fromLocationId": "84b09851-e51f-4e4e-bebd-3cc6546dca8a",
  • "toLocationId": "a55cba07-5e50-468d-9a01-a9b2d50514a0",
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one transfer by its id

Delete one transfer

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

Update on transfer by its id

Update information of one transfer.

Note: Only the attributes in the schema will be updated, but you can also send the 'id' and the 'event_id' as well.

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered transfer object

name
string
description
string
type
string
Enum: "SHUTTLE" "CUSTOM"
start
string
duration
integer
fromLocationId
string
toLocationId
string
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "name": "Train Station Shuttle",
  • "description": "Starts in front of the main entrance of th train station",
  • "type": "SHUTTLE",
  • "start": "2020-09-21 09:41:52",
  • "duration": 30,
  • "fromLocationId": "84b09851-e51f-4e4e-bebd-3cc6546dca8a",
  • "toLocationId": "a55cba07-5e50-468d-9a01-a9b2d50514a0"
}

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

Get a list of transfers

Get a list of all transfers of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new transfer

Create a new transfer

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a name for the transfer.

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "Train Station Shuttle"
}

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

accommodation

Operation regarding one or multiple accommodations

Get one accommodation by its id

Get information of one accommodation

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "ba36ce75-170c-437f-b0ee-d5a0e739d477",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "City Hotel",
  • "type": "HOTEL",
  • "description": "The description for the City Hotel",
  • "link": "https://example.com/hotel",
  • "quota": 10,
  • "groupId": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7",
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one accommodation by its id

Delete one accommodation

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

Update on accommodation by its id

Update information of one accommodation

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered accommodation object

id
string
accountId
integer
eventId
string
name
string
type
string
description
string
link
string
quota
integer
groupId
string
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "ba36ce75-170c-437f-b0ee-d5a0e739d477",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "City Hotel",
  • "type": "HOTEL",
  • "description": "The description for the City Hotel",
  • "link": "https://example.com/hotel",
  • "quota": 10,
  • "groupId": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7"
}

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

Get a list of accommodations

Get a list of all accommodations of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new accommodation

Create a new accommodation

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a name for the accommodation.

name
string

Responses

Request samples

Content type
application/json
{
  • "name": "City Hotel"
}

Response samples

Content type
application/json
{
  • "id": "ba36ce75-170c-437f-b0ee-d5a0e739d477"
}

timeslot

Operation regarding one or multiple timeslots

Get one timeslot by its id

Get information of one timeslot

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "da22a02f-030a-4d0f-a420-9e80ce01b6c9",
  • "start": "2020-09-21 10:00:00",
  • "end": "2020-09-21 11:30:00",
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one timeslot by its id

Delete one timeslot

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "hint": "Check the id parameter."
}

Update on timeslot by its id

Update information of one timeslot

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered timeslot object

id
string
accountId
integer
start
string
end
string
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "da22a02f-030a-4d0f-a420-9e80ce01b6c9",
  • "start": "2020-09-21 10:00:00",
  • "end": "2020-09-21 11:30:00"
}

Response samples

Content type
application/json
{
  • "id": "11d8b4fc-850e-4e42-80ce-02e6e08d1a0a"
}

Get a list of timeslots

Get a list of all timeslots of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new timeslot

Create a new timeslot

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a start ans end for the timeslot.

name
string

Responses

Request samples

Content type
application/json
{
  • "start": "2020-09-21 10:00:00",
  • "end": "2020-09-21 11:30:00"
}

Response samples

Content type
application/json
{
  • "id": "da22a02f-030a-4d0f-a420-9e80ce01b6c9"
}

location

Operation regarding one or multiple locations

Get a collection of locations

Get locations

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get one location by its id

Get information of one location

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "84b09851-e51f-4e4e-bebd-3cc6546dca8a",
  • "name": "Meetingarea",
  • "type": "room",
  • "description": "meeting area at Mailingwork",
  • "addressId": "6006467e-9163-4858-806f-c567c3cb19d1",
  • "roomQuota": 1,
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one location by its id

Delete one location

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "84b09851-e51f-4e4e-bebd-3cc6546dca8a"
}

Update a location by its id

Update information of one location

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered location object

id
string
name
string
type
string
description
string
addressId
string
roomQuota
integer
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "84b09851-e51f-4e4e-bebd-3cc6546dca8a",
  • "name": "Meetingarea",
  • "type": "room",
  • "description": "meeting area at Mailingwork",
  • "addressId": "6006467e-9163-4858-806f-c567c3cb19d1",
  • "roomQuota": 1
}

Response samples

Content type
application/json
{
  • "id": "84b09851-e51f-4e4e-bebd-3cc6546dca8a"
}

Get a list of location

Get a list of all locations of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new location

Create a new location

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a title for the Location.

title
string

Responses

Request samples

Content type
application/json
{
  • "title": "Meetingarea"
}

Response samples

Content type
application/json
{
  • "id": "84b09851-e51f-4e4e-bebd-3cc6546dca8a"
}

field

Operation regarding one or multiple fields

Get one field by its id

Get information of one field

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "9aea74de-7858-42f6-bf46-daf3bcd68677",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "Allergy",
  • "type": "ENUM",
  • "display": "CHECKBOX",
  • "source": "Gluten|Lactose",
  • "isSubscriberField": false,
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one field by its id

Delete one field

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "hint": "Check the id parameter."
}

Update a field by its id

Update information of one field

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered field object

id
string
eventId
string
name
string
type
string
Enum: "STRING" "MULTILINE" "BOOLEAN" "ENUM"
display
string
Default: "GENERIC"
Enum: "RADIO" "CHECKBOX" "SELECT" "GENERIC"
isSubscriberField
boolean
source
string
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "9aea74de-7858-42f6-bf46-daf3bcd68677",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "Allergy",
  • "type": "ENUM",
  • "display": "CHECKBOX",
  • "source": "Gluten|Lactose",
  • "isSubscriberField": false
}

Response samples

Content type
application/json
{
  • "id": "9aea74de-7858-42f6-bf46-daf3bcd68677"
}

Get a list of fields

Get a list of all fields of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new field

Create a new field

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a title for the Field.

title
string

Responses

Request samples

Content type
application/json
{
  • "title": "Allergies"
}

Response samples

Content type
application/json
{
  • "id": "9aea74de-7858-42f6-bf46-daf3bcd68677"
}

group

Operation regarding one or multiple groups

Get one group by its id

Get information of one group

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "Workshops",
  • "type": "SESSION",
  • "sessionIds": [
    ],
  • "transferIds": [ ],
  • "accommodationIds": [ ],
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one group by its id

Delete one group

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "hint": "Check the id parameter."
}

Update a group by its id

Update information of one group

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered group object

id
string
eventId
string
name
string
type
string
Enum: "SESSION" "TRANSFER" "ACCOMMODATION"
sessionIds
Array of strings
transferIds
Array of strings
accommodationIds
Array of strings
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "id": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "Workshops",
  • "type": "SESSION",
  • "memberIds": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7"
}

Get a list of groups

Get a list of all groups of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new group

Create a new group

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a title for the Group.

title
string

Responses

Request samples

Content type
application/json
{
  • "title": "Workshops"
}

Response samples

Content type
application/json
{
  • "id": "09ecc67b-c1b3-4ee8-b533-5969996cb8e7"
}

filter

Operation regarding one or multiple filters

Get one filter by its id

Get information of one filter

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "id": "b13e483f-7766-478d-8677-51dfad1673a4",
  • "eventId": "d11438fd-10b8-4d91-b9ca-2906e3c03da9",
  • "name": "Attendees",
  • "mwTargetGroupId": 1,
  • "conditions": [
    ],
  • "createdAt": "2020-09-21 09:41:52",
  • "updatedAt": "2020-09-22 10:09:12"
}

Delete one filter by its id

Delete one filter

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>

Responses

Response samples

Content type
application/json
{
  • "hint": "Check the id parameter."
}

Update on filter by its id

Update information of one filter

Authorizations:
bearer_auth
path Parameters
id
required
string <uuid>
Request Body schema: application/json

Submit the whole altered filter object

id
string
eventId
string
name
string
mwTargetGroupId
integer
mode
string
Array of objects
createdAt
string
updatedAt
string

Responses

Request samples

Content type
application/json
{
  • "name": "Attendees",
  • "mwTargetGroupId": 1,
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "fad2bea6-073c-4f11-90ad-b95fd72dfd23"
}

Get a list of filters

Get a list of all filters of one event

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create a new filter

Create a new filter

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json

Submit a name for the filter.

name
required
string non-empty
mwTargetGroupId
required
number
conditions
required
Array of any

Responses

Request samples

Content type
application/json
{
  • "name": "Attendees",
  • "mwTargetGroupId": 1,
  • "conditions": [
    ]
}

Response samples

Content type
application/json
{
  • "id": "b13e483f-7766-478d-8677-51dfad1673a4"
}

mailing

Operation regarding one or multiple mailings

Get a List of Mailings

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
[
  • {
    }
]

optinsetup

Operation regarding one or multiple optin setups

Create an Optin Setup

Authorizations:
bearer_auth
path Parameters
eventId
required
string
Request Body schema: application/json
confirmationMailingId
integer
listIds
integer

Responses

Request samples

Content type
application/json
{
  • "confirmationMailingId": 347,
  • "listIds": 12
}

Response samples

Content type
application/json
{
  • "id": 347
}

recipient

Operation regarding one or multiple recipients

getRecipientsByMwListId

returns an array of recipients

Authorizations:
bearer_auth
path Parameters
mwListId
required
string
query Parameters
mwFieldIds
string

comma-separated list of desired mw-field-IDs

Responses

Response samples

Content type
application/json
[
  • {
    }
]

subscriberfield

Operation regarding one or multiple subscriberfields

Get subscriber field ids

get subscriber field ids

Authorizations:
bearer_auth

Responses

Response samples

Content type
application/json
{
  • "email_id": 1,
  • "salutation_id": 2,
  • "firstname_id": 3,
  • "lastname_id": 4
}

page

Operation regarding one or multiple pages

Get Landingpage by Id and mwRecipient by Id and Code

Get either just a Landingpage with mwRecipient

path Parameters
landingpageId
required
string <uuid>
query Parameters
mwSubscriberId
string
mwSubscriberCode
string

Responses

Response samples

Content type
application/json
{
  • "landingpage": {
    },
  • "mwRecipient": [ ]
}

statistic

Operation regarding one or multiple statistics

event statistics endpoint

Authorizations:
bearer_auth
path Parameters
eventId
required
string

Responses

Response samples

Content type
application/json
{
  • "recipientsCount": 10,
  • "mailOpeningsCount": 5,
  • "orderedTicketsCount": 3,
  • "bookedSessions": [
    ],
  • "totalBookedSessions": 3
}