Skip to content

API / API reference / Meetings

Change a meeting series

Lunedo 0.1.0
Other versions
0.1.0 Nov 1, 2026

Opens the documentation of that release on GitHub.

PATCH
/api/v1/meeting-series/{seriesId}
Code sample: cURL
sh
curl -X PATCH -H "Authorization: Bearer ld_..." \
-H "Content-Type: application/json" --data @request.json \
"https://wiki.example.org/api/v1/meeting-series/{seriesId}"

Changes name, members, template or schedule. A new schedule moves the upcoming meeting to the new rhythm and drops earlier moves and exceptions. New members join the upcoming meeting.

Requires the permission item.edit on the item in seriesId.

seriesId
required
string format: uuid

ID of the meeting series.

Media typeapplication/json

Changes to a meeting series. Fields that are left out stay unchanged.

object
name

New name.

string
<= 400 characters
members

All members, in order.

Array<string>
<= 100 items
templateId

Template for new meetings.

string
<= 64 characters
reminder

When attendees are reminded to add their topics: off, or one day, two days or one week before each meeting.

string
Allowed values: off oneDay twoDays oneWeek
schedule

New schedule. The upcoming meeting moves to the new rhythm.

object
rhythm
required

The rhythm of a series, as the interface offers it.

object
frequency
required

none for no fixed rhythm, otherwise how often the meetings repeat.

string
Allowed values: none daily weekly monthly yearly
interval

Every how many days, weeks, months or years. 2 weekly is every two weeks, 3 monthly is quarterly.

integer
default: 1 >= 1 <= 52
weekdays

For weekly: the weekdays of the meetings, at least one.

Array<string>
<= 7 items
Allowed values: MO TU WE TH FR SA SU
monthDay

For monthly by date: the day of the month.

integer
>= 1 <= 31
weekOfMonth

For monthly by weekday: 1 to 4 for the first to fourth, -1 for the last.

integer
>= -1 <= 4
weekday

For monthly by weekday: the weekday, for example TU.

string
Allowed values: MO TU WE TH FR SA SU
startsOn
required

Date of the first meeting in the series’ time zone, YYYY-MM-DD.

string
/^\d{4}-\d{2}-\d{2}$/
startTime
required

Local start time of the meetings, HH:MM in 24 hours.

string
/^([01]\d|2[0-3]):[0-5]\d$/
timeZone
required

IANA time zone of the series, such as Europe/Vienna. Meetings keep their local time across daylight saving changes.

string
>= 1 characters <= 64 characters
durationMinutes
required

Duration of each meeting in minutes.

integer
>= 5 <= 1440

Example

{
"members": [
"01929b1e-7c3a-7d2e-9f4b-3c2d1e0f5a20"
]
}

The series.

Media typeapplication/json

A meeting series.

object
id
required

ID of the series.

string format: uuid
number
required

Number of the series in the addresses of the app.

integer
>= 1 <= 9007199254740991
spaceId
required

Space of the series.

string format: uuid
title
required

Name of the series.

string
parentId
required
Any of:
string format: uuid
archived
required

True when the series has ended: read-only, without a next meeting.

boolean
oneOnOne
required

True for the series of a one-on-one.

boolean
members
required

Members in their order.

Array<object>

A member of the series.

object
id
required

Account ID.

string format: uuid
name
required

Name, or null when the caller may not see the person.

string | null
pictureRef
required

Version of the profile picture, or null without one. Changes whenever the picture changes; load the picture from GET /api/v1/accounts/{accountId}/picture.

string | null
active
required

Whether the person can still take part: false when the account is deactivated, not set up yet or no longer a member of the organization. Always true for people the caller may not see.

boolean
canRead
required

Whether the person can read the series. Active members without access are shown with a warning.

boolean
schedule
required

The schedule.

object
rhythm
required
Any of:

The rhythm of the series.

object
frequency
required

How often the meetings repeat. New values can be added in later versions; handle unknown values.

string
interval
required

Every how many units.

integer
>= -9007199254740991 <= 9007199254740991
weekdays

Weekdays for weekly rhythms.

Array<string>
monthDay

Day of the month for monthly rhythms by date.

integer
>= -9007199254740991 <= 9007199254740991
weekOfMonth

1 to 4 or -1 for monthly rhythms by weekday.

integer
>= -9007199254740991 <= 9007199254740991
weekday

Weekday for monthly rhythms by weekday.

string
recurrence
required

The iCalendar recurrence rule (RFC 5545) without RRULE:, or null without a fixed rhythm.

string | null
startsOn
required

Date of the first meeting.

string
startTime
required

Local start time.

string
timeZone
required

Time zone of the series.

string
durationMinutes
required

Duration in minutes.

integer
>= -9007199254740991 <= 9007199254740991
template
required

Template of the meeting pages.

object
id
required

Template ID.

string
name
required

Name of the template, or null when it was deleted.

string | null
reminder
required

When attendees are reminded to add their topics: off, or one day, two days or one week before each meeting. New values can be added in later versions; handle unknown values.

string
source
required

Where the schedule comes from: set here or from a calendar. New values can be added in later versions; handle unknown values.

string
calendarUid
required

Calendar UID when the schedule comes from a calendar.

string | null
upcoming
required
Any of:

A meeting of a series.

object
id
required

ID of the meeting page.

string format: uuid
number
required

Number of the meeting page in the addresses of the app.

integer
>= 1 <= 9007199254740991
title
required

Title of the meeting page.

string
state
required

upcoming is the next meeting, closed and skipped are done, reopened was closed and is open again. New values can be added in later versions; handle unknown values.

string
startsAt
required
Any of:
string format: date-time
recurrenceId
required
Any of:
string format: date-time
durationMinutes
required

Duration in minutes.

integer
>= -9007199254740991 <= 9007199254740991
attendees
required

Number of attendees.

integer
>= -9007199254740991 <= 9007199254740991
present
required

Number of attendees marked present.

integer
>= -9007199254740991 <= 9007199254740991
extra
required

True for an additional meeting outside the rhythm.

boolean
next
required

True for the next meeting of the series: the earliest one that is neither held nor skipped.

boolean
openTopics
required

Open running topics the caller can see.

integer
>= -9007199254740991 <= 9007199254740991
overview
required

The overview of the series, the same for all members.

object
columns
required

Modules of the left and the right column, from top to bottom.

Array<Array<string>>
>= 2 items <= 2 items
hidden
required

Modules that are not shown.

Array<string>
links
required

Pinned items for the Links module that the caller can open, in their order.

Array<object>

A pinned item.

object
id
required

ID of the item.

string format: uuid
number
required

Number of the item in the addresses of the app.

integer
>= 1 <= 9007199254740991
title
required

Title of the item.

string
kind
required

Kind of the item, such as page or folder.

string
spaceKey
required

Key of its space.

string
createdAt
required

When the series was created. ISO 8601 timestamp in UTC.

string format: date-time

Example

{
"id": "01929b1e-7c3a-7d2e-9f4b-3c2d1e0f6a00",
"number": 1050,
"spaceId": "01929b1e-7c3a-7d2e-9f4b-3c2d1e0f5a00",
"title": "Jour fixe IT",
"parentId": null,
"archived": false,
"oneOnOne": false,
"members": [
{
"id": "01929b1e-7c3a-7d2e-9f4b-3c2d1e0f5a20",
"name": "Anna Berger",
"pictureRef": null,
"active": true,
"canRead": true
}
],
"schedule": {
"rhythm": {
"frequency": "weekly",
"interval": 1,
"weekdays": [
"MO"
]
},
"recurrence": "FREQ=WEEKLY;BYDAY=MO",
"startsOn": "2026-10-12",
"startTime": "09:30",
"timeZone": "Europe/Vienna",
"durationMinutes": 45
},
"template": {
"id": "builtin:team-meeting",
"name": "Team meeting"
},
"reminder": "oneDay",
"source": "manual",
"calendarUid": null,
"upcoming": {
"id": "01929b1e-7c3a-7d2e-9f4b-3c2d1e0f6a10",
"number": 1051,
"title": "Jour fixe IT · 12 Oct 2026",
"state": "upcoming",
"startsAt": "2026-10-12T07:30:00.000Z",
"recurrenceId": "2026-10-12T07:30:00.000Z",
"durationMinutes": 45,
"attendees": 5,
"present": 0,
"extra": false,
"next": true
},
"openTopics": 3,
"overview": {
"columns": [
[
"topics",
"tasks"
],
[
"meetings",
"decisions"
]
],
"hidden": [
"attendance",
"links"
],
"links": []
},
"createdAt": "2026-10-05T08:00:00.000Z"
}

ambiguousCredentials: The request carries both a session and an API token. invalidInput: The request is not valid. invalidMember: The person cannot take part. invalidRhythm: The rhythm is not valid. invalidSchedule: The schedule is not valid. invalidTimeZone: The time zone is not known. invalidTitle: The title is not valid.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

{
"type": "urn:lunedo:problem:ambiguousCredentials",
"title": "The request carries both a session and an API token",
"status": 400,
"code": "ambiguousCredentials"
}

invalidApiToken: The API token is not valid. notSignedIn: Sign in or send an API token.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

{
"type": "urn:lunedo:problem:invalidApiToken",
"title": "The API token is not valid",
"status": 401,
"code": "invalidApiToken"
}

csrfRejected: The request failed the cross-site request check. forbidden: Not allowed.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

{
"type": "urn:lunedo:problem:csrfRejected",
"title": "The request failed the cross-site request check",
"status": 403,
"code": "csrfRejected"
}

notFound: Not found.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

ExamplenotFound
{
"type": "urn:lunedo:problem:notFound",
"title": "Not found",
"status": 404,
"code": "notFound"
}

seriesEnded: The meeting series has ended.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

ExampleseriesEnded
{
"type": "urn:lunedo:problem:seriesEnded",
"title": "The meeting series has ended",
"status": 409,
"code": "seriesEnded"
}

rateLimited: Too many requests.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

ExamplerateLimited
{
"type": "urn:lunedo:problem:rateLimited",
"title": "Too many requests",
"status": 429,
"code": "rateLimited"
}

maintenanceMode: The instance is in maintenance mode.

Media typeapplication/problem+json

Error response following RFC 9457 Problem Details.

object
type
required

Stable identifier of the error kind. Clients branch on this value.

string
title
required

Short summary of the error kind. It does not change between occurrences.

string
status
required

HTTP status code of the response.

integer
>= -9007199254740991 <= 9007199254740991
detail

Explanation of this occurrence, for people.

string
code
required

The last part of type, for clients that prefer a short key.

string
fields

Invalid fields, for invalidInput, invalidStorageSettings, invalidBackupSettings and the codes about the address of a chat channel.

Array<string>
denials

Why the request was not allowed, for forbidden.

Array<string>
retryAfterSeconds

Seconds to wait before retrying, for rateLimited, locked and busy.

integer
>= -9007199254740991 <= 9007199254740991
problem

Which password rule failed, for passwordPolicy; why the address of a chat channel was refused, for invalidChatAddress; which storage setting was refused (invalidThresholds, invalidS3Limit, invalidContacts or invalidTeamsWebhook), for invalidStorageSettings; which backup setting was refused, for invalidBackupSettings; whether a backup or a testRestore is running, for backupRunning; why the backup target could not be used (a failure of Test connection, such as notFound or credentials, or missingSecret), for backupTargetFailed.

string
step

What Lunedo was doing with the backup target when it failed, for backupTargetFailed.

string
Allowed values: write read delete list
refusal

What the full storage refuses, for storageFull: an upload, or a large write such as an import.

string
Allowed values: upload largeWrite
minLength

Minimum password length, for passwordPolicy.

integer
>= -9007199254740991 <= 9007199254740991
lockedBy

Level that locked the setting, for settingLocked.

string
minimum

Lowest allowed value, for settingBelowMinimum.

number
maximum
Any of:
number
maxLifetimeDays

Maximum lifetime of API tokens in days, for expiryRequired and expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
domains

Domains that belong to another identity provider, for domainInUse.

Array<string>
instanceUrl

The current address of the instance, for instanceMoved.

string
providerId

ID of the identity provider that manages the account, for managedAccount and managedDomain.

string
providerName

Name of the identity provider that manages the account, for managedAccount and managedDomain.

string
accounts

Number of accounts still linked to the identity provider, for providerHasAccounts.

integer
>= -9007199254740991 <= 9007199254740991
maxBytes

Largest allowed file size in bytes, for fileTooLarge and uploadTooLarge; storage limit of the organization’s imports, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
usedBytes

Bytes the organization’s imports use already, for organizationImportLimit.

integer
>= -9007199254740991 <= 9007199254740991
missing

Number of parts still missing, for uploadIncomplete.

integer
>= -9007199254740991 <= 9007199254740991
uncoveredPages

Number of pages below that your own role does not cover, for shareBeyondOwnAccess.

integer
>= -9007199254740991 <= 9007199254740991
maxDays

Longest allowed lifetime of a link for anyone in days, for expiryTooLate.

integer
>= -9007199254740991 <= 9007199254740991
pages

Number of pages that give access to groups or through broad links, for confidentialSharing; number of pages that would lose the status, for statusInUse; number of pages the caller cannot open, for hiddenContent.

integer
>= -9007199254740991 <= 9007199254740991
sections

Required sections that are empty or missing, for requiredSectionsEmpty.

Array<object>

A required section.

object
key
required

Key of the section.

string
title
required

Heading of the section.

string
articles

Number of articles more people could read, for audienceWidening and categoryVisibilityWidening.

integer
>= -9007199254740991 <= 9007199254740991
translations

Number of translations into the language, for defaultLanguageTranslated.

integer
>= -9007199254740991 <= 9007199254740991
translationId

The existing translation, for translationExists.

string format: uuid
light

Check of the light mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
dark

Check of the dark mode color, for brandContrast.

object
color
required

The checked color.

string
passes
required

Whether it reaches the contrast WCAG AA asks for.

boolean
onBackground
required

Contrast of the color as text on the background.

number
onBrand
required

Contrast of text on the color.

number
proposal
required

The nearest shade that passes, or null when none exists.

string | null
impact

Who gains and who loses access, with the confirmation to send, for moveChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the content leaves a confidential space and loses its protection.

boolean
confirmation
required

Send this with the move to confirm exactly this change, or null when access does not change. Valid for one hour.

string | null
copyImpact

Who could read the copy but not the source, with the confirmation to send, for copyChangesAccess.

object
gaining
required

Number of people who get access.

integer
>= -9007199254740991 <= 9007199254740991
losing
required

Number of people who lose access.

integer
>= -9007199254740991 <= 9007199254740991
raised
required

Number of people whose role rises.

integer
>= -9007199254740991 <= 9007199254740991
lowered
required

Number of people whose role drops.

integer
>= -9007199254740991 <= 9007199254740991
unlisted
required

Number of affected people the caller may not see; they are counted but not listed.

integer
>= -9007199254740991 <= 9007199254740991
truncated
required

Whether changes lists only the first 100 people.

boolean
changes
required

People whose access changes, ordered by name.

Array<object>

How the access of one person changes.

object
accountId
required

ID of the account.

string format: uuid
name
required

Name of the person.

string
before
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
after
required
Any of:

Space role: reader reads, commenter also comments, editor also creates, edits and moves content, admin also manages the space and its permissions.

string
Allowed values: reader commenter editor admin
leavesConfidential
required

True when the copy leaves a confidential space and is not protected by it.

boolean
widerAccess
required

True when people can read the copy who cannot read the source; the copy then needs the confirmation.

boolean
confirmation
required

Send this with the copy to confirm exactly this access, or null when nobody gains access. Valid for one hour.

string | null
items
required

Number of items the copy creates.

integer
>= -9007199254740991 <= 9007199254740991
hidden
required

Number of items below that are left out because the caller cannot read them.

integer
>= -9007199254740991 <= 9007199254740991
skipped
required

Number of items below that are left out because they cannot be copied.

integer
>= -9007199254740991 <= 9007199254740991
background
required

True when the copy is large and runs in the background.

boolean
formerParent
Any of:
object
id
required

ID of the former parent page.

string format: uuid
title
required

Title of the former parent page.

string
parentEntries

Number of trash entries of former parent pages the caller can restore together with the content, for restrictedParentInTrash; 0 when the caller cannot restore all of them.

integer
>= -9007199254740991 <= 9007199254740991
fileVersion

Format or editor schema version of the file, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
supportedVersion

Highest format or editor schema version this Lunedo reads, for newerTemplateFormat.

integer
>= -9007199254740991 <= 9007199254740991
templateIndex

Position of the template in the file, counted from 0, for templateNameTaken.

integer
>= -9007199254740991 <= 9007199254740991
templateProblems

What is wrong with the templates of the file, for invalidTemplatesInFile.

Array<object>

A problem in a template of the file.

object
place
required

Where in the template, such as field 3 or content.

string | null
message
required

Explanation for people, naming the template and the place.

string
maintenanceMessage

The message of the instance administrators about the maintenance, for maintenanceMode and signInPaused. Empty when they wrote none.

string
problems

What is wrong with the document, for invalidDocument and invalidComment.

Array<object>

A problem in the document.

object
path
required

Position in the document, such as .content[2].content[0].

string
code
required

Kind of problem, such as unknownNode or invalidAttribute.

string
message
required

Explanation for people.

string

Examples

ExamplemaintenanceMode
{
"type": "urn:lunedo:problem:maintenanceMode",
"title": "The instance is in maintenance mode",
"status": 503,
"code": "maintenanceMode"
}