Doxie MPM (1.0.0)

Download OpenAPI specification:

URL: https://taktsoft.energy Terms of Service

This is the API documentation for the Doxie MPM API.

Find out how to create a GitHub repo for your OpenAPI definition.

MPM

API for consent management

Initiate Consent for a contact

Initiate consent for a contact. Initiates a new consent if the contact is known or creates a new contact.

Authorizations:

basic_auth_api_user

path Parameters

tenant

required

string

Example: ts

The tenant slug

Request Body schema: application/json
required

Initiate consent payload

customer_id required	string The ID of the contact
consent_slug required	string The slug of the consent purpose
phone	string The phone number for the consent. Only one contact channel is allowed.
email	string The email for the consent. Only one contact channel is allowed.

Responses

Request samples

Payload

Content type

application/json

{"customer_id": "1234567890",
"consent_slug": "marketing",
"phone": "+491234567890",
"email": null
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"error_message": null,
"process_uuid": "1234567890",
"data": {"customer_id": "1234567890",
"consent_slug": "marketing",
"contact_channel": "+491234567890",
"process_uuid": "1234567890"
}
}

Revokes one or all consents for a contact

Revokes one or all consents for a contact.

Authorizations:

basic_auth_api_user

path Parameters

tenant

required

string

Example: ts

The tenant slug

Request Body schema: application/json
required

Revoke consent payload

customer_id required	string The ID of the contact
consent_slug	string The slug of the consent purpose
revoke_all	boolean Whether to revoke all consents for the contact or only the consent for the consent slug

Responses

Request samples

Payload

Content type

application/json

{"customer_id": "1234567890",
"consent_slug": "marketing",
"revoke_all": false
}

Response samples

200
400
401

Content type

application/json

{"success": true,
"error_message": null,
"data": {"revoked_consents": [{"customer_id": "1234567890",
"consent_slug": "marketing",
"contact_channel": "+491234567890",
"process_uuid": "1234567890"
}
]
}
}

Mailer

API for sending emails

Sends a mail

Sends a mail.

Authorizations:

basic_auth_api_user

path Parameters

tenant required	string Example: ts The tenant slug
event_slug required	string Example: welcome_email The event slug

Request Body schema: application/json
required

Email payload

any_keys

string

The needed payload for the event. The payload is free to choose. The parameters should fit the configured event parameters in the application.

Responses

Request samples

Payload

Content type

application/json

{"any_keys": "any value"
}

Response samples

200
401
422

Content type

application/json

{"success": true,
"process_uuid": "9a5d8c73-fcb4-4a8a-9fd2-fbabb3c99838",
"sent_email_templates": [{"template_name": "Willkommensmail",
"success": true,
"message_id": 1234,
"error_message": "Error message"
}
],
"sent_sms_templates": [{"template_name": "Willkommenssms",
"success": true,
"message_id": 1234,
"error_message": "Error message"
}
]
}

Injector

API for creating injections

Creates an injection for an embedded journey

Creates an injection for an embedded journey event.

Authorizations:

basic_auth_api_user

path Parameters

tenant required	string Example: ts The tenant slug
event_slug required	string Example: event_slug The event slug

Request Body schema: application/json
required

Email payload

any_keys

string

The needed payload for the injection event. The payload is free to choose. The parameters should fit the configured event parameters in the application.

Responses

Request samples

Payload

Content type

application/json

{"any_keys": "any value"
}

Response samples

200
400
401
422

Content type

application/json

{"success": true,
"error_message": null,
"process_uuid": "9a5d8c73-fcb4-4a8a-9fd2-fbabb3c99838",
"data": null
}

Shared

API for general features

Cancel a process

Cancel a process.

Authorizations:

basic_auth_api_user

path Parameters

tenant required	string Example: ts The tenant slug
process_uuid required	string Example: 1234567890 The UUID of the process

Responses

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"error_message": null,
"process_uuid": "1234567890"
}

Show event details

Show event details.

Authorizations:

basic_auth_api_user

path Parameters

tenant required	string Example: ts The tenant slug
event_id required	string Example: 1234567890 The ID of the event

query Parameters

type

required

string

Enum: "mailer" "survey" "qr_code" "injector"

Example: type=mailer

The type of the event

Responses

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"error_message": null,
"type": "mailer",
"event": {"id": "1234567890",
"name": "Mailer Event",
"slug": "mailer-event",
"mailer_event_id": "1234567890",
"placeholders": [{"id": "1234567890",
"label": "Email",
"json_path": "email",
"required": true,
"template_placeholder": "{{email}}"
}
],
"created_at": "2021-01-01T00:00:00Z",
"updated_at": "2021-01-01T00:00:00Z",
"additional_event_data": "Example additional event data"
}
}

Survey

API for creating surveys

Creates an inquiry for a survey response

Authorizations:

basic_auth_api_user

path Parameters

tenant required	string Example: ts The tenant slug
event_slug required	string Example: event_slug The event slug of the survey campaign

Request Body schema: application/json
required

Survey payload

email	string The email of the respondent, required if phone is not provided
phone	string The phone number of the respondent, required if email is not provided
any_keys	string The needed payload for the survey event. The payload is free to choose. The parameters should fit the configured messaging event parameters in the application.

Responses

Request samples

Payload

Content type

application/json

{"email": "test@example.com",
"phone": "+491771234567",
"any_keys": "any value"
}

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"error_message": null,
"process_uuid": "9a5d8c73-fcb4-4a8a-9fd2-fbabb3c99838",
"data": null
}

QR Code

API for creating QR codes

Creates a QR code for an event

Creates a QR code for a QR code event.

Authorizations:

basic_auth_api_user

path Parameters

tenant required	string Example: ts The tenant slug
event_slug required	string Example: event_slug The event slug

Request Body schema: application/json
required

QR code payload

any_keys

string

Additional payload parameters for the QR code event. The payload is free to choose. The parameters should fit the configured event parameters (target_url, valid_until) in the application.

Responses

Request samples

Payload

Content type

application/json

{"any_keys": "any value"
}

Response samples

200
400
401
404
422

Content type

application/json

{"success": true,
"error_message": "null",
"process_uuid": "9a5d8c73-fcb4-4a8a-9fd2-fbabb3c99838",
"data": {"uuid": "9a5d8c73-fcb4-4a8a-9fd2-fbabb3c99838",
"target_url": "https://example.com/landing-page",
"valid_until": "2024-12-31T23:59:59Z",
"qr_code_image_url": "https://app.doxie.energy/ts/qr/image/9a5d8c73-fcb4-4a8a-9fd2-fbabb3c99838"
}
}

Webhooks

Webhook documentation

Message sent Webhook

Notify the registered URL with details of a sent email or SMS

Authorizations:

basic_auth_webhook

Request Body schema: application/json
required

process_id	string The UUID of the process
message_type	string Enum: "email" "sms" The type of message (email or sms)
message_id	string The ID of the message
recipient_specific_message_ids	Array of arrays The IDs of the recipient specific messages
recipient	string The recipient of the message
subject	string The subject of the message
text	string The text of the message
html	string The HTML of the message
original_brand_slug	string The slug of the brand
original_tenant_slug	string The slug of the tenant
original_event_slug	string The slug of the event
timestamp	string The timestamp of the message
original_payload	object The original payload sent for the event, that belongs to the sent message

Responses

Request samples

Payload

Content type

application/json

{"process_id": "123e4567-e89b-12d3-a456-426614174000",
"message_type": "email",
"message_id": 1234567890,
"recipient_specific_message_ids": [1234567890,
1234567891
],
"recipient": "john.doe@example.com",
"subject": "Hello, world!",
"text": "Hello, world!",
"html": "<p>Hello, world!</p>",
"original_brand_slug": "ts",
"original_tenant_slug": "ts",
"original_event_slug": "concert",
"timestamp": "2021-01-01T00:00:00Z",
"original_payload": {"email": "john.doe@example.com",
"event_slug": "concert",
"phone": "0123456789"
}
}

Message status update Webhook

Notify the registered URL with details of a message status update

Authorizations:

basic_auth_webhook

Request Body schema: application/json
required

process_id	string The UUID of the process
message_type	string Enum: "email" "sms" The type of message (email or sms)
message_id	string The ID of the message
recipient_specific_message_id	string The ID of the recipient specific message
recipient	string The recipient of the message
status	string The status of the message
timestamp	string The timestamp of the message
original_payload	object The original payload sent for the event, that belongs to the sent message

Responses

Request samples

Payload

Content type

application/json

{"process_id": "123e4567-e89b-12d3-a456-426614174000",
"message_type": "email",
"message_id": 1234567890,
"recipient_specific_message_id": 1234567890,
"recipient": "john.doe@example.com",
"status": "sent",
"timestamp": "2021-01-01T00:00:00Z",
"original_payload": {"email": "john.doe@example.com",
"event_slug": "concert",
"phone": "0123456789"
}
}

Link clicked Webhook

Notify the registered URL with details of a link clicked

Authorizations:

basic_auth_webhook

Request Body schema: application/json
required

process_id	string The UUID of the process
url	string The URL that was clicked
recipients	string The recipients who received the link and could have clicked it
original_tenant_slug	string The slug of the tenant
original_event_slug	string The slug of the event
timestamp	string The timestamp of the link clicked
original_payload	object The original payload sent for the event, that belongs to the clicked link

Request samples

Payload

Content type

application/json

{"process_id": "123e4567-e89b-12d3-a456-426614174000",
"url": "https://example.com/link",
"recipients": "john.doe@example.com, jane.doe@example.com, 0123456789",
"original_tenant_slug": "ts",
"original_event_slug": "concert",
"timestamp": "2021-01-01T00:00:00Z",
"original_payload": {"email": "john.doe@example.com",
"event_slug": "concert",
"phone": "0123456789"
}
}

DOI confirmation Webhook

Notify the registered URL with details of a DOI confirmation

Authorizations:

basic_auth_webhook

Request Body schema: application/json
required

identifier	string The identifier of the DOI consent
timestamp	string The timestamp of the DOI confirmation
ipAddress	string The IP address which consented to the DOI

Request samples

Payload

Content type

application/json

{"identifier": Infinity,
"timestamp": "2021-01-01T00:00:00Z",
"ipAddress": "123.123.123.123"
}

Process cancelled Webhook

Notify the registered URL with details of a process cancellation

Authorizations:

basic_auth_webhook

Request Body schema: application/json
required

process_uuid	string The UUID of the process
cancellation_timestamp	string The timestamp of the process cancellation
original_payload	object The original payload sent for the event, that belongs to the process (optional)

Responses

Request samples

Payload

Content type

application/json

{"process_uuid": "123e4567-e89b-12d3-a456-426614174000",
"cancellation_timestamp": "2021-01-01T00:00:00Z",
"original_payload": {"email": "john.doe@example.com",
"event_slug": "concert",
"phone": "0123456789"
}
}

QR code visited Webhook

Notify the registered URL when a QR code is scanned

Authorizations:

basic_auth_webhook

Request Body schema: application/json
required

process_id	string The UUID of the process
target_url	string The target URL the QR code redirects to
valid_until	string or null <date-time> The expiration date of the QR code
qr_code_uuid	string The UUID of the QR code that was scanned
timestamp	string <date-time> The timestamp when the QR code was scanned and opened in the browser
status	string Enum: "active" "expired" The status of the QR code when it was scanned
original_payload	object or null The original payload sent for the event, that belongs to the scanned QR code

Responses

Request samples

Payload

Content type

application/json

{"process_id": "123e4567-e89b-12d3-a456-426614174000",
"target_url": "https://example.com/landing-page",
"valid_until": "2024-12-31T23:59:59Z",
"qr_code_uuid": "123e4567-e89b-12d3-a456-426614174000",
"timestamp": "2021-01-01T00:00:00Z",
"status": "active",
"original_payload": {"target_url": "https://example.com/landing-page",
"valid_until": "2024-12-31T23:59:59Z"
}
}

RCS message response Webhook

Notify the registered URL when a RCS message is responded to. The process ID is the last process that was sent to the recipient.

Authorizations:

basic_auth_webhook

Request Body schema: application/json
required

process_id	string The UUID of the process
message_id	string The ID of the RCS message that was (most likely) responded to
agent_id	string The agent ID of the RCS message that was (most likely) responded to
sender	string The sender of the response
timestamp	string <date-time> The timestamp when the RCS message was responded to
message_content	object The content of the RCS message that was responded to. It only includes one of the keys.
original_payload	object or null The original payload sent for the event, that belongs to the scanned QR code

Responses

Request samples

Payload

Content type

application/json

{"process_id": "123e4567-e89b-12d3-a456-426614174000",
"message_id": 1234567890,
"agent_id": "doxie_agent",
"sender": "491234567890",
"timestamp": "2026-03-26T13:17:43+01:00",
"message_content": {"text": "This is a test RCS message.",
"suggestion_response": {"postback_data": "1234567890",
"text": "This is a test suggestion response.",
"type": "button"
},
"user_file": {"thumbnail": {"mime_type": "image/jpeg",
"file_size": 1000,
"file_uri": "https://example.com/thumbnail.jpg"
},
"payload": {"mime_type": "image/jpeg",
"file_size": 1000,
"file_name": "test.jpg",
"file_uri": "https://example.com/payload.jpg"
}
},
"location": {"latitude": 48.137154,
"longitude": 11.576124
}
},
"original_payload": {"target_url": "https://example.com/landing-page",
"valid_until": "2024-12-31T23:59:59Z"
}
}

Admin

General Admin API for greater resources. OAuth2 bearer authentication only.

List brands

List brands for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

query Parameters

limit	integer Example: limit=200 Number of records per page.
page	integer Example: page=1 Page number.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"brands": [{"id": 1,
"name": "Example Brand",
"slug": "example-brand",
"possible_sender_emails": ["noreply@example.com"
],
"sender_phone_number": "+491234567890",
"rcs_possible_senders": ["SenderName"
],
"pseudonymization_duration_of_sent_messages_in_days": 7,
"storage_duration_of_sent_messages_in_days": 90,
"confirmation_base_url": "https://confirm.example.com",
"mail_provider": "mailjet",
"mailjet_sandbox_mode": true,
"sms77_api_key": "********",
"rcs_api_key": "********",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z",
"mailjet_api_user": {"id": 1,
"public_api_key": "mailjet-public-key",
"private_api_key": "********"
},
"ses_api_user": {"id": 1,
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"region": "eu-central-1",
"secret_access_key": "********"
},
"smtp_config": {"id": 1,
"address": "smtp.example.com",
"port": 587,
"user_name": "smtp-user",
"authentication": "plain",
"enable_starttls_auto": true,
"enable_ssl": false,
"openssl_verify_mode": null,
"domain": "example.com",
"envelope_from": "noreply@example.com",
"password": "********"
},
"style": {"id": 1,
"primary_color": "#111111",
"secondary_color": "#222222",
"light_accent_color": "#333333",
"dark_accent_color": "#444444",
"border_radius": "6px",
"font_family": "Arial",
"fallback_font_family": "sans-serif",
"pages_font_family": "Poppins",
"pages_font_family_path": "poppins",
"pages_font_family_weight": ["400",
"700"
],
"pages_headline_font_family": "Poppins",
"pages_headline_font_family_path": "poppins",
"pages_headline_font_family_weight": ["400",
"700"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
],
"pagination": {"current_page": 1,
"items_per_page": 200,
"total_pages": 1,
"total_count": 1
}
}
}

Create a brand

Create a brand for the given tenant. Requires write permission. Secret fields are masked in the response.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object (brand_input_schema)

Brand attributes for create and update. Nested objects depend on mail_provider. possible_sender_emails and rcs_possible_senders accept JSON arrays or comma-separated strings.

Responses

Request samples

Payload

Content type

application/json

{"brand": {"name": "Example Brand",
"slug": "example-brand",
"sender_phone_number": "+491234567890",
"possible_sender_emails": ["noreply@example.com"
],
"rcs_possible_senders": ["SenderName"
],
"pseudonymization_duration_of_sent_messages_in_days": 7,
"storage_duration_of_sent_messages_in_days": 90,
"confirmation_base_url": "https://confirm.example.com",
"mail_provider": "mailjet",
"mailjet_sandbox_mode": true,
"sms77_api_key": "1234567890",
"rcs_api_key": "1234567890",
"mailjet_api_user_attributes": {"public_api_key": "1234567890",
"private_api_key": "1234567890"
},
"ses_api_user_attributes": {"access_key_id": "1234567890",
"secret_access_key": "1234567890",
"region": "eu-central-1"
},
"smtp_config_attributes": {"address": "smtp.example.com",
"port": 587,
"user_name": "smtp-user",
"password": "1234567890",
"authentication": "plain",
"enable_starttls_auto": true,
"enable_ssl": true,
"openssl_verify_mode": "none",
"domain": "example.com",
"envelope_from": "string"
},
"style_attributes": {"primary_color": "#111111",
"secondary_color": "#222222",
"light_accent_color": "#333333",
"dark_accent_color": "#444444",
"border_radius": "6px",
"font_family": "Arial",
"pages_font_family": "poppins",
"pages_font_family_path": "poppins",
"pages_headline_font_family": "poppins",
"pages_headline_font_family_path": "poppins"
}
}
}

Response samples

201
401
422

Content type

application/json

{"success": true,
"message": "Erfolgreich erstellt",
"error": null,
"data": {"id": 1,
"name": "Example Brand",
"slug": "example-brand",
"possible_sender_emails": ["noreply@example.com"
],
"sender_phone_number": "+491234567890",
"rcs_possible_senders": ["SenderName"
],
"pseudonymization_duration_of_sent_messages_in_days": 7,
"storage_duration_of_sent_messages_in_days": 90,
"confirmation_base_url": "https://confirm.example.com",
"mail_provider": "mailjet",
"mailjet_sandbox_mode": true,
"sms77_api_key": "********",
"rcs_api_key": "********",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z",
"mailjet_api_user": {"id": 1,
"public_api_key": "mailjet-public-key",
"private_api_key": "********"
},
"ses_api_user": {"id": 1,
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"region": "eu-central-1",
"secret_access_key": "********"
},
"smtp_config": {"id": 1,
"address": "smtp.example.com",
"port": 587,
"user_name": "smtp-user",
"authentication": "plain",
"enable_starttls_auto": true,
"enable_ssl": false,
"openssl_verify_mode": null,
"domain": "example.com",
"envelope_from": "noreply@example.com",
"password": "********"
},
"style": {"id": 1,
"primary_color": "#111111",
"secondary_color": "#222222",
"light_accent_color": "#333333",
"dark_accent_color": "#444444",
"border_radius": "6px",
"font_family": "Arial",
"fallback_font_family": "sans-serif",
"pages_font_family": "Poppins",
"pages_font_family_path": "poppins",
"pages_font_family_weight": ["400",
"700"
],
"pages_headline_font_family": "Poppins",
"pages_headline_font_family_path": "poppins",
"pages_headline_font_family_weight": ["400",
"700"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Show a brand

Returns a single brand for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 1 The brand ID

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"id": 1,
"name": "Example Brand",
"slug": "example-brand",
"possible_sender_emails": ["noreply@example.com"
],
"sender_phone_number": "+491234567890",
"rcs_possible_senders": ["SenderName"
],
"pseudonymization_duration_of_sent_messages_in_days": 7,
"storage_duration_of_sent_messages_in_days": 90,
"confirmation_base_url": "https://confirm.example.com",
"mail_provider": "mailjet",
"mailjet_sandbox_mode": true,
"sms77_api_key": "********",
"rcs_api_key": "********",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z",
"mailjet_api_user": {"id": 1,
"public_api_key": "mailjet-public-key",
"private_api_key": "********"
},
"ses_api_user": {"id": 1,
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"region": "eu-central-1",
"secret_access_key": "********"
},
"smtp_config": {"id": 1,
"address": "smtp.example.com",
"port": 587,
"user_name": "smtp-user",
"authentication": "plain",
"enable_starttls_auto": true,
"enable_ssl": false,
"openssl_verify_mode": null,
"domain": "example.com",
"envelope_from": "noreply@example.com",
"password": "********"
},
"style": {"id": 1,
"primary_color": "#111111",
"secondary_color": "#222222",
"light_accent_color": "#333333",
"dark_accent_color": "#444444",
"border_radius": "6px",
"font_family": "Arial",
"fallback_font_family": "sans-serif",
"pages_font_family": "Poppins",
"pages_font_family_path": "poppins",
"pages_font_family_weight": ["400",
"700"
],
"pages_headline_font_family": "Poppins",
"pages_headline_font_family_path": "poppins",
"pages_headline_font_family_weight": ["400",
"700"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Update a brand

Update a brand. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 1 The brand ID

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object (brand_input_schema)

Brand attributes for create and update. Nested objects depend on mail_provider. possible_sender_emails and rcs_possible_senders accept JSON arrays or comma-separated strings.

Responses

Request samples

Payload

Content type

application/json

{"brand": {"name": "Example Brand",
"slug": "example-brand",
"sender_phone_number": "+491234567890",
"possible_sender_emails": ["noreply@example.com"
],
"rcs_possible_senders": ["SenderName"
],
"pseudonymization_duration_of_sent_messages_in_days": 7,
"storage_duration_of_sent_messages_in_days": 90,
"confirmation_base_url": "https://confirm.example.com",
"mail_provider": "mailjet",
"mailjet_sandbox_mode": true,
"sms77_api_key": "1234567890",
"rcs_api_key": "1234567890",
"mailjet_api_user_attributes": {"public_api_key": "1234567890",
"private_api_key": "1234567890"
},
"ses_api_user_attributes": {"access_key_id": "1234567890",
"secret_access_key": "1234567890",
"region": "eu-central-1"
},
"smtp_config_attributes": {"address": "smtp.example.com",
"port": 587,
"user_name": "smtp-user",
"password": "1234567890",
"authentication": "plain",
"enable_starttls_auto": true,
"enable_ssl": true,
"openssl_verify_mode": "none",
"domain": "example.com",
"envelope_from": "string"
},
"style_attributes": {"primary_color": "#111111",
"secondary_color": "#222222",
"light_accent_color": "#333333",
"dark_accent_color": "#444444",
"border_radius": "6px",
"font_family": "Arial",
"pages_font_family": "poppins",
"pages_font_family_path": "poppins",
"pages_headline_font_family": "poppins",
"pages_headline_font_family_path": "poppins"
}
}
}

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"id": 1,
"name": "Example Brand",
"slug": "example-brand",
"possible_sender_emails": ["noreply@example.com"
],
"sender_phone_number": "+491234567890",
"rcs_possible_senders": ["SenderName"
],
"pseudonymization_duration_of_sent_messages_in_days": 7,
"storage_duration_of_sent_messages_in_days": 90,
"confirmation_base_url": "https://confirm.example.com",
"mail_provider": "mailjet",
"mailjet_sandbox_mode": true,
"sms77_api_key": "********",
"rcs_api_key": "********",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z",
"mailjet_api_user": {"id": 1,
"public_api_key": "mailjet-public-key",
"private_api_key": "********"
},
"ses_api_user": {"id": 1,
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"region": "eu-central-1",
"secret_access_key": "********"
},
"smtp_config": {"id": 1,
"address": "smtp.example.com",
"port": 587,
"user_name": "smtp-user",
"authentication": "plain",
"enable_starttls_auto": true,
"enable_ssl": false,
"openssl_verify_mode": null,
"domain": "example.com",
"envelope_from": "noreply@example.com",
"password": "********"
},
"style": {"id": 1,
"primary_color": "#111111",
"secondary_color": "#222222",
"light_accent_color": "#333333",
"dark_accent_color": "#444444",
"border_radius": "6px",
"font_family": "Arial",
"fallback_font_family": "sans-serif",
"pages_font_family": "Poppins",
"pages_font_family_path": "poppins",
"pages_font_family_weight": ["400",
"700"
],
"pages_headline_font_family": "Poppins",
"pages_headline_font_family_path": "poppins",
"pages_headline_font_family_weight": ["400",
"700"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Delete a brand

Delete a brand. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 1 The brand ID

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"message": "Erfolgreich gelöscht",
"error": null,
"data": {"id": 1,
"name": "Example Brand",
"slug": "example-brand",
"possible_sender_emails": ["noreply@example.com"
],
"sender_phone_number": "+491234567890",
"rcs_possible_senders": ["SenderName"
],
"pseudonymization_duration_of_sent_messages_in_days": 7,
"storage_duration_of_sent_messages_in_days": 90,
"confirmation_base_url": "https://confirm.example.com",
"mail_provider": "mailjet",
"mailjet_sandbox_mode": true,
"sms77_api_key": "********",
"rcs_api_key": "********",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z",
"mailjet_api_user": {"id": 1,
"public_api_key": "mailjet-public-key",
"private_api_key": "********"
},
"ses_api_user": {"id": 1,
"access_key_id": "AKIAIOSFODNN7EXAMPLE",
"region": "eu-central-1",
"secret_access_key": "********"
},
"smtp_config": {"id": 1,
"address": "smtp.example.com",
"port": 587,
"user_name": "smtp-user",
"authentication": "plain",
"enable_starttls_auto": true,
"enable_ssl": false,
"openssl_verify_mode": null,
"domain": "example.com",
"envelope_from": "noreply@example.com",
"password": "********"
},
"style": {"id": 1,
"primary_color": "#111111",
"secondary_color": "#222222",
"light_accent_color": "#333333",
"dark_accent_color": "#444444",
"border_radius": "6px",
"font_family": "Arial",
"fallback_font_family": "sans-serif",
"pages_font_family": "Poppins",
"pages_font_family_path": "poppins",
"pages_font_family_weight": ["400",
"700"
],
"pages_headline_font_family": "Poppins",
"pages_headline_font_family_path": "poppins",
"pages_headline_font_family_weight": ["400",
"700"
],
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
}
}

Show Mailjet notification webhook status for a brand

Returns whether Mailjet event webhooks are registered for the given brand and which event types are active. Requires read permission for the tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"brand_id": 1,
"webhooks_present": true,
"registered_event_types": ["sent",
"open",
"bounce",
"spam",
"blocked",
"unsub"
],
"error_message": null
}
}

Register Mailjet notification webhooks for a brand

Registers Mailjet event webhooks for the given brand. Requires read and write permissions for the tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"webhooks_present": true,
"registered_event_types": ["sent",
"open",
"bounce",
"spam",
"blocked",
"unsub"
],
"error_message": null
}
}

Remove Mailjet notification webhooks for a brand

Deletes all Mailjet event webhooks registered for the given brand. Requires read and write permissions for the tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"webhooks_present": false,
"registered_event_types": [ ],
"error_message": null
}
}

Show RCS notification webhook status for a brand

Returns whether an RCS event webhook is registered for the given brand. Requires read permission for the tenant. RCS webhooks give information about the status of the RCS messages as well as allow to receive responses from the recipient.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"brand_id": 1,
"webhooks_present": true
}
}

Register RCS notification webhook for a brand

Registers an RCS event webhook for the given brand. Requires read and write permissions for the tenant. RCS webhooks give information about the status of the RCS messages as well as allow to receive responses from the recipient.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"webhooks_present": true
}
}

Remove RCS notification webhook for a brand

Deletes the RCS event webhook registered for the given brand. Requires read and write permissions for the tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"webhooks_present": false
}
}

Show SMS notification webhook status for a brand

Returns whether an SMS delivery report (DLR) webhook is registered for the given brand. Requires read permission for the tenant. SMS webhooks provide delivery status updates for SMS messages sent via seven.io.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"brand_id": 1,
"webhooks_present": true
}
}

Register SMS notification webhook for a brand

Registers an SMS delivery report (DLR) webhook for the given brand. Requires read and write permissions for the tenant. SMS webhooks provide delivery status updates for SMS messages sent via seven.io.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"webhooks_present": true
}
}

Remove SMS notification webhook for a brand

Deletes the SMS delivery report (DLR) webhook registered for the given brand. Requires read and write permissions for the tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"webhooks_present": false
}
}

Trigger SES setup for a brand

Runs the AWS SES configuration setup for the given brand. This creates or updates the SES configuration set, SNS topic, topic policy, SNS subscription, and event destination. Requires write permission for the tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"setup_success": true
}
}

Test SMTP connection for a brand

Runs a live SMTP connection test for the given brand using its configured SMTP credentials. Returns whether the connection succeeded along with the connection settings used. Requires write permission for the tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
brand_id required	string Example: 1 The ID of the brand.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich bearbeitet",
"error": null,
"data": {"brand_id": 1,
"connection_success": true,
"settings": {"address": "smtp.example.com",
"port": 587,
"enable_ssl": false,
"authentication": "plain",
"enable_starttls_auto": true,
"open_timeout": 10,
"read_timeout": 10,
"user_name": "smtp-user",
"password": "[REDACTED]",
"domain": "example.com",
"openssl_verify_mode": "none",
"envelope_from": "noreply@example.com",
"ssl": false
}
}
}

List API users

List API users for the given tenant. API users can be used for API endpoints that use the basic_auth_api_user authentication.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

query Parameters

limit	integer Example: limit=200 Number of records per page.
page	integer Example: page=1 Page number.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"api_users": [{"id": 1,
"username": "api-client",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
],
"pagination": {"current_page": 1,
"items_per_page": 200,
"total_pages": 1,
"total_count": 1
}
}
}

Create an API user

Create an API user for the given tenant. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

API user attributes.

Responses

Request samples

Payload

Content type

application/json

{"api_user": {"username": "api-client",
"password": "TestPassword12!",
"password_confirmation": "TestPassword12!"
}
}

Response samples

201
401
422

Content type

application/json

{"success": true,
"message": "Erfolgreich erstellt",
"error": null,
"data": {"id": 1,
"username": "api-client",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
}

Delete an API user

Delete an API user. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 1 The API user ID

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"message": "API-Zugang erfolgreich gelöscht",
"error": null,
"data": {"id": 1,
"username": "api-client",
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
}

Show tenant settings

Returns tenant-wide configuration for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"slug": "ts",
"activated_at": "2026-05-08T08:00:00.000Z",
"webhook_interaction_storage_duration_in_days": 7,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
}

Update tenant settings

Update tenant-wide configuration. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"tenant_params": {"webhook_interaction_storage_duration_in_days": 14
}
}

Response samples

200
401
422

Content type

application/json

{"success": true,
"message": "Mandant erfolgreich aktualisiert",
"error": null,
"data": {"slug": "ts",
"activated_at": "2026-05-08T08:00:00.000Z",
"webhook_interaction_storage_duration_in_days": 14,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
}

Show main dashboard statistics

Returns overview chart statistics for all product areas on the main admin dashboard. Each chart covers the last 4 weeks (one entry per calendar day), ordered chronologically.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"doi_chart_stats": [{"label": "07.05.2023",
"data": { }
}
],
"injector_chart_stats": [{"label": "07.05.2023",
"data": { }
}
],
"survey_chart_stats": [{"label": "07.05.2023",
"data": { }
}
],
"email_chart_stats": [{"label": "07.05.2023",
"data": { }
}
],
"sms_chart_stats": [{"label": "07.05.2023",
"data": { }
}
],
"rcs_chart_stats": [{"label": "07.05.2023",
"data": { }
}
],
"shared_chart_stats": [{"label": "07.05.2023",
"data": {"total": 42,
"successful": 40,
"failed": 2
}
}
]
}
}

Admin / Shared

Admin API for shared resources (dashboard, processes). OAuth2 bearer authentication only.

Show dashboard statistics

Returns dashboard statistics for the given tenant. Includes an overview chart covering the last 4 weeks (one entry per day) and filtered statistics aggregated by month for the selected time range. The time range can be controlled via the time_range parameter. If omitted, the current month is used. Pass time_range=custom together with start_date and end_date to specify an arbitrary range.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

query Parameters

time_range	string Example: time_range=2024-01-01 Selects the time range for the filtered overview chart. Omit or leave blank for the current month. Pass a date string (e.g. `2024-01-01`) to select that month. Pass `custom` to use `start_date`/`end_date` instead.
start_date	string <date> Example: start_date=2024-01-01 Start date for a custom time range. Only used when `time_range=custom`.
end_date	string <date> Example: end_date=2024-01-31 End date for a custom time range. Only used when `time_range=custom`.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"overview_chart_stats": [{"label": "01.05.2026",
"data": {"total": 42,
"successful": 40,
"failed": 2
}
}
],
"filtered_overview_chart_stats": [{"label": "05/2026",
"data": {"total": 500,
"successful": 480,
"failed": 20,
"type_map": {"Mailer::Event": 50,
"Survey::Event": 30
}
}
}
]
}
}

List processes

Returns a paginated list of processes for the given tenant, ordered by creation date descending. Use the page parameter to navigate through pages. Use the limit parameter to set the number of processes per page.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

query Parameters

page	integer Example: page=1 Page number for pagination. Defaults to 1.
limit	integer Example: limit=200 Number of processes per page. Defaults to 200.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"processes": [{"uuid": "123e4567-e89b-12d3-a456-426614174000",
"event_type": "Mailer::Event",
"event_id": 42,
"event_name": "Double Opt-In Zweck",
"status": "finished_successfully",
"created_at": "2024-01-15T10:30:00.000Z",
"error": null
}
],
"pagination": {"current_page": 1,
"items_per_page": 200,
"total_pages": 5,
"total_count": 97
}
}
}

Show a process and its associated records

Returns the full details of a single process identified by its UUID, including all associated emails, SMS messages, RCS messages, scheduled messages, DOI consents, webhook interactions, and survey responses. Each nested collection returns up to the default page size (20). Use the collection-specific page parameters (e.g. successful_emails_page) to paginate.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
uuid required	string Example: 123e4567-e89b-12d3-a456-426614174000 The UUID of the process

query Parameters

successful_emails_page	integer Example: successful_emails_page=1 Page number for successful emails.
unsuccessful_emails_page	integer Example: unsuccessful_emails_page=1 Page number for unsuccessful emails.
successful_sms_messages_page	integer Example: successful_sms_messages_page=1 Page number for successful SMS messages.
unsuccessful_sms_messages_page	integer Example: unsuccessful_sms_messages_page=1 Page number for unsuccessful SMS messages.
successful_rcs_messages_page	integer Example: successful_rcs_messages_page=1 Page number for successful RCS messages.
unsuccessful_rcs_messages_page	integer Example: unsuccessful_rcs_messages_page=1 Page number for unsuccessful RCS messages.
scheduled_messages_page	integer Example: scheduled_messages_page=1 Page number for scheduled messages.
confirmed_consents_page	integer Example: confirmed_consents_page=1 Page number for confirmed DOI consents.
unconfirmed_consents_page	integer Example: unconfirmed_consents_page=1 Page number for unconfirmed DOI consents.
webhook_interactions_page	integer Example: webhook_interactions_page=1 Page number for webhook interactions.
survey_responses_page	integer Example: survey_responses_page=1 Page number for survey responses.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"uuid": "123e4567-e89b-12d3-a456-426614174000",
"event_type": "Mailer::Event",
"event_id": 42,
"status": "finished_successfully",
"created_at": "2024-01-15T10:30:00.000Z",
"error": null,
"cancelled_at": null,
"expected_cancellation_date": null,
"abstract_event_import_id": null,
"abstract_event_import_row_index": null,
"original_payload": {"email": "john.doe@example.com",
"phone": "+49123456789"
},
"original_payload_pseudonymized_at": null,
"successful_emails": {"emails": [{"id": 1,
"brand_id": 3,
"email_template_id": 7,
"receipient": ["john.doe@example.com"
],
"carbon_copy": [ ],
"blind_carbon_copy": [ ],
"subject": "Your confirmation",
"sender": "noreply@example.com",
"sent_at": "2024-01-15T10:30:05.000Z",
"error_message": null,
"pseudonymized_at": null,
"mail_provider": "Mailjet",
"mail_header_message_id": "<abc123@mail.example.com>",
"brand_name": "Acme Corp",
"email_template_name": "DOI Confirmation",
"attachments": [{"filename": "invoice.pdf"
}
]
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"unsuccessful_emails": {"emails": [{"id": 1,
"brand_id": 3,
"email_template_id": 7,
"receipient": ["john.doe@example.com"
],
"carbon_copy": [ ],
"blind_carbon_copy": [ ],
"subject": "Your confirmation",
"sender": "noreply@example.com",
"sent_at": "2024-01-15T10:30:05.000Z",
"error_message": null,
"pseudonymized_at": null,
"mail_provider": "Mailjet",
"mail_header_message_id": "<abc123@mail.example.com>",
"brand_name": "Acme Corp",
"email_template_name": "DOI Confirmation",
"attachments": [{"filename": "invoice.pdf"
}
]
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"successful_sms_messages": {"sms_messages": [{"id": 1,
"brand_id": 3,
"sms_template_id": 5,
"receipient": "+49123456789",
"sender": "Doxie",
"sent_at": "2024-01-15T10:30:05.000Z",
"error_message": null,
"pseudonymized_at": null,
"brand_name": "Acme Corp",
"sms_template_name": "DOI SMS"
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"unsuccessful_sms_messages": {"sms_messages": [{"id": 1,
"brand_id": 3,
"sms_template_id": 5,
"receipient": "+49123456789",
"sender": "Doxie",
"sent_at": "2024-01-15T10:30:05.000Z",
"error_message": null,
"pseudonymized_at": null,
"brand_name": "Acme Corp",
"sms_template_name": "DOI SMS"
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"successful_rcs_messages": {"rcs_messages": [{"id": 1,
"brand_id": 3,
"rcs_template_id": 2,
"recipient": "+49123456789",
"sender": "Doxie",
"sent_at": "2024-01-15T10:30:05.000Z",
"error_message": null,
"pseudonymized_at": null,
"unified_recipient_format": "+49123456789",
"brand_name": "Acme Corp",
"rcs_template_name": "DOI RCS"
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"unsuccessful_rcs_messages": {"rcs_messages": [{"id": 1,
"brand_id": 3,
"rcs_template_id": 2,
"recipient": "+49123456789",
"sender": "Doxie",
"sent_at": "2024-01-15T10:30:05.000Z",
"error_message": null,
"pseudonymized_at": null,
"unified_recipient_format": "+49123456789",
"brand_name": "Acme Corp",
"rcs_template_name": "DOI RCS"
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"scheduled_messages": {"scheduled_messages": [{"id": 1,
"mailer_event_id": 10,
"scheduled_at": "2024-02-01T09:00:00.000Z",
"status": "pending",
"message_count_in_order_to_be_sent": 0
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"confirmed_doi_consents": {"consents": [{"id": 1,
"created_at": "2024-01-15T10:30:00.000Z",
"email": "john.doe@example.com",
"phone_number": null,
"cross_system_identifier": "abc123-xyz",
"status": "confirmed"
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"unconfirmed_doi_consents": {"consents": [{"id": 1,
"created_at": "2024-01-15T10:30:00.000Z",
"email": "john.doe@example.com",
"phone_number": null,
"cross_system_identifier": "abc123-xyz",
"status": "confirmed"
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"webhook_interactions": {"interactions": [{"id": 1,
"created_at": "2024-01-15T10:30:10.000Z",
"requested_url": "https://example.com/webhook",
"requested_method": "POST",
"response_code": "200",
"retry_count": 0,
"sent_payload": {"event": "message_sent",
"process_id": "123e4567-e89b-12d3-a456-426614174000"
},
"transaction_payload": {"email": "john.doe@example.com"
},
"response_payload": {"ok": true
}
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
},
"survey_responses": {"responses": [{"id": 1,
"created_at": "2024-01-15T12:00:00.000Z",
"email": "john.doe@example.com",
"phone": "+49123456789",
"vote": 5,
"voted_at": "2024-01-15T12:00:00.000Z",
"voted_through_website": false,
"original_payload": {"email": "john.doe@example.com"
},
"follow_up_question": "What can we improve?",
"follow_up_answer": "Faster response times.",
"voting_timespan": 86400,
"still_updatable": false
}
],
"pagination": {"current_page": 1,
"items_per_page": 20,
"total_pages": 3,
"total_count": 42
}
}
}
}

Cancel a process

Cancels a process for the given tenant. This endpoint requires write permissions. If the process is already cancelled, the request returns 422.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
uuid required	string Example: 123e4567-e89b-12d3-a456-426614174000 The UUID of the process to cancel.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"message": "Prozessvorgang erfolgreich abgebrochen",
"error": null,
"data": {"process_uuid": "123e4567-e89b-12d3-a456-426614174000",
"status": "cancelled",
"cancelled_at": "2024-01-15T10:30:00.000Z"
}
}

Create a messaging schedule

Creates a new messaging schedule for an owning event (for example a consent purpose). This endpoint requires read and write permissions.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"shared_messaging_schedule": {"event_type": "Mpm::ConsentPurpose",
"event_id": 5,
"mailer_event_id": 23,
"delay_value": 2,
"delay_unit": "days"
}
}

Response samples

201
401
422

Content type

application/json

{"success": true,
"message": "Erfolgreich erstellt",
"error": null,
"data": {"id": 10,
"event_type": "Mpm::ConsentPurpose",
"event_id": 5,
"mailer_event_id": 23,
"delay_value": 2,
"delay_unit": "days",
"delay_sending_in_seconds": 172800,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
}

Update a messaging schedule

Updates an existing messaging schedule. This endpoint requires read and write permissions.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 10 ID of the messaging schedule

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"shared_messaging_schedule": {"delay_value": 5,
"delay_unit": "hours"
}
}

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"message": "Erfolgreich editiert",
"error": null,
"data": {"id": 10,
"event_type": "Mpm::ConsentPurpose",
"event_id": 5,
"mailer_event_id": 23,
"delay_value": 5,
"delay_unit": "hours",
"delay_sending_in_seconds": 18000,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:10:00.000Z"
}
}

Delete a messaging schedule

Deletes an existing messaging schedule. This endpoint requires read and write permissions.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 10 ID of the messaging schedule

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich gelöscht",
"error": null,
"data": {"id": 10,
"event_type": "Mpm::ConsentPurpose",
"event_id": 5,
"mailer_event_id": 23,
"delay_value": 2,
"delay_unit": "days",
"delay_sending_in_seconds": 172800,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
}

Create a landing page

Creates a landing page and assigns it to an owning resource. This endpoint requires read and write permissions.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"pages_landing_page": {"owner_type": "Mpm::ConsentPurpose",
"owner_id": 9,
"layout_id": 4,
"title": "DOI Confirmation Page"
}
}

Response samples

201
401
404
422

Content type

application/json

{"success": true,
"message": "Erfolgreich erstellt",
"error": null,
"data": {"id": 15,
"layout_id": 4,
"title": "DOI Confirmation Page",
"owner_type": "Mpm::ConsentPurpose",
"owner_id": 9,
"published": false,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:00:00.000Z"
}
}

Update a landing page

Updates an existing landing page. This endpoint requires read and write permissions.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 15 ID of the landing page

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"pages_landing_page": {"layout_id": 6,
"title": "Updated Page"
}
}

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"message": "Erfolgreich aktualisiert",
"error": null,
"data": {"id": 15,
"layout_id": 6,
"title": "Updated Page",
"owner_type": "Mpm::ConsentPurpose",
"owner_id": 9,
"published": false,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:10:00.000Z"
}
}

Delete a landing page

Deletes a landing page. This endpoint requires read and write permissions.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 15 ID of the landing page

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Erfolgreich gelöscht",
"error": null,
"data": {"id": 15,
"layout_id": 6,
"title": "Updated Page",
"owner_type": "Mpm::ConsentPurpose",
"owner_id": 9,
"published": false,
"created_at": "2026-05-08T08:00:00.000Z",
"updated_at": "2026-05-08T08:10:00.000Z"
}
}

Admin / Webhook

Admin API for webhook endpoint configuration. OAuth2 bearer authentication only.

List webhook endpoints

List webhook endpoints for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

query Parameters

show_inactive	boolean Example: show_inactive=true Whether to show inactive endpoints. If not provided, only active endpoints are returned.
limit	integer Example: limit=200 Number of records per page.
page	integer Example: page=1 Page number.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"endpoints": [{"id": "1",
"type": "Webhook::MessageSentEndpoint",
"url": "https://example.com/webhook",
"basic_auth_username": "username",
"basic_auth_password": "********",
"is_active": true,
"send_original_payload": false
}
],
"pagination": {"current_page": 1,
"items_per_page": 200,
"total_pages": 1,
"total_count": 2
}
}
}

Create a webhook endpoint

Create a webhook endpoint for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"webhook_abstract_endpoint": {"type": "Webhook::MessageSentEndpoint",
"url": "https://example.com/webhook",
"basic_auth_username": "username",
"basic_auth_password": "password",
"is_active": true,
"send_original_payload": false
}
}

Response samples

201
401
422

Content type

application/json

{"success": true,
"message": "Webhook erfolgreich erstellt",
"error": null,
"data": {"id": "1",
"type": "Webhook::MessageSentEndpoint",
"url": "https://example.com/webhook",
"basic_auth_username": "username",
"basic_auth_password": "********",
"is_active": true,
"send_original_payload": false
}
}

Show a webhook endpoint and its interactions

Show a webhook endpoint and its interactions for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
endpoint_id required	string Example: 1 The ID of the webhook endpoint

query Parameters

limit	integer Example: limit=200 Number of interactions per page.
page	integer Example: page=1 Interaction page number.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": null,
"error": null,
"data": {"id": "1",
"type": "Webhook::MessageSentEndpoint",
"url": "https://example.com/webhook",
"basic_auth_username": "username",
"basic_auth_password": "********",
"is_active": true,
"send_original_payload": false,
"interactions": {"list": [{"id": "1",
"created_at": "2021-01-01T00:00:00Z",
"process_id": "123e4567-e89b-12d3-a456-426614174000",
"requested_url": "https://example.com/webhook",
"requested_method": "POST",
"response_code": 200,
"retry_count": 0,
"sent_payload": {"event": "message_sent",
"data": {"message_id": "1234567890",
"recipient": "john.doe@example.com",
"subject": "Hello, world!",
"text": "Hello, world!"
}
},
"transaction_payload": {"message_id": "1234567890",
"recipient": "john.doe@example.com",
"subject": "Hello, world!",
"text": "Hello, world!"
},
"response_payload": {"response": true
}
}
],
"pagination": {"current_page": 1,
"items_per_page": 200,
"total_pages": 1,
"total_count": 2
}
}
}
}

Update a webhook endpoint

Update a webhook endpoint for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
endpoint_id required	string Example: 1 The ID of the webhook endpoint

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json

object

Responses

Request samples

Payload

Content type

application/json

{"webhook_abstract_endpoint": {"type": "Webhook::MessageSentEndpoint",
"url": "https://example.com/webhook",
"basic_auth_username": "username",
"basic_auth_password": "password",
"is_active": true,
"send_original_payload": false
}
}

Response samples

200
401
404
422

Content type

application/json

{"success": true,
"message": "Webhook endpoint updated successfully",
"error": null,
"data": {"id": "1",
"type": "Webhook::MessageSentEndpoint",
"url": "https://example.com/webhook",
"basic_auth_username": "username",
"basic_auth_password": "********",
"is_active": true,
"send_original_payload": false
}
}

Delete a webhook endpoint

Delete a webhook endpoint for the given tenant.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
endpoint_id required	string Example: 1 The ID of the webhook endpoint

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{"success": true,
"message": "Webhook endpoint deleted successfully",
"error": null,
"data": {"id": "1",
"type": "Webhook::MessageSentEndpoint",
"url": "https://example.com/webhook",
"basic_auth_username": "username",
"basic_auth_password": "********",
"is_active": true,
"send_original_payload": false
}
}

Admin / Editor

Admin API for the visual editor (landing pages, layouts, assets). OAuth2 bearer authentication only.

Show editor landing page configuration

Returns the editor payload for a landing page, including content state, brand, API endpoints, and editor configuration. Requires read permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 15 ID of the landing page

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401
404

Content type

application/json

{ }

Update landing page content state

Updates the content_state of a landing page. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 15 ID of the landing page

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

content_state

required

object

Editor content state document.

Responses

Request samples

Payload

Content type

application/json

{"content_state": { }
}

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Publish a landing page

Enqueues rendering/publishing of the landing page. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 15 ID of the landing page

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Show editor landing page layout configuration

Returns the editor payload for a landing page layout, including content state. Requires read permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 4 ID of the landing page layout

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Update landing page layout content state

Updates the content_state of a landing page layout. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 4 ID of the landing page layout

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

content_state

required

object

Editor content state document.

Responses

Request samples

Payload

Content type

application/json

{"content_state": { }
}

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

List editor assets

Returns editor assets uploaded for the tenant. Requires read permission.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

200
401

Content type

application/json

[{"type": "file",
"id": "string",
"directory": "/",
"src": "string",
"previewSrc": "string",
"mimeType": "string"
}
]

Upload an editor asset

Uploads a file for use in the editor. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: multipart/form-data
required

filename	string The filename to use for the uploaded asset.
file	string <binary> The file to upload.

Responses

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Delete an editor asset

Deletes an editor asset by UUID. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	string Example: a1b2c3d4-e5f6-7890-abcd-ef1234567890 UUID of the editor asset

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Admin / Pages

Admin API for pages resources (landing page layouts). OAuth2 bearer authentication only.

List landing page layouts

Returns a paginated list of landing page layouts for the tenant. Requires read permission.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

query Parameters

page	integer Example: page=1 Page number.
limit	integer Example: limit=200 Number of records per page.

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Create a landing page layout

Creates a landing page layout. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant

required

string

Example: ts

The tenant slug

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"pages_landing_page_layout": {"name": "Default layout",
"brand_id": 3
}
}

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Show a landing page layout

Returns a single landing page layout. Requires read permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 4 The landing page layout ID

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Update a landing page layout

Updates name or brand of a landing page layout. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 4 The landing page layout ID

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Request Body schema: application/json
required

required

object

Responses

Request samples

Payload

Content type

application/json

{"pages_landing_page_layout": {"name": "string",
"brand_id": 0
}
}

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Delete a landing page layout

Deletes a landing page layout. Requires write permission.

Authorizations:

bearer_auth

path Parameters

tenant required	string Example: ts The tenant slug
id required	integer Example: 4 The landing page layout ID

header Parameters

Accept

required

string

Example: application/json

The accept header, only application/json is supported.

Responses

Response samples

401

Content type

application/json

Example

Permissions denied

{"success": false,
"message": null,
"error": "No read permission",
"data": null
}

Doxie MPM (1.0.0)

MPM

Initiate Consent for a contact

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Revokes one or all consents for a contact

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Mailer

Sends a mail

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Injector

Creates an injection for an embedded journey

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Shared

Cancel a process

Authorizations:

path Parameters

Responses

Response samples

Show event details

Authorizations:

path Parameters

query Parameters

Responses

Response samples

Survey

Creates an inquiry for a survey response

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

QR Code

Creates a QR code for an event

Authorizations:

path Parameters

Request Body schema: application/jsonrequired

Responses

Request samples

Response samples

Webhooks

Message sent Webhook

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Message status update Webhook

Authorizations:

Request Body schema: application/jsonrequired

Responses

Request samples

Link clicked Webhook

Authorizations:

Request Body schema: application/jsonrequired

Request samples

DOI confirmation Webhook

Authorizations:

Request Body schema: application/jsonrequired

Request samples

Process cancelled Webhook

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required

Request Body schema: application/json
required