API docs by Redocly

Polario API (5.8)

Download OpenAPI specification:Download

API for Polario

Naming:

  • json properties are formatted in camel case (fooBar) besides of enums (FooBar)
  • route params are formatted in hyphen case (foo-bar)
  • query params are formatted in snake case (foo_bar)
  • query params could hold lists of elements if they are comma separated
  • enum properties are formatted in capitalized camel case (FooBar)

Default values:

  • default values are specified for optional parameters do only apply to POST requests

Types:

  • numbers are considered to be float values
  • strings that are not specified to be html formatted should not be interpreted as html to avoid unexpected bahavior, like xss attacks
  • timestamps are considered to be in unix time

Headers:

  • Platform: can be always set as header param to specify the platform of the request for the logging output

Account

Account entered project first time

This endpoint is for announcing that an account has entered a project for the first time. It will enable the notification settings for the entered project.

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Account ID of JWT

projectId
required
string

Project ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get push token

This endpoint is for requesting account device push token. Session is linked to a device.

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Account ID of JWT

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "acceptLanguage": "fr-CH, fr;q=0.9, en;q=0.8, de;q=0.7, *;q=0.5",
  • "iosEnv": "Production",
  • "pushToken": "string",
  • "webPushKeys": {
    }
}

Set push token

This endpoint is for setting account device push token. Session is linked to a device. The Accept-Language header is used to select the language for sending the push notification. If no language is selected, it will be sent for the default language of the system.

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Account ID of JWT

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Request Body schema: application/json

device push values

iosEnv
string or null <optional>
Enum: "Production" "Sandbox"
pushToken
string

endpoint for web push

object or null <optional>

Responses

Request samples

Content type
application/json
{
  • "iosEnv": "Production",
  • "pushToken": "string",
  • "webPushKeys": {
    }
}

Response samples

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

Remove push token

This endpoint is for removing account device push token. Session is linked to a device.

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Account ID of JWT

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get account

This endpoint returns the requested account. If Platform header is "Cms" Accept-Language header will be ignored.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "color": {
    },
  • "email": "string",
  • "firstName": "string",
  • "hasPassword": true,
  • "id": "string",
  • "image": "string",
  • "keywordIds": [
    ],
  • "lastName": "string",
  • "meta": [
    ],
  • "profileEditAllowed": true,
  • "roles": [
    ],
  • "salutation": "Mr",
  • "ssoIdentity": "string",
  • "ssoProviderId": "string",
  • "title": "string",
  • "visibility": {
    }
}

Delete account

This endpoint is for deleting a single account.

For deletion of own account via frontend see: POST /auth/account/delete-own

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get account profile

This endpoint is for requesting account profile information. If Platform header is "Cms" Accept-Language header will be ignored.

accessible without permission

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Responses

Response samples

Content type
application/json
{
  • "accessEditAllowed": true,
  • "color": {
    },
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "image": "string",
  • "keywordIds": [
    ],
  • "lastName": "string",
  • "meta": [
    ],
  • "profileEditAllowed": true,
  • "salutation": "Mr",
  • "title": "string",
  • "visibility": {
    }
}

Update account profile

This endpoint is for updating account profile information. Read only items can only be patched with cms session. If Platform header is "Cms" Accept-Language header will be ignored.

Note: meta.translations may not hold data. Translation takes places async. Call GET /auth/account/{id}/profile to check for translation again later.

accessible without permission

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

account profile

object (model.AccountProfileColor)
firstName
string non-empty
image
string or null

media id

keywordIds
Array of strings
lastName
string non-empty
Array of objects (model.AccountMetaData)

only updated entries have to be transmitted -> to empty a field transmit an empty value!

salutation
string or null
Enum: "Mr" "Ms"
title
string or null non-empty

Responses

Request samples

Content type
application/json
{
  • "color": {
    },
  • "firstName": "string",
  • "image": "string",
  • "keywordIds": [
    ],
  • "lastName": "string",
  • "meta": [
    ],
  • "salutation": "Mr",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "accessEditAllowed": true,
  • "color": {
    },
  • "email": "string",
  • "firstName": "string",
  • "id": "string",
  • "image": "string",
  • "keywordIds": [
    ],
  • "lastName": "string",
  • "meta": [
    ],
  • "profileEditAllowed": true,
  • "salutation": "Mr",
  • "title": "string",
  • "visibility": {
    }
}

Get accounts

This endpoint is for requesting account list of the system. If a limit is set, a cursor for this endpoint may be created to iterate over all accounts. If Platform header is "Cms" Accept-Language header will be ignored.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create account

This endpoint is for creating a new account. An email can be sent to the account owner to inform about the new account. If no password is provided, an email with a set password token will be sent to the account owner. You are only allowed to add roles that have permissions you already own through your roles. If you have "ManageGlobalRoles" you are allowed to add all roles. The Accept-Language header is used to select the language for sending the email. If no language is selected, the email will be sent for the default language of the system.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Request Body schema: application/json

Account to create

object (model.Access)
email
string
firstName
string
image
string or null
keywordIds
Array of strings <optional>

Default: []

lastName
string
Array of objects (model.AccountMetaData)
ownAccess
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read

password
string <optional>

must be empty if sso is set

product
string
Enum: "App" "Cms"
Array of objects (model.AccountRole)

Default: []

salutation
string or null
Enum: "Mr" "Ms"
sendMail
boolean
ssoIdentity
string <optional>

must be empty if password is set; must be set if ssoProviderId is set

ssoProviderId
string <optional>

must be empty if password is set; must be set if ssoIdentity is set

title
string or null

Responses

Request samples

Content type
application/json
{
  • "access": {
    },
  • "email": "test@api.plazz",
  • "firstName": "string",
  • "image": "string",
  • "keywordIds": [
    ],
  • "lastName": "string",
  • "meta": [
    ],
  • "ownAccess": "Read",
  • "password": "string",
  • "product": "App",
  • "roles": [
    ],
  • "salutation": "Mr",
  • "sendMail": true,
  • "ssoIdentity": "string",
  • "ssoProviderId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "color": {
    },
  • "email": "string",
  • "firstName": "string",
  • "hasPassword": true,
  • "id": "string",
  • "image": "string",
  • "keywordIds": [
    ],
  • "lastName": "string",
  • "meta": [
    ],
  • "profileEditAllowed": true,
  • "roles": [
    ],
  • "salutation": "Mr",
  • "ssoIdentity": "string",
  • "ssoProviderId": "string",
  • "title": "string",
  • "visibility": {
    }
}

Delete accounts

This endpoint is for deleting multiple accounts from the system.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

query Parameters
ids
required
string

ids to delete

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Logout device

This endpoint is for account device logout.

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Account ID

deviceId
required
string

Device ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get meta item setup

This endpoint is for retrieving the meta item configuration for accounts. If Platform is "Cms" Accept-Language header will be ignored. If Platform is not "Cms" selections.options.design values are hexcolors only.

accessible without permission

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "profileDefaultConfig": {
    },
  • "selections": [
    ]
}

Update meta item setup

This endpoint is for updating the meta item configuration for accounts

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

new meta configuration

Array of objects (account.MetaItem)
object (model.ProfileDefaultConfig)
Array of objects (account.RequestMetaSelection)

Responses

Request samples

Content type
application/json
{
  • "items": [
    ],
  • "profileDefaultConfig": {
    },
  • "selections": [
    ]
}

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "profileDefaultConfig": {
    },
  • "selections": [
    ]
}

Get accounts statistics

This endpoint is for requesting accounts statistics.

only accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageProjects" "ViewGlobalAnalytics"

fully accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageProjects" "ViewGlobalAnalytics"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get account settings analytics for cursor

This endpoint returns a list of all accounts settings analytics snapshot records for a cursor in administrative representation.

Cursor could be created here: POST /auth/account/analytics/account-settings/search

accessible without permission

query Parameters
cursor
required
string

id of the cursor used for pagination; required if page is set

page
required
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update account credentials

This endpoint is for updating account credential information without the SCRAM flow. Credentials cannot be changed for an accounts that is linked to a sso provider. If an email address is provided, a password must also be provided. (Because of SCRAM the email address can only be changed by providing a password.) User has to login again after credentials change.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

new credentials

email
string
password
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@api.plazz",
  • "password": "string"
}

Response samples

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

Create account settings analytics cursor

This endpoint returns a cursor for list account settings snapshot records with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

only accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

fully accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

options to create cursor

object (analytics.CursorFilterOption)
Array of objects

only one property per entry allowed; property enums: "snapshotDate" "snapshotTimestamp"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Get group list for account for project

This endpoint returns a list of all groups for the requested account and project. If a limit is set, a cursor for this endpoint may be created to iterate over all groups.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

projectId
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update account groups membership for project

This endpoint is for updating the group membership of an account for a specific project. System groups are calculated and cannot be changed with that request. In case of response status is 205 the request was only executed partial. Use GET to receive the stored configuration.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

projectId
required
string

Project ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

group ids

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • "string"
]

account colors

This endpoint is for requesting available account profile colors.

accessible without permission

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cursor

This endpoint returns a cursor for list accounts with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

options to create cursor

object (account.CursorFilterOption)
Array of objects

only one property per entry allowed; property enums: "creationTimestamp" "email" "firstLoginTimestamp" "firstName" "id" "lastModified" "lastName" "lastSessionTimestamp" "salutation" "title" "tracking" "type"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Delete own

This endpoint is for deleting an account with the correct password. This endpoint uses the final message of the SCRAM challenge to validate the password. The Platform must match the Platform from the first message. See RFC 5802 for detail SCRAM definition.

To perform this action call SCRAM First first: POST /auth/auth

accessible without permission

header Parameters
Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

Clients Final Message

email
string
nonce
string
proof
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@api.plazz",
  • "nonce": "hvYDpWUa2RaTCAfuxFIlj)hNlF$k0",
  • "proof": "dHzbZapWIk4jUhN+Ute9ytag9zjfMHgsqmmiz7AndVQ="
}

Response samples

Content type
application/json
{
  • "signature": "6rriTRBi23WpRR/wtup+mMhUZUn/dB5nLTJRsjl95G4="
}

Get accounts statistic records

This endpoint is for requesting accounts statistic records.

only accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageProjects" "ViewGlobalAnalytics"

fully accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageProjects" "ViewGlobalAnalytics"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get project account ids

This endpoint is for requesting account ids of a project

only accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

fully accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

path Parameters
projectId
required
string

Project ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get account access configuration

This endpoint returns the access configuration for the requested account.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true
}

Update account access configuration

This endpoint updates the access configuration for the requested account. Only the changes should be transmitted due this endpoint.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

changed access rights

object

accountId to operation; null for operation removes access

any
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

object

groupId to operation; null for operation removes access

user
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

Responses

Request samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Get project accounts statistics

This endpoint is for requesting accounts statistics of a project Only accounts that have access and entered the project once are considered.

only accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

fully accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

path Parameters
projectId
required
string

Project ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Change email final

This endpoint should be requested for redeeming the token to finish the email address change. For this action a one time token is needed. The email cannot be changed for an accounts that is linked to a sso provider. After a successful change of the email address all session and refresh tokens will be invalidated and a notification is sent to the old email address of the account. The Accept-Language header is used to select the language for sending the email. If no language is selected, the email will be sent for the default language of the system. On success this endpoint provides a new refresh token and new session in the 200 response. In case of response status is 205 login has to be performed again. If the password is retired, it will return 428 Precondition Required.

accessible without permission

header Parameters
Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

email change token

browser
string or null <optional>

Default: null

deviceName
string or null <optional>

Default: null

os
string
Enum: "Android" "IOS" "Windows" "Linux" "Mac" "Other"
osVersion
string
token
string

Responses

Request samples

Content type
application/json
{
  • "browser": "string",
  • "deviceName": "string",
  • "os": "Android",
  • "osVersion": "string",
  • "token": "hvYDpWUa2RaTCAfuxFIlj)hNlF$k0"
}

Response samples

Content type
application/json
{
  • "deviceId": "string",
  • "refreshToken": "XX4EWw5Hz6zb10FlyMazboBGmlvYX7Y878j6zSjQjJmsbTDVUvfPd7eOm1YqRPQb",
  • "sendbirdSessionToken": "string"
}

Change email first

This endpoint should be requested first for changing the current email address for an account. The email cannot be changed for an accounts that is linked to a sso provider. A link with a confirmation token is sent to the new email address. This token must be redeemed to save the change. The Platform header is for creating the correct token link send to the requested new email address. The token should be redeemed on PUT /auth/email This function is safe against enumeration attacks, so it is not possible to get information about already used emails in the system. If there already is an account for the requested mail, the address cannot be changed for the current account The Accept-Language header is used to select the language for sending the email. If no language is selected, the email will be sent for the default language of the system.

accessible without permission

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

requested mail change

newEmail
string
password
string

Responses

Request samples

Content type
application/json
{
  • "newEmail": "test@api.plazz",
  • "password": "string"
}

Response samples

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

Get project accounts statistic records

This endpoint is for requesting accounts statistic records of a project. Only accounts that have access and entered the project once are considered.

only accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

fully accessible with permission : "ManageAccounts" "ManageConfiguration" "ManageContent" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

path Parameters
projectId
required
string

Project ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get group list for account

This endpoint returns a list of all groups the requested account belongs to across all projects.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • "string"
]

Set account group memberships

This endpoint sets the group memberships of an account by providing the complete desired set of group ids. Groups may span multiple projects. System groups are calculated and cannot be changed with that request. In case of response status is 205 the request was only executed partial. Use GET to receive the stored configuration.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

group ids to be set for account

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • "string"
]

Update account group memberships

This endpoint updates group memberships for an account by explicitly providing groups to add and groups to remove. Groups may span multiple projects. System groups are calculated and cannot be changed with that request. In case of response status is 205 the request was only executed partial. Use GET to receive the stored configuration.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

groups to add and remove

add
Array of strings
remove
Array of strings

Responses

Request samples

Content type
application/json
{
  • "add": [
    ],
  • "remove": [
    ]
}

Response samples

Content type
application/json
[
  • "string"
]

Search accounts

This endpoint is for requesting account list with a search If Platform header is "Cms" Accept-Language header will be ignored.

Note: For cursor use: POST /auth/account/search-cursor

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

search

email
string <optional>

Deprecated: use Emails

emails
Array of strings <optional>
ids
Array of strings <optional>

Responses

Request samples

Content type
application/json
{
  • "email": "test@api.plazz",
  • "emails": [
    ],
  • "ids": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Get account permissions

This endpoint returns all permissions the user own.

property: enums: "AccessPreview" "ManageAccounts" "ManageCheckIns" "ManageConfiguration" "ManageContent" "ManageGlobalMedia" "ManageGlobalRoles" "ManagePosts" "ManageProjects" "ViewAnalytics" "ViewGlobalAnalytics"

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get account devices

This endpoint is for requesting account devices. The Platform header is for filtering devices for the correct product (App|Cms).

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get account tracking settings

This endpoint is for requesting account tracking settings.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "tracking": "Disabled"
}

Update account tracking settings

This endpoint is for updating account tracking settings.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

account tracking settings

tracking
string
Enum: "Disabled" "Anonym" "Personalized"

Responses

Request samples

Content type
application/json
{
  • "tracking": "Disabled"
}

Response samples

Content type
application/json
{
  • "tracking": "Disabled"
}

Get account visibility settings

This endpoint is for requesting account visibility settings.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "appointmentVisible": true,
  • "chatVisible": true,
  • "emailVisible": true,
  • "imageVisible": true,
  • "salutationVisible": true,
  • "titleVisible": true,
  • "visibleForOthers": true
}

Update account visibility settings

This endpoint is for updating account visibility settings. In order to enable the chat, the account should have first or last name set. After enabling the chat the refresh session endpoint must be called to get also a sendbird session token.

Note: In exceptional cases the user has to login again.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

account visibility settings

appointmentVisible
boolean
chatVisible
boolean

handles reactions allowed

emailVisible
boolean
imageVisible
boolean
salutationVisible
boolean
titleVisible
boolean
visibleForOthers
boolean

Responses

Request samples

Content type
application/json
{
  • "appointmentVisible": true,
  • "chatVisible": true,
  • "emailVisible": true,
  • "imageVisible": true,
  • "salutationVisible": true,
  • "titleVisible": true,
  • "visibleForOthers": true
}

Response samples

Content type
application/json
{
  • "appointmentVisible": true,
  • "chatVisible": true,
  • "emailVisible": true,
  • "imageVisible": true,
  • "salutationVisible": true,
  • "titleVisible": true,
  • "visibleForOthers": true
}

Change Password

This endpoint is for replacing old password with new one. For this action a one time token is needed. The token can be created with a new account registration, a password recover action or changing password request. The new password must be supplied in plain text to check if it matches the password security guidelines. If the new password does not match the guidelines the reason can be found in the 400 response message. After a successful change of the password every session and refresh token for this user will be invalidated. On success this endpoint provides a new refresh token and new session in the 200 response. In case of response status is 205 login has to be performed again.

Error messages:

  • Error.Token.Invalid
  • Error.Password.NoLower
  • Error.Password.TooShort
  • Error.Password.NoNumber
  • Error.Password.NotDictionarySafe
  • Error.Password.NoSpecial
  • Error.Password.NoUpper
  • Error.Password.UsedBefore

accessible without permission

header Parameters
Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

password change

browser
string or null <optional>

Default: null

deviceName
string or null <optional>

Default: null

newPassword
string
os
string
Enum: "Android" "IOS" "Windows" "Linux" "Mac" "Other"
osVersion
string
token
string

Responses

Request samples

Content type
application/json
{
  • "browser": "string",
  • "deviceName": "string",
  • "newPassword": "string",
  • "os": "Android",
  • "osVersion": "string",
  • "token": "hvYDpWUa2RaTCAfuxFIlj)hNlF$k0"
}

Response samples

Content type
application/json
{
  • "deviceId": "string",
  • "refreshToken": "XX4EWw5Hz6zb10FlyMazboBGmlvYX7Y878j6zSjQjJmsbTDVUvfPd7eOm1YqRPQb",
  • "sendbirdSessionToken": "string"
}

Get roles of an account

This endpoint is for retrieving the roles of a given account

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update the roles of an account

This endpoint is for updating the roles of an account. You are only allowed to add and remove roles that have permissions you already own through your roles. If you have "ManageGlobalRoles" you are allowed to add and remove all roles. If a user already own a role, that user can keep this role with this request, even if you do not own the permissions of that role. You are not allowed to add or remove roles that have permissions you don't own but user own them from other role.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

the new account roles

Array
projectId
string or null
roleId
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get account notification settings

This endpoint is for requesting account notification settings.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "bundleEmails": true,
  • "notifyConfiguration": {
    }
}

Update account notification settings

This endpoint updates the account notification settings. In case of response status is 205 the request was only executed partial. Use GET to receive the stored configuration.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

account notification settings

bundleEmails
boolean

may be replaced with enum value (No,Day,Week)

object

property enums: "Appointment" "CalendarReminder" "Chat" "Custom" "Journey" "Mention" "News" "System"

Responses

Request samples

Content type
application/json
{
  • "bundleEmails": true,
  • "notifyConfiguration": {
    }
}

Response samples

Content type
application/json
{
  • "bundleEmails": true,
  • "notifyConfiguration": {
    }
}

Get account settings

This endpoint is for requesting account settings.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "notifications": {
    },
  • "projectSettings": {
    },
  • "tracking": "Disabled",
  • "visibility": {
    }
}

Registration

This endpoint is used for registration of an account with a valid email address. An email with registration token will be sent to the given address. If there already is an account for that email address, a password forgotten link will be sent to the user instead. The received one time token can be redeemed for setting password: PUT /auth/password If registration is disabled in the security configuration this endpoint is also disabled. The Accept-Language header is used to select the language for sending the email. If no language is selected, the email will be sent for the default language of the system.

accessible without permission

header Parameters
Accept-Language
string

client language(s)

Request Body schema: application/json

email address

email
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@api.plazz"
}

Response samples

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

Get account project settings

This endpoint is for requesting account project settings for the requested project.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

projectId
required
string

Project ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "notification": "Disabled",
  • "projectEnteredAt": 0
}

Update account project settings

This endpoint updates the account project settings for the requested project.

accessible without permission (can only be used for the own account. Session must match requested account id.)

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Account ID

projectId
required
string

Project ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

account project settings

notification
string
Enum: "Enabled" "Mute"

Responses

Request samples

Content type
application/json
{
  • "notification": "Enabled"
}

Response samples

Content type
application/json
[
  • {
    }
]

Recover Password

This endpoint is for recovering password for given email. It always returns 200 if the request body is correct. If there is an existing account for the given email address, an email will be sent to this address with a token link. The Platform header is used for setting the interface the recovering link should lead. The Accept-Language header is used to select the language for sending the email. If no language is selected, the email will be sent for the default language of the system.

accessible without permission

header Parameters
Accept-Language
string

client language(s)

Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

password recover

email
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@api.plazz"
}

Response samples

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

Request password change

This endpoint is for requesting a one time token to change the password of an account. The password cannot be changed for an accounts that is linked to a sso provider. This endpoint uses the final message of the SCRAM challenge to validate the old password. The Platform must match the Platform from the first message. See RFC 5802 for detail SCRAM definition.

To perform this action call SCRAM First first: POST /auth/auth

accessible without permission

header Parameters
Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

Clients Final Message

email
string
nonce
string
proof
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@api.plazz",
  • "nonce": "hvYDpWUa2RaTCAfuxFIlj)hNlF$k0",
  • "proof": "dHzbZapWIk4jUhN+Ute9ytag9zjfMHgsqmmiz7AndVQ="
}

Response samples

Content type
application/json
{
  • "signature": "6rriTRBi23WpRR/wtup+mMhUZUn/dB5nLTJRsjl95G4=",
  • "token": "XX4EWw5Hz6zb10FlyMazboBGmlvYX7Y878j6zSjQjJmsbTDVUvfPd7eOm1YqRPQb"
}

Admin Area

Get page list preview for project

This endpoint returns a list of all pages for the requested project without content in default representation. If a limit is set, a cursor for this endpoint may be created to iterate over all pages.

If the requested language is not available it will fall back to the default language.

only accessible with permission : "AccessPreview" "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get page preview mobile

This endpoint returns a localized page in default user representation by given id.

For published view use: GET /page/default/{id}

If the requested language is not available it will fall back to the default language.

only accessible with permission : "AccessPreview" "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Page ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
{
  • "channelId": "string",
  • "content": [
    ],
  • "createdAt": 0,
  • "creator": "string",
  • "hasDesktop": true,
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "pagePlatform": "Mobile",
  • "projectId": "string",
  • "publishedAt": 0,
  • "settings": {
    },
  • "status": "Draft",
  • "title": "string",
  • "translations": [
    ]
}

Get article preview mobile

This endpoint returns a localized article in default user representation by given id.

For published view use: GET /news/default/{id}

only accessible with permission : "AccessPreview" "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Article ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "channelId": "string",
  • "content": [
    ],
  • "contentRepresentation": "Mobile",
  • "createdAt": 0,
  • "hasDesktop": true,
  • "headerImage": "string",
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "linkedProjectIds": [
    ],
  • "projectId": "string",
  • "publishedAt": 0,
  • "settings": {
    },
  • "status": "Draft",
  • "teaserText": "string",
  • "timeZone": "Europe/Berlin",
  • "title": "string",
  • "translations": [
    ]
}

Get page preview desktop

This endpoint returns a localized page preview for desktop in default user representation by given id.

For published view use: GET /page/default/{id}/desktop

If there is no specific desktop version of the page the standard (mobile) version of the page will be selected. If the requested language is not available it will fall back to the default language.

only accessible with permission : "AccessPreview" "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Page ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
{
  • "channelId": "string",
  • "content": [
    ],
  • "createdAt": 0,
  • "creator": "string",
  • "hasDesktop": true,
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "pagePlatform": "Mobile",
  • "projectId": "string",
  • "publishedAt": 0,
  • "settings": {
    },
  • "status": "Draft",
  • "title": "string",
  • "translations": [
    ]
}

Get article list preview for project

This endpoint returns a list of all articles for the requested project without content in default representation. The entries are sorted by publishedAt:DESC. If a limit is set, a cursor for this endpoint may be created to iterate over all articles.

For published view list use: GET /news/default/project/{id}

only accessible with permission : "AccessPreview" (counts also for linked projects) "ManageContent" (counts also for linked projects) "ManageProjects"

fully accessible with permission : "ManageContent" (counts also for linked projects) "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cursor

This endpoint returns a cursor for preview list articles in default representation with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

For published list cursor use: GET /news/default/search

only accessible with permission : "AccessPreview" (counts also for linked projects) "ManageContent" (counts also for linked projects) "ManageProjects"

fully accessible with permission : "ManageContent" (counts also for linked projects) "ManageProjects"

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Request Body schema: application/json

options to create cursor

object (news.CursorFilterOptionPreviewDefault)
Array of objects

only one property per entry allowed; property enums: "author" "createdAt" "id" "lastModified" "publishedAt"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Get article preview ids for project

This endpoint returns a list of all articles for the requested project without content in default representation. The entries are sorted by publishedAt:DESC.

For published list ids use: GET /news/default/project/{id}/ids

only accessible with permission : "AccessPreview" (counts also for linked projects) "ManageContent" (counts also for linked projects) "ManageProjects"

fully accessible with permission : "ManageContent" (counts also for linked projects) "ManageProjects"

path Parameters
id
required
string

Project ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
[
  • "string"
]

Get article preview desktop

This endpoint returns a localized article preview for desktop in default user representation by given id.

For published view use: GET /news/default/{id}/desktop

If there is no specific desktop version of the article the standard (mobile) version of the article will be selected.

only accessible with permission : "AccessPreview" "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Article ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
{
  • "author": "string",
  • "channelId": "string",
  • "content": [
    ],
  • "contentRepresentation": "Mobile",
  • "createdAt": 0,
  • "hasDesktop": true,
  • "headerImage": "string",
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "linkedProjectIds": [
    ],
  • "projectId": "string",
  • "publishedAt": 0,
  • "settings": {
    },
  • "status": "Draft",
  • "teaserText": "string",
  • "timeZone": "Europe/Berlin",
  • "title": "string",
  • "translations": [
    ]
}

Appointment (Admin)

Get appointment config

This endpoint is for retrieving one appointment configuration.

Note: Appointments is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Appointment config ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "locationIds": [
    ],
  • "projectId": "string",
  • "receiverGroupIds": [
    ],
  • "requestGroupIds": [
    ],
  • "timeConfig": {
    },
  • "title": "string"
}

Delete appointment config

This endpoint is for deleting an appointment configuration.

Note: Appointments is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Appointment config ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update appointment config

This endpoint is for updating an existing appointment configuration.

Note: Appointments is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Appointment config ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

appointment config to create

locationIds
Array of strings or null

null for all locations, empty array for no location

receiverGroupIds
Array of strings or null

null for all groups, empty array for no group

requestGroupIds
Array of strings or null

null for all groups, empty array for no group

object (model.AppointmentSlotTimeConfig)
title
string

Responses

Request samples

Content type
application/json
{
  • "locationIds": [
    ],
  • "receiverGroupIds": [
    ],
  • "requestGroupIds": [
    ],
  • "timeConfig": {
    },
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "locationIds": [
    ],
  • "projectId": "string",
  • "receiverGroupIds": [
    ],
  • "requestGroupIds": [
    ],
  • "timeConfig": {
    },
  • "title": "string"
}

Get appointment config list for project

This endpoint is for retrieving all appointment configurations for the requested project. If a limit is set, a cursor for this endpoint may be created to iterate over all calendars.

Note: Appointments is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

project ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create appointment config

This endpoint is for creating a new appointment configuration.

Note: Appointments is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

appointment config to create

locationIds
Array of strings or null

null for all locations, empty array for no location

projectId
string
receiverGroupIds
Array of strings or null

null for all groups, empty array for no group

requestGroupIds
Array of strings or null

null for all groups, empty array for no group

object (model.AppointmentSlotTimeConfig)
title
string

Responses

Request samples

Content type
application/json
{
  • "locationIds": [
    ],
  • "projectId": "string",
  • "receiverGroupIds": [
    ],
  • "requestGroupIds": [
    ],
  • "timeConfig": {
    },
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "locationIds": [
    ],
  • "projectId": "string",
  • "receiverGroupIds": [
    ],
  • "requestGroupIds": [
    ],
  • "timeConfig": {
    },
  • "title": "string"
}

Appointment (Default)

Get all appointment slot options

This endpoint is for retrieving all appointment slot options.

accessible without permission

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "allAccountIds": [
    ],
  • "allDurations": [
    ],
  • "allLocationIds": [
    ],
  • "allProjectIds": [
    ],
  • "allStartTimes": [
    ]
}

Create cursor

This endpoint returns a cursor for list appointments in default representation with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

accessible without permission

header Parameters
Session
required
string

JWT

Request Body schema: application/json

options to create cursor

object (appointment.CursorFilterOptionDefault)
Array of objects

only one property per entry allowed; property enums: "expiresAt" "id" "projectId" "requester" "requesterName"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Get possible appointment slot options

This endpoint is for retrieving all possible appointment slot options for requested search. It only applies restrictions but ignores occupied and blocked meeting options as long as it's allowed to create such "conflicts". All values that were returned could be selected to create an appointment.

accessible without permission

header Parameters
Session
required
string

JWT

Request Body schema: application/json

appointment slot search query

object (appointment.SlotFilter)

Responses

Request samples

Content type
application/json
{
  • "filter": {
    }
}

Response samples

Content type
application/json
{
  • "possibleAccountIds": [
    ],
  • "possibleDurationSlots": [
    ],
  • "possibleDurations": [
    ],
  • "possibleLocationIds": [
    ],
  • "possibleProjectIds": [
    ],
  • "possibleSlots": [
    ],
  • "possibleStartTimes": [
    ]
}

Get appointment list for cursor

This endpoint is for retrieving all appointments for the requested cursor in default representation.

Cursor could be created here: POST /calendar/default/appointment/search

accessible without permission

query Parameters
cursor
required
string

id of the cursor used for pagination; required if page is set

page
required
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create appointment

This endpoint is for creating a new appointment.

Note: Appointments is a premium feature and requires a valid subscription.

accessible without permission

header Parameters
Session
required
string

JWT

Request Body schema: application/json

appointment to create

description
string
duration
integer >= 1

minutes

locationId
string or null
locationNote
string
projectId
string
receiverAccountIds
Array of strings
start
integer
title
string

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "duration": 1,
  • "locationId": "string",
  • "locationNote": "string",
  • "projectId": "string",
  • "receiverAccountIds": [
    ],
  • "start": 0,
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "calendarEntryId": "string",
  • "calendarId": "string",
  • "description": "string",
  • "expiresAt": 0,
  • "id": "string",
  • "locationNote": "string",
  • "projectId": "string",
  • "receiver": {
    },
  • "requester": "string",
  • "requesterImage": "string",
  • "requesterName": "string",
  • "title": "string"
}

Get appointment

This endpoint is for retrieving one appointment for requested id.

accessible without permission

path Parameters
id
required
string

Appointment config ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "calendarEntryId": "string",
  • "calendarId": "string",
  • "description": "string",
  • "expiresAt": 0,
  • "id": "string",
  • "locationNote": "string",
  • "projectId": "string",
  • "receiver": {
    },
  • "requester": "string",
  • "requesterImage": "string",
  • "requesterName": "string",
  • "title": "string"
}

Auth

SCRAM First

This endpoint provides the first message of a salted challenge response authentication mechanism (SCRAM). This challenge is used to validate the users password. It is used to perform login or change password with old password. The Platform header is for creating session use range. See RFC 5802 for detail SCRAM definition.

accessible without permission

header Parameters
Platform
string
Enum: "Cms" "Android" "Ios" "Web"

The client platform

Request Body schema: application/json

Clients First Message

email
string
nonce
string

Responses

Request samples

Content type
application/json
{
  • "email": "test@api.plazz",
  • "nonce": "rOprNGfwEbeRWgbNEkqO"
}

Response samples

Content type
application/json
{
  • "expires": 1574864625,
  • "iterationCount": 4096,
  • "nonce": "hvYDpWUa2RaTCAfuxFIlj)hNlF$k0",
  • "salt": "W22ZaJ0SNY7soEsUEjb6gQ=="
}

Calendar (Admin)

Get calendar list settings

This endpoint is for retrieving the list settings of a specific calendar

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Calendar ID

header Parameters
Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "fieldPrimary": "string",
  • "fieldSecondary": "string",
  • "shareEntries": true
}

Update calendar list settings

This endpoint is for updating the list settings of an existing calendar. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

list settings to be updated

fieldPrimary
string or null

itemId // item must be ModuleDirectoryContentRows, ModuleLocations, TextPlainLine or TextBlock

fieldSecondary
string or null

itemId // item must be ModuleDirectoryContentRows, ModuleLocations, TextPlainLine or null if fieldPrimary is TextBlock

shareEntries
boolean

Responses

Request samples

Content type
application/json
{
  • "fieldPrimary": "string",
  • "fieldSecondary": "string",
  • "shareEntries": true
}

Response samples

Content type
application/json
{
  • "fieldPrimary": "string",
  • "fieldSecondary": "string",
  • "shareEntries": true
}

Delete booking

This endpoint is for deleting a booking. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

accountId
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Sync operators for all calendar entries

This endpoint is sync operators for all chat feeds with sendbird. This endpoint should rarely be used because of its workload.

only accessible with permission : "ManageProjects"

fully accessible with permission : "ManageProjects"

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get calendar detail view selections

This endpoint is for retrieving calendar selections.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get calendar access configuration

This endpoint returns the access configuration for the requested calendar. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true
}

Update calendar access configuration

This endpoint updates the access configuration for the requested calendar. Only the changes should be transmitted due this endpoint. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

changed access rights

object

accountId to operation; null for operation removes access

any
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

object

groupId to operation; null for operation removes access

user
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

Responses

Request samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Get calendar detail view items

This endpoint is for retrieving calendar items.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get calendar entries list for calendar

This endpoint is for retrieving all entries of the requested calendar in admin representation. The entries are sorted by dateTime.dateStart:ASC dateTime.timeStart:ASC position:ASC. If a limit is set, a cursor for this endpoint may be created to iterate over all calendar entries.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add calendar entries

This endpoint is for adding new entries to the requested calendar. Calendars of type "Appointment" are readonly. In case of response status is 205 the request was only executed partial. Use GET to receive the stored configuration.

Note: Widgets for tab type WidgetPartyDirectory must not have a referenceId

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

calendar content entries to create; max 100 elements are permitted per request

Array
object (model.Access)
bookingEnabled
boolean <optional>

bookingEnabled can only be true if externalId is not null; Default: false

object
end
integer
externalId
string or null <optional>

externalParty must be set if externalId is set; Default: null

externalParty
string or null <optional>
Value: "Doo"

Default: null

id
string
keywordIds
Array of strings
parentId
string or null
position
integer
publishedAt
integer or null
ratingEnabled
boolean <optional>

Default: true

start
integer
Array of objects (content.EntryTabRequest)
timeZone
string

IANA Time Zone

title
string
object <optional>

Default: {}

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get calendar detail view

This endpoint is for retrieving the detail config, items and selections of a calendar

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "detail": {
    },
  • "items": [
    ],
  • "selections": [
    ]
}

Update calendar detail view

Endpoint is returning 501 only at the moment!

This endpoint is for updating the detail of an existing calendar. New Items need a client generated unique id for setting reference in detail. client generated id will be changed from server so item ids in response will differ! Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

detail to be updated

object (calendar.RequestDetailPart)
Array of objects (calendar.RequestItem)
Array of objects (calendar.RequestCalendarSelection)

Responses

Request samples

Content type
application/json
{
  • "detail": {
    },
  • "items": [
    ],
  • "selections": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": {
    },
  • "items": [
    ],
  • "selections": [
    ]
}

Create calendar

This endpoint is for creating a new calendar for chosen template.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

calendar to create

object <optional>

Default: {"any": "Read", "user": "Read", "accounts": {}, "groups": {}}

description
string
projectId
string
templateId
string or null
title
string

Responses

Request samples

Content type
application/json
{
  • "access": {
    },
  • "description": "string",
  • "projectId": "string",
  • "templateId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "createAccesses": {
    },
  • "description": "string",
  • "detail": {
    },
  • "entriesCount": 0,
  • "id": "string",
  • "items": [
    ],
  • "listSettings": {
    },
  • "period": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "type": "Appointment"
}

Get calendar

This endpoint is for retrieving one calendar in admin representation.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "createAccesses": {
    },
  • "description": "string",
  • "detail": {
    },
  • "entriesCount": 0,
  • "id": "string",
  • "items": [
    ],
  • "listSettings": {
    },
  • "period": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "type": "Appointment"
}

Delete calendar

This endpoint is for deleting a calendar with all localizations. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update calendar info

This endpoint is for updating the base info of an existing calendar. Calendars of type "Appointment" are readonly.

createAccesses.CalendarEntry.any: must be false; true currently not supported

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Calendar ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

calendar information to be updated

object

property enums: "CalendarEntry"; see route description for additional information

description
string
title
string

Responses

Request samples

Content type
application/json
{
  • "createAccesses": {
    },
  • "description": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "createAccesses": {
    },
  • "description": "string",
  • "detail": {
    },
  • "entriesCount": 0,
  • "id": "string",
  • "items": [
    ],
  • "listSettings": {
    },
  • "period": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "type": "Appointment"
}

Get calendar entry access configuration

This endpoint returns the access configuration for the requested calendar entry. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true
}

Update calendar entry access configuration

This endpoint updates the access configuration for the requested calendar entry. Only the changes should be transmitted due this endpoint. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

changed access rights

object

accountId to operation; null for operation removes access

any
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

object

groupId to operation; null for operation removes access

user
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

Responses

Request samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Get calendar list for project

This endpoint is for retrieving all calendars of a project in admin representation. If a limit is set, a cursor for this endpoint may be created to iterate over all calendars.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get calendar template list

This endpoint retrieving templates to enhance the creation of new calendars. If a limit is set, a cursor for this endpoint may be created to iterate over all templates.

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get calendar entry

This endpoint is for retrieving an entry of a calendar.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "bookingEnabled": true,
  • "calendarId": "string",
  • "dataSet": {
    },
  • "dateTime": {
    },
  • "detailDisabled": true,
  • "end": 0,
  • "externalId": "string",
  • "externalParty": "Doo",
  • "id": "string",
  • "isAppointment": true,
  • "keywordIds": [
    ],
  • "parentId": "string",
  • "position": 0,
  • "projectId": "string",
  • "publishedAt": 0,
  • "ratingEnabled": true,
  • "ratingResult": [
    ],
  • "start": 0,
  • "tabs": [
    ],
  • "timeZone": "string",
  • "title": "string",
  • "translations": [
    ],
  • "widgets": {
    }
}

Update calendar entry

This endpoint is for updating a calendar entry. Calendars of type "Appointment" are readonly.

Note: Widgets for tab type WidgetPartyDirectory must not have a referenceId

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

calendar content entry to be replaced

bookingEnabled
boolean <optional>

bookingEnabled can only be true if externalId is not null; Default: false

object
end
integer
externalId
string or null <optional>

externalParty must be set if externalId is set; Default: null

externalParty
string or null <optional>
Value: "Doo"

Default: null

keywordIds
Array of strings
parentId
string or null
position
integer
publishedAt
integer or null
ratingEnabled
boolean <optional>

Default: true

start
integer
Array of objects (content.EntryTabRequest)
timeZone
string

IANA Time Zone

title
string
object <optional>

Default: {}

Responses

Request samples

Content type
application/json
{
  • "bookingEnabled": true,
  • "dataSet": {
    },
  • "end": 0,
  • "externalId": "string",
  • "externalParty": "Doo",
  • "keywordIds": [
    ],
  • "parentId": "string",
  • "position": 0,
  • "publishedAt": 0,
  • "ratingEnabled": true,
  • "start": 0,
  • "tabs": [
    ],
  • "timeZone": "string",
  • "title": "string",
  • "widgets": {
    }
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "bookingEnabled": true,
  • "calendarId": "string",
  • "dataSet": {
    },
  • "dateTime": {
    },
  • "detailDisabled": true,
  • "end": 0,
  • "externalId": "string",
  • "externalParty": "Doo",
  • "id": "string",
  • "isAppointment": true,
  • "keywordIds": [
    ],
  • "parentId": "string",
  • "position": 0,
  • "projectId": "string",
  • "publishedAt": 0,
  • "ratingEnabled": true,
  • "ratingResult": [
    ],
  • "start": 0,
  • "tabs": [
    ],
  • "timeZone": "string",
  • "title": "string",
  • "translations": [
    ],
  • "widgets": {
    }
}

Delete calendar entry

This endpoint is for deleting a calendar entry. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Create booking

This endpoint is for creating calendar entry's booking in admin representation. Calendars of type "Appointment" are readonly.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

booking to create

accountId
string
ticketCode
string non-empty
ticketParty
string

Responses

Request samples

Content type
application/json
{
  • "accountId": "string",
  • "ticketCode": "string",
  • "ticketParty": "string"
}

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "ticketCode": "string",
  • "ticketParty": "string"
}

Calendar (Default)

Get calendar

This endpoint is for retrieving one calendar in default representation. If the requested language is not available it will fall back to the default language.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Calendar ID

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "detail": {
    },
  • "entriesCount": 0,
  • "id": "string",
  • "items": [
    ],
  • "listSettings": {
    },
  • "period": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "translations": [
    ],
  • "type": "Appointment"
}

Get calendar entries list for calendar

This endpoint is for retrieving all entries of the requested calendar in default representation. The entries are sorted by dateTime.dateStart:ASC dateTime.timeStart:ASC position:ASC. If a limit is set, a cursor for this endpoint may be created to iterate over all calendar entries.

accessible without permission

path Parameters
id
required
string

Calendar ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get calendar entries list for cursor

This endpoint is for retrieving all entries for the requested cursor in default representation.

Cursor could be created here: POST /calendar/default/entry/search

accessible without permission

query Parameters
cursor
required
string

id of the cursor used for pagination; required if page is set

page
required
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get calendar entry

This endpoint is for retrieving an entry of a calendar.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects" (not for "Appointment" calendars)

path Parameters
id
required
string

Entry ID

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "bookingEnabled": true,
  • "calendarId": "string",
  • "dataSet": {
    },
  • "dateTime": {
    },
  • "detailDisabled": true,
  • "end": 0,
  • "id": "string",
  • "isAppointment": true,
  • "keywordIds": [
    ],
  • "parentId": "string",
  • "position": 0,
  • "projectId": "string",
  • "publishedAt": 0,
  • "ratingEnabled": true,
  • "start": 0,
  • "tabs": [
    ],
  • "title": "string",
  • "translations": [
    ],
  • "widgets": {
    }
}

Get booking

This endpoint is for retrieving calendar entry's booking in default representation.

accessible without permission (can only be used for the own account. Session must match requested account id.)

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "ticketCode": "string"
}

Create entry cursor

This endpoint returns a cursor for list published calendar entries in default representation with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

accessible without permission

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Request Body schema: application/json

options to create cursor

bookingEnabled
Array of booleans <optional> [ items <optional > ]
calendarIds
Array of strings <optional>
object <optional>

property is itemId to filter values for

ids
Array of strings <optional>
keywordIds
Array of strings <optional>
object <optional>

property is itemId to filter values for

parentIds
Array of strings <optional>
searchLanguage
string <optional>

specifies the language the search string should be interpreted in // TODO: TBD

searchString
string <optional> >= 3 characters

must be empty or have at least 3 characters; Default: "" LiveSearch: space separated groups of characters are treated as disjunctive regex group; WordSearch: exact match of whole words, for phrases wrap in escaped double quotes, exclude words by prepending "-"

searchType
string <optional>
Enum: "LiveSearch" "WordSearch"

specifies how searchString should be interpreted; Default: LiveSearch

object <optional>

property is itemId to filter values for

Responses

Request samples

Content type
application/json
{
  • "bookingEnabled": [
    ],
  • "calendarIds": [
    ],
  • "directoryContentRowIds": {
    },
  • "ids": [
    ],
  • "keywordIds": [
    ],
  • "locationIds": {
    },
  • "parentIds": [
    ],
  • "searchLanguage": "string",
  • "searchString": "string",
  • "searchType": "LiveSearch",
  • "selectionOptionIds": {
    }
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Get my calendar

This endpoint is for retrieving my calendar in default representation.

accessible without permission

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "detail": {
    },
  • "entriesCount": 0,
  • "id": "string",
  • "items": null,
  • "listSettings": {
    },
  • "period": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "translations": [
    ],
  • "type": "Appointment"
}

Get calendar entries list for my calendar

This endpoint is for retrieving all entries of my calendar in default representation. The entries are sorted by dateTime.dateStart:ASC dateTime.timeStart:ASC position:ASC. If a limit is set, a cursor for this endpoint may be created to iterate over all calendar entries.

accessible without permission

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Accept-Language
string

client language(s)

Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Chat (Admin)

Get list of chat channels

This endpoint is for getting list of all chat channels. If a limit is set, a cursor for this endpoint may be created to iterate over all chat channels.

only accessible with admin role

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create chat feed

This endpoint is for creating a new chat feed.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

Chat-Feed to create

object (model.Access)
image
string or null

a media image id from project or global context

projectId
string
title
string

Responses

Request samples

Content type
application/json
{
  • "access": {
    },
  • "image": "string",
  • "projectId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "creator": "string",
  • "id": "string",
  • "image": "string",
  • "projectId": "string",
  • "title": "string",
  • "visits": 0
}

Get chat feed

This endpoint is for retrieving a single chat feed in admin representation.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Chat Feed ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "creator": "string",
  • "id": "string",
  • "image": "string",
  • "projectId": "string",
  • "title": "string",
  • "visits": 0
}

Delete chat feed

This endpoint is for deleting a single chat feed.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Form ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update chat feed

This endpoint is for updating an existing chat feed

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Chat Feed ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

chat feed data to update

image
string or null

a media image id from project or global context

title
string

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "creator": "string",
  • "id": "string",
  • "image": "string",
  • "projectId": "string",
  • "title": "string",
  • "visits": 0
}

delete a chat channel

This endpoint is for deleting a single chat channel.

only accessible with admin role

path Parameters
channelURL
required
string

The Sendbird Channel ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get chat feeds of project

This endpoint is for retrieving all chat feeds of a project in admin representation. If a limit is set, a cursor for this endpoint may be created to iterate over all chat feeds.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get chat feed access configuration

This endpoint returns the access configuration for the requested chat feed.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

ChatFeed ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true
}

Update chat feed access configuration

This endpoint updates the access configuration for the requested chat feed. Only the changes should be transmitted due this endpoint.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

ChatFeed ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

changed access rights

object

accountId to operation; null for operation removes access

any
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

object

groupId to operation; null for operation removes access

user
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

Responses

Request samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Sync Operators for all chat feeds

This endpoint is sync operators for all chat feeds with sendbird. This endpoint should be rarely used, because of its workload.

only accessible with permission : "ManageProjects"

fully accessible with permission : "ManageProjects"

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Chat (Default)

Get chat feeds of project

This endpoint is for retrieving all chat feeds of a project in default representation. If the requested language is not available it will fall back to the default language. If a limit is set, a cursor for this endpoint may be created to iterate over all chat feeds.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get requests for all chat channels for requesting account

This endpoint returns all pending requests for all channels for the current user. If a limit is set, a cursor for this endpoint may be created to iterate over all pending requests.

accessible without permission

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get requests for chat channels

This endpoint returns all requests for the requested channels.

Note: Only operators of the provided sendbird channels can call this endpoint

accessible without permission

header Parameters
Session
required
string

JWT

Request Body schema: application/json

channelURLs

channelUrls
Array of strings <= 100 items

Responses

Request samples

Content type
application/json
{
  • "channelUrls": [
    ]
}

Response samples

Content type
application/json
[
  • {
    }
]

Join chat feed

This endpoint is for joining a chat feed.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Chat Feed ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

request join for protected chat channel

This endpoint is for joining a protected chat channel

If user is already a member of the channel a http 200 is returned without creating a request.

accessible without permission

path Parameters
channelURL
required
string

The Sendbird Channel URL

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get chat feed

This endpoint is for retrieving a single chat feed in default representation. If the requested language is not available it will fall back to the default language.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Chat Feed ID

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "channelId": "string",
  • "id": "string",
  • "image": "string",
  • "isMember": true,
  • "projectId": "string",
  • "title": "string",
  • "translations": [
    ]
}

get requests for chat channel

This endpoint returns all requests for the requested channel.

Note: Only operators of the provided sendbird channel can call this endpoint

accessible without permission

path Parameters
channelURL
required
string

The Sendbird Channel URL

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

get request of account for chat channel

This endpoint returns the request of an account for a chat channel.

Note: Only operators of the provided sendbird channel and the requesting accountID can call this endpoint

accessible without permission

path Parameters
channelURL
required
string

The Sendbird Channel URL

id
required
string

The ID of the account which should be processed

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "channelUrl": "string",
  • "requestedAt": 0
}

process join request for protected chat channel

This endpoint is for processing a joining request for a protected chat channel

Note: Only operators of the provided sendbird channel can call this endpoint

accessible without permission

path Parameters
channelURL
required
string

The Sendbird Channel URL

id
required
string

The ID of the account which should be processed

header Parameters
Session
required
string

JWT

Request Body schema: application/json

action to be performed

action
string
Enum: "Accept" "Decline"

Responses

Request samples

Content type
application/json
{
  • "action": "Accept"
}

Response samples

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

invite users to protected chat channel

This endpoint is for inviting users to a protected chat channel In case of response status is 205 the request was only executed partial.

Note: Only operators of the provided sendbird channel can call this endpoint

accessible without permission

path Parameters
channelURL
required
string

The Sendbird Channel URL

header Parameters
Session
required
string

JWT

Request Body schema: application/json

Account IDs

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

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

Config (Admin)

Get premium features

This endpoint returns the premium configuration in admin representation.

accessible without permission

fully accessible with permission : "Plazz"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "appointment": {
    },
  • "autoTranslation": {
    },
  • "journey": {
    },
  • "recommendation": {
    },
  • "systemNotificationMuted": {
    },
  • "whitelabel": {
    }
}

Update premium features

This endpoint updates the premium configuration.

only accessible with permission : "Plazz"

fully accessible with permission : "Plazz"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

premium configuration to be updated

object (model.FeaturePaidUntil)
object (model.AutoTranslation)
object (model.FeaturePaidUntil)
object (model.RecommendationConfig)
object (model.SystemNotification)
object (model.FeaturePaidUntil)

Responses

Request samples

Content type
application/json
{
  • "appointment": {
    },
  • "autoTranslation": {
    },
  • "journey": {
    },
  • "recommendation": {
    },
  • "systemNotificationMuted": {
    },
  • "whitelabel": {
    }
}

Response samples

Content type
application/json
{
  • "appointment": {
    },
  • "autoTranslation": {
    },
  • "journey": {
    },
  • "recommendation": {
    },
  • "systemNotificationMuted": {
    },
  • "whitelabel": {
    }
}

Get features

This endpoint returns the features configuration in admin representation. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "chat": {
    }
}

Update features

This endpoint is for updating the features configuration. The If-Modified-Since header can be used for omitting the request if nothing has changed.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

features data to be updated

object (configuration.PatchChatRequestAdmin)

Responses

Request samples

Content type
application/json
{
  • "chat": {
    }
}

Response samples

Content type
application/json
{
  • "chat": {
    }
}

Get factory default security settings

This endpoint returns the default security configuration in administrative representation. This can be used for reset settings to default value.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "blockOldPasswords": 0,
  • "loginActivated": true,
  • "loginTerms": true,
  • "lowerCaseRequired": true,
  • "minPasswordLength": 1,
  • "numberRequired": true,
  • "passwordExpiration": 1,
  • "preventDictionaryAttack": true,
  • "refreshTokenLifetime": 1,
  • "registrationActivated": true,
  • "specialLettersRequired": true,
  • "trackingEnabled": true,
  • "upperCaseRequired": true
}

Get factory default for system scheme

This endpoint returns the default data of a system scheme in administrative representation by given id.

accessible without permission

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Scheme ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "dark": {
    },
  • "darkAuto": {
    },
  • "id": "string",
  • "light": {
    },
  • "systemScheme": true,
  • "title": "Cherry Blossom"
}

Get Custom CSS

This endpoint returns the custom css settings in admin representation.

only accessible with permission : "Plazz"

fully accessible with permission : "Plazz"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "customCss": "body { background-color: #000000; }",
  • "customCssStatus": "Draft"
}

Update Custom CSS

This endpoint updates the custom css settings in admin representation.

only accessible with permission : "Plazz"

fully accessible with permission : "Plazz"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

custom css

customCss
string

css code

customCssStatus
string
Enum: "Draft" "Published"

Responses

Request samples

Content type
application/json
{
  • "customCss": "body { background-color: #000000; }",
  • "customCssStatus": "Draft"
}

Response samples

Content type
application/json
{
  • "customCss": "body { background-color: #000000; }",
  • "customCssStatus": "Draft"
}

Get scheme

This endpoint returns a scheme in administrative representation by given id. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Scheme ID

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp of the last sync

Responses

Response samples

Content type
application/json
{
  • "dark": {
    },
  • "darkAuto": {
    },
  • "id": "string",
  • "light": {
    },
  • "systemScheme": true,
  • "title": "Cherry Blossom"
}

Delete custom scheme

This endpoint is for deleting a single scheme. System schemes are not deletable. The If-Modified-Since header can be used for omitting the request if nothing has changed.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Scheme ID

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp of the last sync

Responses

Response samples

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

Update scheme

This endpoint is for updating specific data of an existing scheme. The title of system schemes is not editable. The If-Modified-Since header can be used for omitting the request if nothing has changed.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Scheme ID

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp

Request Body schema: application/json

scheme to create

object (model.Palette)
object (model.PaletteAuto)
object (model.Palette)
title
string

Responses

Request samples

Content type
application/json
{
  • "dark": {
    },
  • "darkAuto": {
    },
  • "light": {
    },
  • "title": "Cherry Blossom"
}

Response samples

Content type
application/json
{
  • "dark": {
    },
  • "darkAuto": {
    },
  • "id": "string",
  • "light": {
    },
  • "systemScheme": true,
  • "title": "Cherry Blossom"
}

Get security settings

This endpoint returns the security configuration in administrative representation. This endpoint returns the security configuration in administrative representation. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp of the last sync

Responses

Response samples

Content type
application/json
{
  • "blockOldPasswords": 0,
  • "loginActivated": true,
  • "loginTerms": true,
  • "lowerCaseRequired": true,
  • "minPasswordLength": 1,
  • "numberRequired": true,
  • "passwordExpiration": 1,
  • "preventDictionaryAttack": true,
  • "refreshTokenLifetime": 1,
  • "registrationActivated": true,
  • "specialLettersRequired": true,
  • "trackingEnabled": true,
  • "upperCaseRequired": true
}

Update security settings

This endpoint is for updating specific data of the security configuration. The If-Modified-Since header can be used for omitting the request if nothing has changed.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp

Request Body schema: application/json

security data to be updated

blockOldPasswords
integer
loginActivated
boolean
loginTerms
boolean

specify if there are terms of use or privacy policy the user have to confirm for login first

lowerCaseRequired
boolean
minPasswordLength
integer >= 1
numberRequired
boolean
passwordExpiration
integer or null >= 1

amount of days

preventDictionaryAttack
boolean
refreshTokenLifetime
integer [ 1 .. 360 ]

token lifetime in days

registrationActivated
boolean
specialLettersRequired
boolean
upperCaseRequired
boolean

Responses

Request samples

Content type
application/json
{
  • "blockOldPasswords": 0,
  • "loginActivated": true,
  • "loginTerms": true,
  • "lowerCaseRequired": true,
  • "minPasswordLength": 1,
  • "numberRequired": true,
  • "passwordExpiration": 1,
  • "preventDictionaryAttack": true,
  • "refreshTokenLifetime": 1,
  • "registrationActivated": true,
  • "specialLettersRequired": true,
  • "upperCaseRequired": true
}

Response samples

Content type
application/json
{
  • "blockOldPasswords": 0,
  • "loginActivated": true,
  • "loginTerms": true,
  • "lowerCaseRequired": true,
  • "minPasswordLength": 1,
  • "numberRequired": true,
  • "passwordExpiration": 1,
  • "preventDictionaryAttack": true,
  • "refreshTokenLifetime": 1,
  • "registrationActivated": true,
  • "specialLettersRequired": true,
  • "trackingEnabled": true,
  • "upperCaseRequired": true
}

Get design

This endpoint returns the design configuration in administrative representation. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp of the last sync

Responses

Response samples

Content type
application/json
{
  • "backgroundDarkPrimary": "#000000",
  • "backgroundDarkPrimaryAuto": true,
  • "backgroundDarkSecondary": "#000000",
  • "backgroundDarkSecondaryAuto": true,
  • "backgroundLightPrimary": "#FFFFFF",
  • "backgroundLightSecondary": "#FFFFFF",
  • "backgroundType": "Gradient",
  • "companyLogo": "5d9ef49c396f2d5d84806146",
  • "schemeCurrent": "5e1705243a2ef1289ae3cbc2"
}

Update design

This endpoint is for updating specific data of the design configuration. The If-Modified-Since header can be used for omitting the request if nothing has changed.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp

Request Body schema: application/json

design data to be updated

backgroundDarkPrimary
string

only used for backgroundType{Gradient|Color}; hexcolor or enum: "backgroundPrimary" "backgroundSecondary" "backgroundTertiary" "border" "contrast" "error" "primary" "secondary" "success" "textPrimary" "textSecondary"

backgroundDarkPrimaryAuto
boolean

only used for backgroundType{Gradient|Color}

backgroundDarkSecondary
string

only used for backgroundType{Gradient}; hexcolor or enum: "backgroundPrimary" "backgroundSecondary" "backgroundTertiary" "border" "contrast" "error" "primary" "secondary" "success" "textPrimary" "textSecondary"

backgroundDarkSecondaryAuto
boolean

only used for backgroundType{Gradient}

backgroundLightPrimary
string

only used for backgroundType{Gradient|Color}; hexcolor or enum: "backgroundPrimary" "backgroundSecondary" "backgroundTertiary" "border" "contrast" "error" "primary" "secondary" "success" "textPrimary" "textSecondary"

backgroundLightSecondary
string

only used for backgroundType{Gradient}; hexcolor or enum: "backgroundPrimary" "backgroundSecondary" "backgroundTertiary" "border" "contrast" "error" "primary" "secondary" "success" "textPrimary" "textSecondary"

backgroundType
string
Enum: "Gradient" "Color" "Transparent"
companyLogo
string or null

media id

schemeCurrent
string

scheme id

Responses

Request samples

Content type
application/json
{
  • "backgroundDarkPrimary": "#000000",
  • "backgroundDarkPrimaryAuto": true,
  • "backgroundDarkSecondary": "#000000",
  • "backgroundDarkSecondaryAuto": true,
  • "backgroundLightPrimary": "#FFFFFF",
  • "backgroundLightSecondary": "#FFFFFF",
  • "backgroundType": "Gradient",
  • "companyLogo": "5d9ef49c396f2d5d84806146",
  • "schemeCurrent": "5e1705243a2ef1289ae3cbc2"
}

Response samples

Content type
application/json
{
  • "backgroundDarkPrimary": "#000000",
  • "backgroundDarkPrimaryAuto": true,
  • "backgroundDarkSecondary": "#000000",
  • "backgroundDarkSecondaryAuto": true,
  • "backgroundLightPrimary": "#FFFFFF",
  • "backgroundLightSecondary": "#FFFFFF",
  • "backgroundType": "Gradient",
  • "companyLogo": "5d9ef49c396f2d5d84806146",
  • "schemeCurrent": "5e1705243a2ef1289ae3cbc2"
}

Get knowledge base articles

This endpoint returns all articles for a objectType in de and en

This keys of the object represents the language codes (de-DE|en-US).

accessible without permission

path Parameters
objectType
required
string
Enum: "Account" "Calendar" "ChatFeed" "Configuration" "Directory" "Location" "LocationMap" "Keyword" "Media" "Menu" "News" "Notification" "Page" "Project" "ProjectTracking" "Shipping" "Stream"

objectType

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "property1": {
    },
  • "property2": {
    }
}

Get factory default design

This endpoint returns the default design configuration in administrative representation. This can be used for reset settings to default value.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "backgroundDarkPrimary": "#000000",
  • "backgroundDarkPrimaryAuto": true,
  • "backgroundDarkSecondary": "#000000",
  • "backgroundDarkSecondaryAuto": true,
  • "backgroundLightPrimary": "#FFFFFF",
  • "backgroundLightSecondary": "#FFFFFF",
  • "backgroundType": "Gradient",
  • "companyLogo": "5d9ef49c396f2d5d84806146",
  • "schemeCurrent": "5e1705243a2ef1289ae3cbc2"
}

Get schemes list

This endpoint returns an array of all scheme. The output is in administrative representation. The If-Modified-Since header can be used for omitting the output if nothing has changed. If a limit is set, a cursor for this endpoint may be created to iterate over all schemes.

accessible without permission

fully accessible with permission : "ManageConfiguration"

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

If-Modified-Since
integer

unix timestamp of the last sync

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create custom scheme

This endpoint is for creating a new scheme.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

scheme to create

object (model.Palette)
object (model.PaletteAuto)
object (model.Palette)
title
string

Responses

Request samples

Content type
application/json
{
  • "dark": {
    },
  • "darkAuto": {
    },
  • "light": {
    },
  • "title": "Cherry Blossom"
}

Response samples

Content type
application/json
{
  • "dark": {
    },
  • "darkAuto": {
    },
  • "id": "string",
  • "light": {
    },
  • "systemScheme": true,
  • "title": "Cherry Blossom"
}

Config (Default)

Get design

This endpoint returns the design configuration in default representation. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
If-Modified-Since
integer

unix timestamp of the last sync

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "backgroundDarkPrimary": "#000000",
  • "backgroundDarkSecondary": "#000000",
  • "backgroundLightPrimary": "#FFFFFF",
  • "backgroundLightSecondary": "#FFFFFF",
  • "backgroundType": "Gradient",
  • "companyLogo": "5d9ef49c396f2d5d84806146",
  • "customCss": "body { background-color: #000000; }",
  • "menu": {
    },
  • "schemeCurrent": "5e1705243a2ef1289ae3cbc2"
}

Get premium features

This endpoint returns the premium configuration in default representation.

accessible without permission

fully accessible with permission : "Plazz"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "appointment": {
    },
  • "autoTranslation": {
    },
  • "journey": {
    },
  • "recommendation": {
    },
  • "systemNotificationMuted": {
    },
  • "whitelabel": {
    }
}

Get security settings

This endpoint returns the security configuration in default representation. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
If-Modified-Since
integer

unix timestamp of the last sync

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "loginActivated": true,
  • "loginTerms": true,
  • "lowerCaseRequired": true,
  • "minPasswordLength": 1,
  • "numberRequired": true,
  • "registrationActivated": true,
  • "specialLettersRequired": true,
  • "trackingEnabled": true,
  • "upperCaseRequired": true
}

Get scheme

This endpoint returns a scheme in default representation by given id. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Scheme ID

header Parameters
Session
string

JWT

If-Modified-Since
integer

unix timestamp of the last sync

Responses

Response samples

Content type
application/json
{
  • "dark": {
    },
  • "id": "string",
  • "light": {
    }
}

Get features

This endpoint returns the features configuration in default representation. The If-Modified-Since header can be used for omitting the output if nothing has changed.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "chat": {
    }
}

Connected App

get connected apps list

This endpoint is for retrieving all existing connected apps, which are currently stored in db.

only accessible with permission : "ManageApps"

fully accessible with permission : "ManageApps"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create connected app

This endpoint is for creating a new connected app. It also creates a new technical account that will be linked with the connected app. You are only allowed to add roles that have permissions you already own through your roles. If you have "ManageGlobalRoles" you are allowed to add all roles.

only accessible with permission : "ManageApps"

fully accessible with permission : "ManageApps"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

Connected app to create

description
string
Array of objects (model.AccountRole)
title
string
url
string or null

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "roles": [
    ],
  • "title": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "roles": [
    ],
  • "secrets": {
    },
  • "title": "string",
  • "url": "string"
}

get connected app

This endpoint is for retrieving one connected app, which is currently stored in db.

only accessible with permission : "ManageApps"

fully accessible with permission : "ManageApps"

path Parameters
id
required
string

Connected App ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "roles": [
    ],
  • "secrets": {
    },
  • "title": "string",
  • "url": "string"
}

Delete connected app

Deletes a connected app by given id and removes the roles from the linked robot account.

only accessible with permission : "ManageApps"

fully accessible with permission : "ManageApps"

path Parameters
id
required
string

Connected App ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update connected app

This endpoint updates the requested connected App. It also updates the linked technical account for the connected app. Only the changes should be transmitted due this endpoint.

only accessible with permission : "ManageApps"

fully accessible with permission : "ManageApps"

path Parameters
id
required
string

Connected App ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

changed connected app

description
string
Array of objects (model.AccountRole)
title
string
url
string or null

Responses

Request samples

Content type
application/json
{
  • "description": "string",
  • "roles": [
    ],
  • "title": "string",
  • "url": "string"
}

Response samples

Content type
application/json
{
  • "description": "string",
  • "id": "string",
  • "roles": [
    ],
  • "secrets": {
    },
  • "title": "string",
  • "url": "string"
}

Add secret

This endpoint updates the requested connected App to add a new secret.

only accessible with permission : "ManageApps"

fully accessible with permission : "ManageApps"

path Parameters
id
required
string

Connected App ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

expiration timestamp for secret

expiration
integer or null

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "expiration": 0,
  • "secret": "string"
}

Remove secret

Deletes a secret by given of a connected app

only accessible with permission : "ManageApps"

fully accessible with permission : "ManageApps"

path Parameters
id
required
string

Connected App ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

secret to be removed

secret
string

Responses

Request samples

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

Response samples

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

Create session

This endpoint creates a session for a connected app

accessible without permission

path Parameters
id
required
string

Connected App ID

header Parameters
Secret
required
string

connected app token

Responses

Response samples

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

Directory (Admin)

Get directory list for project

This endpoint is for retrieving all directories of a project in admin representation. If a limit is set, a cursor for this endpoint may be created to iterate over all directories.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get directory list for cursor

This endpoint is for retrieving all directories for the requested cursor in admin representation.

Cursor could be created here: POST /directory/admin/search

accessible without permission

query Parameters
cursor
required
string

id of the cursor used for pagination; required if page is set

page
required
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create directory

This endpoint is for creating a new directory for chosen template.

Supported objectTypes for contentRowFilter:

  • contentRowObjectType = "Account" supported objectTypes: "Group"

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

directory to create

object <optional>

Default: {"any": "Read", "user": "Read", "accounts": {}, "groups": {}}

object or null

see route description for additional information

contentRowObjectType
string or null
Enum: "Role" "Party" "PartyReaction" "Group" "Configuration" "Localization" "Scheme" "Keyword" "KeywordCategory" "ConnectedApp" "Appointment" "AppointmentConfig" "Calendar" "CalendarBodySection" "CalendarItem" "CalendarSelection" "CalendarSelectionOption" "CalendarEntry" "CalendarEntryTab" "CalendarEntryWidget" "CalendarTemplate" "Webhook" "WebhookLogMessage" "Page" "PageSection" "PageColumn" "PageItem" "Selection" "SelectionOption" "AccountMatch" "Index" "Directory" "DirectoryBodySection" "DirectoryItem" "DirectorySelection" "DirectorySelectionOption" "DirectoryContentRow" "DirectoryTemplate" "Stream" "Shipping" "ShippingData" "Bookmark" "Journey" "JourneyProcess" "Reaction" "Account" "AccountSettingsAnalyticsRecord" "Notification" "NotificationJob" "AccountNotification" "Menu" "MenuItem" "Location" "LocationMap" "LocationMapMarker" "SsoProvider" "CronJob" "Media" "MediaAudio" "MediaDocument" "MediaDownloadRequest" "MediaFolder" "MediaIcon" "MediaImage" "MediaOther" "MediaVideo" "Project" "ProjectTracking" "ProjectCopyProcess" "ChatChannel" "ChatChannelRequest" "ChatFeed" "News" "NewsSection" "NewsColumn" "NewsItem"

null = static directory

description
string
projectId
string
templateId
string or null

must be null for dynamic directory

title
string

Responses

Request samples

Content type
application/json
{
  • "access": {
    },
  • "contentRowFilter": {
    },
  • "contentRowObjectType": "Account",
  • "description": "string",
  • "projectId": "string",
  • "templateId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "contentRowFilter": {
    },
  • "contentRowObjectType": "Account",
  • "contentRowsCount": 0,
  • "createAccesses": {
    },
  • "description": "string",
  • "detail": {
    },
  • "id": "string",
  • "isSystem": true,
  • "items": [
    ],
  • "listSettings": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "type": "Account",
  • "typeReferenceId": "string"
}

Create cursor

This endpoint returns a cursor for list directories in admin representation with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

options to create cursor

object (directory.CursorFilterOptionAdmin)
Array of objects

only one property per entry allowed; property enums: "id" "lastModified"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Get directory template list

This endpoint retrieving templates to enhance the creation of new directories. If a limit is set, a cursor for this endpoint may be created to iterate over all templates.

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get directory row access configuration

This endpoint returns the access configuration for the requested directory row.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true
}

Update directory row access configuration

This endpoint updates the access configuration for the requested directory row. Only the changes should be transmitted due this endpoint.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

changed access rights

object

accountId to operation; null for operation removes access

any
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

object

groupId to operation; null for operation removes access

user
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

Responses

Request samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Get directory detail view selections

This endpoint is for retrieving directory selections.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get directory

This endpoint returns a localized directory in administrative representation by given id.

DateTime formats:

  • "DateOnly": "2006-01-02"
  • "DateTime": "2006-01-02 15:04:05"
  • "RFC822X": "02 Jan 06 15:04"
  • "RFC1123X": "Mon, 02 Jan 2006 15:04"
  • "RFC1123DateOnly": "Mon, 02 Jan 2006"
  • "TimeOnlyX": "15:04"

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "contentRowFilter": {
    },
  • "contentRowObjectType": "Account",
  • "contentRowsCount": 0,
  • "createAccesses": {
    },
  • "description": "string",
  • "detail": {
    },
  • "id": "string",
  • "isSystem": true,
  • "items": [
    ],
  • "listSettings": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "type": "Account",
  • "typeReferenceId": "string"
}

Delete directory

This endpoint is for deleting a directory with all localizations.

Note: if isSystem = true the directory is not deletable, api call will result in a http 409

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update directory info

This endpoint is for updating the base info of an existing directory. System directories have limited patch support

Supported objectTypes for contentRowFilter:

  • contentRowObjectType = "Account" supported objectTypes: "Group"

createAccesses.DirectoryContentRow.any: must be false; true currently not supported

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

directory information to be updated

object or null

see route description for additional information, readonly for system directories

object

property enums: "DirectoryContentRow"; see route description for additional information

description
string

readonly for system directories

title
string

Responses

Request samples

Content type
application/json
{
  • "contentRowFilter": {
    },
  • "createAccesses": {
    },
  • "description": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "contentRowFilter": {
    },
  • "contentRowObjectType": "Account",
  • "contentRowsCount": 0,
  • "createAccesses": {
    },
  • "description": "string",
  • "detail": {
    },
  • "id": "string",
  • "isSystem": true,
  • "items": [
    ],
  • "listSettings": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "type": "Account",
  • "typeReferenceId": "string"
}

Get directory detail view items

This endpoint is for retrieving directory items.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get directory access configuration

This endpoint returns the access configuration for the requested directory.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true
}

Update directory access configuration

This endpoint updates the access configuration for the requested directory. Only the changes should be transmitted due this endpoint.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

changed access rights

object

accountId to operation; null for operation removes access

any
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

object

groupId to operation; null for operation removes access

user
string or null
Enum: "Read" "Write" "Delete" "Create" "changeProof"

Delete (includes) Write (includes) Read; null for operation removes access

Responses

Request samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Response samples

Content type
application/json
{
  • "accounts": {
    },
  • "any": "Read",
  • "groups": {
    },
  • "user": "Read"
}

Get directory content row

This endpoint is for retrieving a content row of a directory.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "createdAt": 0,
  • "creator": "string",
  • "data": [
    ],
  • "directoryId": "string",
  • "featured": true,
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "position": 0
}

Update directory content row

This endpoint is for updating a directory content row by row ID.

Note: rows for dynamic directory (contentRowObjectType != null) are not changeable here. Status 409 Conflict will be returned.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

directory content row to be replaced

Array of objects (content.RowValueRequest)
featured
boolean
keywordIds
Array of strings <optional>

Default: []

position
integer

Responses

Request samples

Content type
application/json
{
  • "data": [
    ],
  • "featured": true,
  • "keywordIds": [
    ],
  • "position": 0
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "createdAt": 0,
  • "creator": "string",
  • "data": [
    ],
  • "directoryId": "string",
  • "featured": true,
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "position": 0
}

Delete directory content row

This endpoint is for deleting a directory content row.

Note: rows for dynamic directory (contentRowObjectType != null) are not deletable here. Status 409 Conflict will be returned.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Get directory list settings

This endpoint returns the list settings of a specific directory.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "allowChat": true,
  • "fieldHeaderImage": "string",
  • "fieldPrimary": "string",
  • "fieldSecondary": "string",
  • "headlineItems": [
    ],
  • "layout": "ColumnSingle",
  • "order": "Alphabetical",
  • "orderWithHighlights": true,
  • "shareEntries": true,
  • "size": "S",
  • "sort": [
    ]
}

Update directory list settings

This endpoint is for updating the list settings of an existing directory.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

list settings to be updated

allowChat
boolean <optional>
fieldHeaderImage
string or null

itemId // item must be Media with subtype Image -> Image for header area of each list item

fieldPrimary
string or null

itemId // item must be PropertyCreator, TextBlock, TextDateTime, TextMail, TextNumber, TextPhone or TextPlainLine

fieldSecondary
string or null

itemId // item must be PropertyCreator, TextDateTime, TextMail, TextNumber, TextPhone, TextPlainLine or null if fieldPrimary is TextBlock

headlineItems
Array of strings <= 3 items

items must be PropertyCreator, TextDateTime, TextNumber or TextPlainLine max 3 items

layout
string
Enum: "ColumnSingle" "ColumnDouble" "Grid" "List"

ColumnSingle and ColumnDouble are deprecated and will be removed in 6.0

order
string
Enum: "Alphabetical" "Custom" "Latest" "Position" "Random" "Recent"

for "Custom" property `sort" is used

orderWithHighlights
boolean
shareEntries
boolean
size
string <optional>
Enum: "S" "M" "L"

Default: "S"

Array of objects

only one property per entry allowed; property enums: "createdAt" "id" "lastModified" "position" or "data.{{itemID}}" of subtype TextDateTime, TextNumber or TextPlainLine; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "allowChat": true,
  • "fieldHeaderImage": "string",
  • "fieldPrimary": "string",
  • "fieldSecondary": "string",
  • "headlineItems": [
    ],
  • "layout": "ColumnSingle",
  • "order": "Alphabetical",
  • "orderWithHighlights": true,
  • "shareEntries": true,
  • "size": "S",
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "allowChat": true,
  • "fieldHeaderImage": "string",
  • "fieldPrimary": "string",
  • "fieldSecondary": "string",
  • "headlineItems": [
    ],
  • "layout": "ColumnSingle",
  • "order": "Alphabetical",
  • "orderWithHighlights": true,
  • "shareEntries": true,
  • "size": "S",
  • "sort": [
    ]
}

Get directory content rows list

This endpoint is for retrieving all content rows of the requested directory in admin representation. If directory has no items defined, output for dynamic directories will be empty. If a limit is set, a cursor for this endpoint may be created to iterate over all content rows.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add directory content rows

This endpoint is for adding new content rows to the requested static directory. For dynamic directories no content can be added in this way. In case of response status is 205 the request was only executed partial. Use GET to receive the stored configuration.

Note: rows for dynamic directory (contentRowObjectType != null) are not creatable here. Status 409 Conflict will be returned.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

directory content rows to create; max 100 elements are permitted per request

Array
object (model.Access)
Array of objects (content.RowValueRequest)
featured
boolean
keywordIds
Array of strings <optional>

Default: []

position
integer

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Copy directory

This endpoint is for coping a directory. In case of response status is 205 the request was performed correctly, but the server was not able to send the response data. Use GET to receive the stored configuration.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

directory to be copied

contentRowIds
Array of strings or null <optional>

content row ids to be copied with directory; null for copy all content; [] for no copy content

title
string

Responses

Request samples

Content type
application/json
{
  • "contentRowIds": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "access": {
    },
  • "accessEditAllowed": true,
  • "contentRowFilter": {
    },
  • "contentRowObjectType": "Account",
  • "contentRowsCount": 0,
  • "createAccesses": {
    },
  • "description": "string",
  • "detail": {
    },
  • "id": "string",
  • "isSystem": true,
  • "items": [
    ],
  • "listSettings": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "type": "Account",
  • "typeReferenceId": "string"
}

Get directory detail view

This endpoint is for retrieving the detail config, items and selections of a directory

DateTime formats:

  • "DateOnly": "2006-01-02"
  • "DateTime": "2006-01-02 15:04:05"
  • "RFC822X": "02 Jan 06 15:04"
  • "RFC1123X": "Mon, 02 Jan 2006 15:04"
  • "RFC1123DateOnly": "Mon, 02 Jan 2006"
  • "TimeOnlyX": "15:04"

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "detail": {
    },
  • "items": [
    ],
  • "selections": [
    ]
}

Update directory detail view

This endpoint is for updating the detail of an existing directory. New Items need a client generated unique id for setting reference in detail. client generated id will be changed from server so item ids in response will differ!

DateTime formats:

  • "DateOnly": "2006-01-02"
  • "DateTime": "2006-01-02 15:04:05"
  • "RFC822X": "02 Jan 06 15:04"
  • "RFC1123X": "Mon, 02 Jan 2006 15:04"
  • "RFC1123DateOnly": "Mon, 02 Jan 2006"
  • "TimeOnlyX": "15:04"

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

detail to be updated

object (directory.RequestDetailPart)
Array of objects (directory.RequestItem)
Array of objects (directory.RequestDirectorySelection)

Responses

Request samples

Content type
application/json
{
  • "detail": {
    },
  • "items": [
    ],
  • "selections": [
    ]
}

Response samples

Content type
application/json
{
  • "detail": {
    },
  • "items": [
    ],
  • "selections": [
    ]
}

Directory (Default)

Get directory content row

This endpoint is for retrieving a content row of a directory. If the requested language is not available it will fall back to the default language.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "creator": "string",
  • "data": [
    ],
  • "directoryId": "string",
  • "featured": true,
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "position": 0
}

Update directory content row

This endpoint is for updating a directory content row by row ID. If the requested language is not available it will fall back to the default language.

Note: rows for dynamic directory (contentRowObjectType != null) are not changeable here. Status 409 Conflict will be returned.

Note: data.translations may not hold data. Translation takes places async. Call GET /directory/default/row/{id} to check for translation again later.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Request Body schema: application/json

directory content row to be replaced

Array of objects (content.RowValueRequest)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "creator": "string",
  • "data": [
    ],
  • "directoryId": "string",
  • "featured": true,
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "position": 0
}

Delete directory content row

This endpoint is for deleting a directory content row.

Note: rows for dynamic directory (contentRowObjectType != null) are not deletable here. Status 409 Conflict will be returned.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Row ID

header Parameters
Session
string

JWT

Responses

Response samples

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

Get directory content rows list

This endpoint is for retrieving all content rows of the requested directory in default representation. If directory has no items defined, output for dynamic directories will be empty. If the requested language is not available it will fall back to the default language. If a limit is set, a cursor for this endpoint may be created to iterate over all content rows.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add directory content row

This endpoint is for adding new a new content row to the requested static directory. For dynamic directories no content can be added in this way.

Note: rows for dynamic directory (contentRowObjectType != null) are not creatable here. Status 409 Conflict will be returned.

Note: data.translations will be always empty. Translation takes places async. Call GET /directory/default/row/{rowId} to check for translation later.

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

directory content row to create

Array of objects (content.RowValueRequest)

Responses

Request samples

Content type
application/json
{
  • "data": [
    ]
}

Response samples

Content type
application/json
{
  • "createdAt": 0,
  • "creator": "string",
  • "data": [
    ],
  • "directoryId": "string",
  • "featured": true,
  • "id": "string",
  • "keywordIds": [
    ],
  • "lastModified": 0,
  • "position": 0
}

Get directory

This endpoint returns a localized directory in default user representation by given id. If the requested language is not available it will fall back to the default language.

DateTime formats:

  • "DateOnly": "2006-01-02"
  • "DateTime": "2006-01-02 15:04:05"
  • "RFC822X": "02 Jan 06 15:04"
  • "RFC1123X": "Mon, 02 Jan 2006 15:04"
  • "RFC1123DateOnly": "Mon, 02 Jan 2006"
  • "TimeOnlyX": "15:04"

Note: when the property sort does not have any elements than order will not be "Custom"

accessible without permission

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Directory ID

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "createRows": true,
  • "detail": {
    },
  • "id": "string",
  • "items": [
    ],
  • "listSettings": {
    },
  • "projectId": "string",
  • "selections": [
    ],
  • "title": "string",
  • "translations": [
    ],
  • "type": "Account"
}

Email (Admin)

Test email content

This endpoint is for testing email data.

Note: email will send without attachments if attachments exceed limit of 16MiB (16.7MB)

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Request Body schema: application/json

email data to be tested

attachments
Array of strings

media ids; currently not translatable

emailBody
string
emailReplyTo
string or null

currently not translatable

emailSenderName
string <= 100 characters

max 100 characters; currently not translatable

language
string <optional>

if no language is selected the email will be sent for the default language of the system

previewLine
string <= 90 characters

max 90 characters

projectId
string or null
object (model.NotificationRecipients)
subject
string <= 255 characters

max 255 characters

Responses

Request samples

Content type
application/json
{
  • "attachments": [
    ],
  • "emailBody": "string",
  • "emailReplyTo": "string",
  • "emailSenderName": "string",
  • "language": "string",
  • "previewLine": "string",
  • "projectId": "string",
  • "recipients": {
    },
  • "subject": "string"
}

Response samples

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

Get email

This endpoint returns email in admin representation.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Email ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "createdAt": 0,
  • "creator": "string",
  • "emailBody": "string",
  • "emailEditorConfig": "string",
  • "emailReplyTo": "string",
  • "emailSenderAddress": "string",
  • "emailSenderName": "string",
  • "id": "string",
  • "isPublished": true,
  • "previewLine": "string",
  • "projectId": "string",
  • "publishedAt": 0,
  • "recipientGroups": [
    ],
  • "subject": "string",
  • "timeZone": "Europe/Berlin",
  • "type": "Email"
}

Delete email

This endpoint is for deleting an email with all localizations.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Email ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update email

This endpoint is for updating email.

If the email is already published, it cannot be updated.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Email ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

email information to be updated

attachments
Array of strings

media ids; currently not translatable

emailBody
string
emailEditorConfig
string
emailReplyTo
string or null

currently not translatable

emailSenderName
string <= 100 characters

max 100 characters; currently not translatable

previewLine
string <= 90 characters

max 90 characters

publishedAt
integer or null

0 = now

recipientGroups
Array of strings or null

null = sent to everyone; group ids must belong to provided project id

subject
string <= 255 characters

max 255 characters

timeZone
string

IANA Time Zone

Responses

Request samples

Content type
application/json
{
  • "attachments": [
    ],
  • "emailBody": "string",
  • "emailEditorConfig": "string",
  • "emailReplyTo": "string",
  • "emailSenderName": "string",
  • "previewLine": "string",
  • "publishedAt": 0,
  • "recipientGroups": [
    ],
  • "subject": "string",
  • "timeZone": "string"
}

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "createdAt": 0,
  • "creator": "string",
  • "emailBody": "string",
  • "emailEditorConfig": "string",
  • "emailReplyTo": "string",
  • "emailSenderAddress": "string",
  • "emailSenderName": "string",
  • "id": "string",
  • "isPublished": true,
  • "previewLine": "string",
  • "projectId": "string",
  • "publishedAt": 0,
  • "recipientGroups": [
    ],
  • "subject": "string",
  • "timeZone": "Europe/Berlin",
  • "type": "Email"
}

Create email

This endpoint is for creating a new email.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

email to create

attachments
Array of strings

media ids; currently not translatable

emailBody
string
emailEditorConfig
string
emailReplyTo
string or null

currently not translatable

emailSenderName
string <= 100 characters

max 100 characters; currently not translatable

previewLine
string <= 90 characters

max 90 characters

projectId
string or null
publishedAt
integer or null

0 = now

recipientGroups
Array of strings or null

null = sent to everyone; group ids must belong to provided project id

subject
string <= 255 characters

max 255 characters

timeZone
string

IANA Time Zone

Responses

Request samples

Content type
application/json
{
  • "attachments": [
    ],
  • "emailBody": "string",
  • "emailEditorConfig": "string",
  • "emailReplyTo": "string",
  • "emailSenderName": "string",
  • "previewLine": "string",
  • "projectId": "string",
  • "publishedAt": 0,
  • "recipientGroups": [
    ],
  • "subject": "string",
  • "timeZone": "string"
}

Response samples

Content type
application/json
{
  • "attachments": [
    ],
  • "createdAt": 0,
  • "creator": "string",
  • "emailBody": "string",
  • "emailEditorConfig": "string",
  • "emailReplyTo": "string",
  • "emailSenderAddress": "string",
  • "emailSenderName": "string",
  • "id": "string",
  • "isPublished": true,
  • "previewLine": "string",
  • "projectId": "string",
  • "publishedAt": 0,
  • "recipientGroups": [
    ],
  • "subject": "string",
  • "timeZone": "Europe/Berlin",
  • "type": "Email"
}

Get all project emails

This endpoint returns all emails in admin representation for a project. If a limit is set, a cursor for this endpoint may be created to iterate over all emails.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Group

Get group list

This endpoint returns a list of all existing groups. If a limit is set, a cursor for this endpoint may be created to iterate over all groups.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create group

This endpoint is for creating a new group.

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

group data to create

accounts
Array of strings
parentId
string or null
position
integer >= 0
projectId
string
title
string

must match regex /^([^,\s]|[^,\s][^,]*[^,\s])$/

Responses

Request samples

Content type
application/json
{
  • "accounts": [
    ],
  • "parentId": "string",
  • "position": 0,
  • "projectId": "string",
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "id": "string",
  • "isSystem": true,
  • "parentId": "string",
  • "position": 0,
  • "projectId": "string",
  • "title": "string",
  • "type": "Custom"
}

Get group list for project

This endpoint returns a list of all groups for the requested project. If a limit is set, a cursor for this endpoint may be created to iterate over all groups.

only accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects"

fully accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects"

path Parameters
id
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get group

This endpoint returns group by given id with all additional information.

only accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects"

fully accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects"

path Parameters
id
required
string

Group ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "id": "string",
  • "isSystem": true,
  • "parentId": "string",
  • "position": 0,
  • "projectId": "string",
  • "title": "string",
  • "type": "Custom"
}

Delete group

This endpoint is for deleting a specific group. If a group has children, the child will remain at the place the deleted parent group was before.

Note: if isSystem = true the group is immutable, api call will result in a http 409

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Group ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update group

This endpoint is for updating a group.

Note: if isSystem = true the group is immutable, api call will result in a http 409

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Group ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

group data to update

parentId
string or null
position
integer >= 0
title
string

must match regex /^([^,\s]|[^,\s][^,]*[^,\s])$/

Responses

Request samples

Content type
application/json
{
  • "parentId": "string",
  • "position": 0,
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "accounts": [
    ],
  • "id": "string",
  • "isSystem": true,
  • "parentId": "string",
  • "position": 0,
  • "projectId": "string",
  • "title": "string",
  • "type": "Custom"
}

Get accounts of group

This endpoint returns all account ids for a specific group.

only accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects"

fully accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects"

path Parameters
id
required
string

Group ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • "string"
]

add accounts to group

This endpoint adds accounts to a specific group.

Note: if isSystem = true the group is immutable, api call will result in a http 409

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Group ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

account ids

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • "string"
]

remove accounts from group

This endpoint removes accounts from a specific group.

Note: if isSystem = true the group is immutable, api call will result in a http 409

only accessible with permission : "ManageAccounts"

fully accessible with permission : "ManageAccounts"

path Parameters
id
required
string

Group ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

account ids

Array
string

Responses

Request samples

Content type
application/json
[
  • "string"
]

Response samples

Content type
application/json
[
  • "string"
]

I18n (Admin)

Get glossary

This endpoint returns all glossary entries.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create glossary entry

This endpoint creates a single glossary entry.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

Entry to be created

object

key: language, value: translation -> not all languages have to be provided, min 2 entries

Responses

Request samples

Content type
application/json
{
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "translations": {
    }
}

Get glossary entry

This endpoint returns a single glossary entry for provided id.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "id": "string",
  • "translations": {
    }
}

Update glossary entry

This endpoint updates a single glossary entry.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

Entry to be updated

object

key: language, value: translation -> not all languages have to be provided, min 2 entries

Responses

Request samples

Content type
application/json
{
  • "translations": {
    }
}

Response samples

Content type
application/json
{
  • "id": "string",
  • "translations": {
    }
}

Delete glossary entry

This endpoint deletes a single glossary entry for provided id.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Entry ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Create cursor

This endpoint returns a cursor for list localizations in admin representation with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

options to create cursor

object (localization.CursorFilterOptionAdmin)
Array of objects

only one property per entry allowed; property enums: "key" "langCode" "lastModified"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Get localization keys

This endpoint returns a list of localization keys.

Cursor could be created here: POST /config/admin/localization/search

accessible without permission

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

page
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • "string"
]

Update default language

This endpoint updates the default language in the system. The default language will be published automatically. If auto translation is disabled, the current default language will be set to Draft.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

configuration for default language

id
string

the ID is the language code in format: IETF BCP 47

Responses

Request samples

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

Response samples

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

Get language

This endpoint returns a language in administrative representation by given id.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Language code in format: IETF BCP 47

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "autoTranslated": true,
  • "id": "string",
  • "isDefault": true,
  • "lastModified": 0,
  • "status": "Draft",
  • "variantCurrent": "string",
  • "variants": [
    ]
}

Update language

This endpoint updates a language in the system by given id. The default language must be published. Status of languages could only be changed if auto translation is activated. To switch the default language, use the following endpoint: PUT /config/admin/language/default

Note: Auto translations is a premium feature and requires a valid subscription.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Language code in format: IETF BCP 47

header Parameters
Session
required
string

JWT

Request Body schema: application/json

language data to be updated

status
string
Enum: "Draft" "Published"
variantCurrent
string

entry of variants list from the language

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "autoTranslated": true,
  • "id": "string",
  • "isDefault": true,
  • "lastModified": 0,
  • "status": "Draft",
  • "variantCurrent": "string",
  • "variants": [
    ]
}

Get localizations for cursor

This endpoint returns a list of all localizations for a cursor in administrative representation.

Cursor could be created here: POST /config/admin/localization/search

accessible without permission

query Parameters
cursor
required
string

id of the cursor used for pagination; required if page is set

page
required
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get localizations of language

This endpoint returns a localizations in administrative representation by given language.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Language code in format: IETF BCP 47

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get localization

This endpoint returns a localization in administrative representation by given id.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Localization ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "autoTranslated": true,
  • "description": "string",
  • "id": "string",
  • "isCustomized": true,
  • "isDeprecated": true,
  • "key": "string",
  • "langCode": "string",
  • "langVariant": "string",
  • "lastModified": 0,
  • "placeholders": [
    ],
  • "value": "string"
}

Update localization

This endpoint updates a localization in the system by given id.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Localization ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

localization data to be updated

value
string

Responses

Request samples

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

Response samples

Content type
application/json
{
  • "autoTranslated": true,
  • "description": "string",
  • "id": "string",
  • "isCustomized": true,
  • "isDeprecated": true,
  • "key": "string",
  • "langCode": "string",
  • "langVariant": "string",
  • "lastModified": 0,
  • "placeholders": [
    ],
  • "value": "string"
}

Reset localization

This endpoint updates a localization in the system to the default value if the localization is customized and not deprecated. It will send status 409 if localization is deprecated.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Localization ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "autoTranslated": true,
  • "description": "string",
  • "id": "string",
  • "isCustomized": true,
  • "isDeprecated": true,
  • "key": "string",
  • "langCode": "string",
  • "langVariant": "string",
  • "lastModified": 0,
  • "placeholders": [
    ],
  • "value": "string"
}

Get languages

This endpoint returns all available languages in administrative representation.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Reset localizations

This endpoint updates all localizations in the system for the provided language to the default value if the localization is customized and not deprecated.

only accessible with permission : "ManageConfiguration"

fully accessible with permission : "ManageConfiguration"

path Parameters
id
required
string

Language code in format: IETF BCP 47

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

I18n (Default)

Get languages

This endpoint returns all published languages in default representation.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Session
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get localizations

This endpoint returns all localizations either in provided or default language in default representation.

accessible without permission

fully accessible with permission : "ManageConfiguration"

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
{
  • "property1": "string",
  • "property2": "string"
}

Index (Admin)

Get index

This endpoint is for requesting a specific index items.

accessible without permission

fully accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects" (depending on requested object type)

path Parameters
objectType
required
string
Enum: "Account" "Calendar" "CalendarEntry" "ChatFeed" "Directory" "DirectoryContentRow" "Group" "Keyword" "Location" "LocationMap" "MediaAudio" "MediaDocument" "MediaFolder" "MediaIcon" "MediaImage" "MediaOther" "MediaVideo" "News" "Page" "Project" "Stream"

object type

objectId
required
string

object ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "deeplinkUrl": "string",
  • "lastModified": 0,
  • "meta": {
    },
  • "objectId": "string",
  • "objectType": "Account",
  • "projectId": "string",
  • "projectTitle": "string",
  • "referenceId": "string",
  • "referenceTitle": "string",
  • "title": "string"
}

Get index items for cursor

This endpoint returns a list of all index items for a cursor in administrative representation.

Cursor could be created here: POST /index/admin/search

accessible without permission

query Parameters
cursor
required
string

id of the cursor used for pagination; required if page is set

page
required
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get linked items

This endpoint is for requesting all linked items for a specific object. If a limit is set, a cursor for this endpoint may be created to iterate over all linked items.

accessible without permission

fully accessible with permission : "ManageContent" "ManageGlobalMedia" "ManageProjects"

path Parameters
objectType
required
string
Enum: "Account" "Calendar" "CalendarEntry" "ChatFeed" "Directory" "DirectoryContentRow" "Group" "Keyword" "Location" "LocationMap" "MediaAudio" "MediaDocument" "MediaFolder" "MediaIcon" "MediaImage" "MediaOther" "MediaVideo" "News" "Page" "Project" "Stream"

object type

objectId
required
string

object ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cursor

This endpoint returns a cursor for list index items in admin representation with applied filter and sort options. private items will not be part of the result. In case of cursor response total will be 0 the status 204 with not content is returned instead.

accessible without permission

fully accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects" (depending on requested object type)

header Parameters
Session
required
string

JWT

Request Body schema: application/json

search criteria to create cursor

object (model.Search)
Array of objects

only one property per entry allowed; property enums: "lastModified" "objectId" "objectType" "projectId" "referenceId" "title"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Index (Default)

Get linked items

This endpoint is for requesting all linked items for a specific object. If a limit is set, a cursor for this endpoint may be created to iterate over all linked items.

accessible without permission

fully accessible with permission : "ManageContent" "ManageGlobalMedia" "ManageProjects" (depending on requested object type)

path Parameters
objectType
required
string
Enum: "Account" "Calendar" "CalendarEntry" "ChatFeed" "Directory" "DirectoryContentRow" "Group" "Keyword" "Location" "LocationMap" "MediaAudio" "MediaDocument" "MediaFolder" "MediaIcon" "MediaImage" "MediaOther" "MediaVideo" "News" "Page" "Project" "Stream"

object type

objectId
required
string

object ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get index items for cursor

This endpoint returns a list of all index items for a cursor in default representation.

Cursor could be created here: POST /index/default/search

accessible without permission

query Parameters
cursor
required
string

id of the cursor used for pagination; required if page is set

page
required
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cursor

This endpoint returns a cursor for list index items in default representation with applied filter and sort options. private items will not be part of the result. In case of cursor response total will be 0 the status 204 with not content is returned instead.

accessible without permission

fully accessible with permission : "ManageAccounts" "ManageContent" "ManageGlobalMedia" "ManageProjects" (depending on requested object type)

header Parameters
Accept-Language
string

client language(s)

Session
string

JWT

Request Body schema: application/json

search criteria

object (model.Search)
Array of objects

only one property per entry allowed; property enums: "lastModified" "objectId" "objectType" "projectId" "referenceId" "title"; value enums: "ASC" "DESC"

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Journey (Admin)

Get journey list for project

This endpoint returns a list of all journeys for the requested project without items in administrative representation. If a limit is set, a cursor for this endpoint may be created to iterate over all journeys.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
projectId
required
string

Project ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get all journey processes of account

This endpoint returns all journey processes for 1 account in admin representation.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
accountId
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create journey

This endpoint is for creating a new journey.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

header Parameters
Session
required
string

JWT

Request Body schema: application/json

Journey to create

image
string or null

media id

notificationEnabled
boolean
projectId
string
Array of objects (journey.RequestStage)
title
string

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "notificationEnabled": true,
  • "projectId": "string",
  • "stages": [
    ],
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "assignedCount": 0,
  • "completedCount": 0,
  • "creator": "string",
  • "id": "string",
  • "image": "string",
  • "inProgressCount": 0,
  • "lastModified": 0,
  • "notificationEnabled": true,
  • "projectId": "string",
  • "stages": [
    ],
  • "stagesCount": 0,
  • "title": "string"
}

Get stages

This endpoint returns the stages for a journey object in administrative representation by given id.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Update stages

This endpoint updates the stages for a journey object in administrative representation by given id.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

journey stages to be updated

Array
object or null
description
string

html formatted string, following tags are allowed to use: "em" "i" "strong" "b" "u" "ul" "li" "ol" "a" "p"

id
string
Array of objects (model.JourneyStageStartCondition) [ items ]

outer array OR, inner arrays AND: [[{} && {}] || [{}]]

title
string
url
string or null

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Get attendees

This endpoint is for retrieving attendees from journey processes.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

limit
integer

amount of results per page (1 ... 100)

page
integer

current page index of the cursor used for pagination; required if cursor is set

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Add attendees

This endpoint is for creating new journey processes by adding attendees.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

Attendees to create

Array
accountId
string
startDate
string

Responses

Request samples

Content type
application/json
[
  • {
    }
]

Response samples

Content type
application/json
[
  • {
    }
]

Remove attendees

This endpoint is for removing journey processes.

Note: when no query parameter is set, all attendees will be removed.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

query Parameters
ids
string

account ids to be removed from journey

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update attendees

This endpoint is for updating journey processes. Note: when no query parameter is set, all attendees will be updated.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

query Parameters
ids
string

account ids to be updated

header Parameters
Session
required
string

JWT

Request Body schema: application/json

values to patch attendees for

startDate
string

Responses

Request samples

Content type
application/json
{
  • "startDate": "2006-01-02"
}

Response samples

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

Get journey process

This endpoint returns one specific journey processes in admin representation.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Process ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "accountId": "string",
  • "completedAt": 0,
  • "createdAt": 0,
  • "creator": "string",
  • "id": "string",
  • "journeyId": "string",
  • "processId": "string",
  • "stageStatus": {
    },
  • "stagesCompleted": [
    ],
  • "stagesCount": 0,
  • "stagesRunning": [
    ],
  • "stagesUpcoming": [
    ],
  • "startDate": "2006-01-02",
  • "status": "Completed"
}

Get journey processes of account

This endpoint returns all journey processes of a specific account for a specific journey in admin representation.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

accountId
required
string

Account ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get journey processes of journey

This endpoint returns all account processes for 1 journey in admin representation.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Get journey

This endpoint returns a journey in administrative representation by given id.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

header Parameters
Session
required
string

JWT

Responses

Response samples

Content type
application/json
{
  • "assignedCount": 0,
  • "completedCount": 0,
  • "creator": "string",
  • "id": "string",
  • "image": "string",
  • "inProgressCount": 0,
  • "lastModified": 0,
  • "notificationEnabled": true,
  • "projectId": "string",
  • "stages": [
    ],
  • "stagesCount": 0,
  • "title": "string"
}

Delete journey

This endpoint is for deleting a single journey with all localizations.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

header Parameters
Session
required
string

JWT

Responses

Response samples

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

Update journey

This endpoint is for updating specific data of an existing journey.

Note: Journeys is a premium feature and requires a valid subscription.

only accessible with permission : "ManageContent" "ManageProjects"

fully accessible with permission : "ManageContent" "ManageProjects"

path Parameters
id
required
string

Journey ID

header Parameters
Session
required
string

JWT

Request Body schema: application/json

journey data to be updated

image
string or null

media id

notificationEnabled
boolean
title
string

Responses

Request samples

Content type
application/json
{
  • "image": "string",
  • "notificationEnabled": true,
  • "title": "string"
}

Response samples

Content type
application/json
{
  • "assignedCount": 0,
  • "completedCount": 0,
  • "creator": "string",
  • "id": "string",
  • "image": "string",
  • "inProgressCount": 0,
  • "lastModified": 0,
  • "notificationEnabled": true,
  • "projectId": "string",
  • "stages": [
    ],
  • "stagesCount": 0,
  • "title": "string"
}

Journey (Default)

Get journey processes list for cursor

This endpoint returns a list of all journey processes for account without content in default representation.

Note: Journeys is a premium feature and requires a valid subscription.

Cursor could be created here: POST /reaction/default/journey/search

accessible without permission

query Parameters
cursor
string

id of the cursor used for pagination; required if page is set

page
integer

current page index of the cursor used for pagination; required if cursor is set

limit
integer

amount of results per page (1 ... 100)

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Responses

Response samples

Content type
application/json
[
  • {
    }
]

Create cursor

This endpoint returns a cursor for list own journeys in default representation with applied filter and sort options. In case of cursor response total will be 0 the status 204 with not content is returned instead.

Note: Journeys is a premium feature and requires a valid subscription.

accessible without permission

header Parameters
Session
required
string

JWT

Request Body schema: application/json

options to create cursor

object (journeyprocess.CursorFilterOptionDefault)
Array of objects

only one property per entry allowed; property enums: "completedAt" "createdAt" "id" "lastModified" "projectId" "startDate" "status"; value enums: "ASC" "DESC"`

Responses

Request samples

Content type
application/json
{
  • "filter": {
    },
  • "sort": [
    ]
}

Response samples

Content type
application/json
{
  • "cursor": "string",
  • "endpoints": [
    ],
  • "expiredAt": 0,
  • "total": 0
}

Update stage status

This endpoint is for updating the status of a stage for an own journey process. If the requested language is not available it will fall back to the default language.

Note: Journeys is a premium feature and requires a valid subscription.

accessible without permission

path Parameters
id
required
string

Journey ID

stageId
required
string

Stage ID

header Parameters
Session
required
string

JWT

Accept-Language
string

client language(s)

Request Body schema: application/json