Skip to content
Developer

Feedback Boards

Media6 EndpointsMedia / Feedback Boards

Returns a list of feedback boards (three-tier visibility).

GET/api/media/feedback_board

Query parameters

publicKeystringStable key for the public URL and widget embedding. Server-assigned, never accepted from API input — omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board. | Requires access right: PUBLIC, LOGGED_IN, SCOPE
sortOrderstringRequires access right: PUBLIC, LOGGED_IN, SCOPE
idinteger
deletedbooleanThis property is used to mark an entity as deleted / archived
namestringInternal name, shown in the admin UI only.
visibilityTypestring
allowNewEntriesboolean
allowVotingboolean
allowCommentsboolean
allowGuestEntriesboolean
allowGuestVotesboolean
allowGuestCommentsboolean
createdstring
updatedstring
searchStringstringtext to search for in the list
orderFieldNamestringname of the order field
orderFieldSortstringsorting modeAllowed: DESCASC
pageintegerpage of the list
pageSizeintegernumber of entries for each page
withMaxPageNumberstringreturns the number of pages available as a header if this is set

Responses

200Returns a list of MediaFeedbackBoard objectsarray<MediaFeedbackBoard>

Show fields (21)
  • is_publicboolean

    True when the board itself may be served to callers without a session.

  • idinteger

    Primary key of the feedback board. Internal ID.

  • namestring

    Internal name, shown in the admin UI only.

  • public_titlestring

    Title of the board shown to the public.

  • public_descriptionstring

    Description of the board shown to the public.

  • public_keystring

    Stable key for the public URL and widget embedding. Server-assigned, never accepted from API input — omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board.

  • image_urlstring

    URL of the image of the board.

  • sort_orderinteger

    Sort order of the board in lists.

  • allow_new_entriesboolean

    Members can create new entries.

  • allow_votingboolean

    Members can vote on entries.

  • allow_commentsboolean

    Members can comment on entries.

  • allow_guest_entriesboolean

    Guests can create new entries.

  • allow_guest_votesboolean

    Guests can vote on entries.

  • allow_guest_commentsboolean

    Guests can comment on entries.

  • moderation_requiredboolean

    Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • ucatsarray<UnifiedCategory30>

    Unified categories of the entity.

    Show fields (32)
    • idinteger

      Primary key of the unified category. Internal ID.

    • category_typestring

      Type of the category, for example course or membership.

    • childrenarray<UnifiedCategory30>

      Child categories.

    • parentUnifiedCategory30

      Parent category.

    • view_orderinteger

      Sort order of the category in lists.

    • is_publicboolean

      The category is shown publicly.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • search_stringstring

      Text that the entity can be searched by.

    • short_identifierstring

      Short identifier of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • image_urlstring

      URL of the image of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • visibility_typestring

    Type of visibility of the entity.

  • arslistarray<AccessRightStorage12>

    Access rights list that controls the visibility.

    Show fields (12)
    • idinteger

      Primary key of the access right entry. Internal ID.

    • userUser55

      User who gets the access right. Only set for user-specific rights.

    • access_tagAccessTag

      Access tag the right applies to. Only set for rights on a tag.

    • create_mainboolean

      Create permission for main records of the access tag.

    • edit_mainboolean

      Edit permission for main records of the access tag.

    • read_mainboolean

      Read permission for main records of the access tag.

    • create_childboolean

      Create permission for child records (for example items inside a main record).

    • edit_childboolean

      Edit permission for child records (for example items inside a main record).

    • read_childboolean

      Read permission for child records (for example items inside a main record).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/feedback_board \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
[
  {
    "id": 42,
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "is_public": true,
    "public_key": "string",
    "sort_order": 1,
    "allow_new_entries": true,
    "allow_voting": true
  }
]

Creates a feedback board.

POST/api/media/feedback_board

Request body application/json

  • dataMediaFeedbackBoard2
    Show fields (14)
    • namestring

      Internal name, shown in the admin UI only.

    • public_titlestring

      Title of the board shown to the public.

    • public_descriptionstring

      Description of the board shown to the public.

    • image_urlstring

      URL of the image of the board.

    • sort_orderinteger

      Sort order of the board in lists.

    • allow_new_entriesboolean

      Members can create new entries.

    • allow_votingboolean

      Members can vote on entries.

    • allow_commentsboolean

      Members can comment on entries.

    • allow_guest_entriesboolean

      Guests can create new entries.

    • allow_guest_votesboolean

      Guests can vote on entries.

    • allow_guest_commentsboolean

      Guests can comment on entries.

    • moderation_requiredboolean

      Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • ucatsarray<UnifiedCategory11>

      Unified categories of the entity.

Responses

200Add a new MediaFeedbackBoardMediaFeedbackBoard

Show fields (21)
  • is_publicboolean

    True when the board itself may be served to callers without a session.

  • idinteger

    Primary key of the feedback board. Internal ID.

  • namestring

    Internal name, shown in the admin UI only.

  • public_titlestring

    Title of the board shown to the public.

  • public_descriptionstring

    Description of the board shown to the public.

  • public_keystring

    Stable key for the public URL and widget embedding. Server-assigned, never accepted from API input — omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board.

  • image_urlstring

    URL of the image of the board.

  • sort_orderinteger

    Sort order of the board in lists.

  • allow_new_entriesboolean

    Members can create new entries.

  • allow_votingboolean

    Members can vote on entries.

  • allow_commentsboolean

    Members can comment on entries.

  • allow_guest_entriesboolean

    Guests can create new entries.

  • allow_guest_votesboolean

    Guests can vote on entries.

  • allow_guest_commentsboolean

    Guests can comment on entries.

  • moderation_requiredboolean

    Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • ucatsarray<UnifiedCategory30>

    Unified categories of the entity.

    Show fields (32)
    • idinteger

      Primary key of the unified category. Internal ID.

    • category_typestring

      Type of the category, for example course or membership.

    • childrenarray<UnifiedCategory30>

      Child categories.

    • parentUnifiedCategory30

      Parent category.

    • view_orderinteger

      Sort order of the category in lists.

    • is_publicboolean

      The category is shown publicly.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • search_stringstring

      Text that the entity can be searched by.

    • short_identifierstring

      Short identifier of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • image_urlstring

      URL of the image of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • visibility_typestring

    Type of visibility of the entity.

  • arslistarray<AccessRightStorage12>

    Access rights list that controls the visibility.

    Show fields (12)
    • idinteger

      Primary key of the access right entry. Internal ID.

    • userUser55

      User who gets the access right. Only set for user-specific rights.

    • access_tagAccessTag

      Access tag the right applies to. Only set for rights on a tag.

    • create_mainboolean

      Create permission for main records of the access tag.

    • edit_mainboolean

      Edit permission for main records of the access tag.

    • read_mainboolean

      Read permission for main records of the access tag.

    • create_childboolean

      Create permission for child records (for example items inside a main record).

    • edit_childboolean

      Edit permission for child records (for example items inside a main record).

    • read_childboolean

      Read permission for child records (for example items inside a main record).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

Request
curl --request POST \
  --url https://your-instance.iw-erp.de/api/media/feedback_board \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "sort_order": 1,
    "allow_new_entries": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Returns a single feedback board.

GET/api/media/feedback_board/{identifier}

Path parameters

identifierrequiredstring

Responses

200Returns a single MediaFeedbackBoardMediaFeedbackBoard

Show fields (21)
  • is_publicboolean

    True when the board itself may be served to callers without a session.

  • idinteger

    Primary key of the feedback board. Internal ID.

  • namestring

    Internal name, shown in the admin UI only.

  • public_titlestring

    Title of the board shown to the public.

  • public_descriptionstring

    Description of the board shown to the public.

  • public_keystring

    Stable key for the public URL and widget embedding. Server-assigned, never accepted from API input — omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board.

  • image_urlstring

    URL of the image of the board.

  • sort_orderinteger

    Sort order of the board in lists.

  • allow_new_entriesboolean

    Members can create new entries.

  • allow_votingboolean

    Members can vote on entries.

  • allow_commentsboolean

    Members can comment on entries.

  • allow_guest_entriesboolean

    Guests can create new entries.

  • allow_guest_votesboolean

    Guests can vote on entries.

  • allow_guest_commentsboolean

    Guests can comment on entries.

  • moderation_requiredboolean

    Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • ucatsarray<UnifiedCategory30>

    Unified categories of the entity.

    Show fields (32)
    • idinteger

      Primary key of the unified category. Internal ID.

    • category_typestring

      Type of the category, for example course or membership.

    • childrenarray<UnifiedCategory30>

      Child categories.

    • parentUnifiedCategory30

      Parent category.

    • view_orderinteger

      Sort order of the category in lists.

    • is_publicboolean

      The category is shown publicly.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • search_stringstring

      Text that the entity can be searched by.

    • short_identifierstring

      Short identifier of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • image_urlstring

      URL of the image of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • visibility_typestring

    Type of visibility of the entity.

  • arslistarray<AccessRightStorage12>

    Access rights list that controls the visibility.

    Show fields (12)
    • idinteger

      Primary key of the access right entry. Internal ID.

    • userUser55

      User who gets the access right. Only set for user-specific rights.

    • access_tagAccessTag

      Access tag the right applies to. Only set for rights on a tag.

    • create_mainboolean

      Create permission for main records of the access tag.

    • edit_mainboolean

      Edit permission for main records of the access tag.

    • read_mainboolean

      Read permission for main records of the access tag.

    • create_childboolean

      Create permission for child records (for example items inside a main record).

    • edit_childboolean

      Edit permission for child records (for example items inside a main record).

    • read_childboolean

      Read permission for child records (for example items inside a main record).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

Request
curl --request GET \
  --url https://your-instance.iw-erp.de/api/media/feedback_board/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Updates a feedback board.

PUT/api/media/feedback_board/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataMediaFeedbackBoard2
    Show fields (14)
    • namestring

      Internal name, shown in the admin UI only.

    • public_titlestring

      Title of the board shown to the public.

    • public_descriptionstring

      Description of the board shown to the public.

    • image_urlstring

      URL of the image of the board.

    • sort_orderinteger

      Sort order of the board in lists.

    • allow_new_entriesboolean

      Members can create new entries.

    • allow_votingboolean

      Members can vote on entries.

    • allow_commentsboolean

      Members can comment on entries.

    • allow_guest_entriesboolean

      Guests can create new entries.

    • allow_guest_votesboolean

      Guests can vote on entries.

    • allow_guest_commentsboolean

      Guests can comment on entries.

    • moderation_requiredboolean

      Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • ucatsarray<UnifiedCategory11>

      Unified categories of the entity.

Responses

200Update a MediaFeedbackBoardMediaFeedbackBoard

Show fields (21)
  • is_publicboolean

    True when the board itself may be served to callers without a session.

  • idinteger

    Primary key of the feedback board. Internal ID.

  • namestring

    Internal name, shown in the admin UI only.

  • public_titlestring

    Title of the board shown to the public.

  • public_descriptionstring

    Description of the board shown to the public.

  • public_keystring

    Stable key for the public URL and widget embedding. Server-assigned, never accepted from API input — omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board.

  • image_urlstring

    URL of the image of the board.

  • sort_orderinteger

    Sort order of the board in lists.

  • allow_new_entriesboolean

    Members can create new entries.

  • allow_votingboolean

    Members can vote on entries.

  • allow_commentsboolean

    Members can comment on entries.

  • allow_guest_entriesboolean

    Guests can create new entries.

  • allow_guest_votesboolean

    Guests can vote on entries.

  • allow_guest_commentsboolean

    Guests can comment on entries.

  • moderation_requiredboolean

    Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • ucatsarray<UnifiedCategory30>

    Unified categories of the entity.

    Show fields (32)
    • idinteger

      Primary key of the unified category. Internal ID.

    • category_typestring

      Type of the category, for example course or membership.

    • childrenarray<UnifiedCategory30>

      Child categories.

    • parentUnifiedCategory30

      Parent category.

    • view_orderinteger

      Sort order of the category in lists.

    • is_publicboolean

      The category is shown publicly.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • search_stringstring

      Text that the entity can be searched by.

    • short_identifierstring

      Short identifier of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • image_urlstring

      URL of the image of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • visibility_typestring

    Type of visibility of the entity.

  • arslistarray<AccessRightStorage12>

    Access rights list that controls the visibility.

    Show fields (12)
    • idinteger

      Primary key of the access right entry. Internal ID.

    • userUser55

      User who gets the access right. Only set for user-specific rights.

    • access_tagAccessTag

      Access tag the right applies to. Only set for rights on a tag.

    • create_mainboolean

      Create permission for main records of the access tag.

    • edit_mainboolean

      Edit permission for main records of the access tag.

    • read_mainboolean

      Read permission for main records of the access tag.

    • create_childboolean

      Create permission for child records (for example items inside a main record).

    • edit_childboolean

      Edit permission for child records (for example items inside a main record).

    • read_childboolean

      Read permission for child records (for example items inside a main record).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

Request
curl --request PUT \
  --url https://your-instance.iw-erp.de/api/media/feedback_board/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "sort_order": 1,
    "allow_new_entries": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Updates a feedback board.

PATCH/api/media/feedback_board/{identifier}

Path parameters

identifierrequiredstring

Request body application/json

  • dataMediaFeedbackBoard2
    Show fields (14)
    • namestring

      Internal name, shown in the admin UI only.

    • public_titlestring

      Title of the board shown to the public.

    • public_descriptionstring

      Description of the board shown to the public.

    • image_urlstring

      URL of the image of the board.

    • sort_orderinteger

      Sort order of the board in lists.

    • allow_new_entriesboolean

      Members can create new entries.

    • allow_votingboolean

      Members can vote on entries.

    • allow_commentsboolean

      Members can comment on entries.

    • allow_guest_entriesboolean

      Guests can create new entries.

    • allow_guest_votesboolean

      Guests can vote on entries.

    • allow_guest_commentsboolean

      Guests can comment on entries.

    • moderation_requiredboolean

      Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • ucatsarray<UnifiedCategory11>

      Unified categories of the entity.

Responses

200Update a MediaFeedbackBoardMediaFeedbackBoard

Show fields (21)
  • is_publicboolean

    True when the board itself may be served to callers without a session.

  • idinteger

    Primary key of the feedback board. Internal ID.

  • namestring

    Internal name, shown in the admin UI only.

  • public_titlestring

    Title of the board shown to the public.

  • public_descriptionstring

    Description of the board shown to the public.

  • public_keystring

    Stable key for the public URL and widget embedding. Server-assigned, never accepted from API input — omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board.

  • image_urlstring

    URL of the image of the board.

  • sort_orderinteger

    Sort order of the board in lists.

  • allow_new_entriesboolean

    Members can create new entries.

  • allow_votingboolean

    Members can vote on entries.

  • allow_commentsboolean

    Members can comment on entries.

  • allow_guest_entriesboolean

    Guests can create new entries.

  • allow_guest_votesboolean

    Guests can vote on entries.

  • allow_guest_commentsboolean

    Guests can comment on entries.

  • moderation_requiredboolean

    Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • ucatsarray<UnifiedCategory30>

    Unified categories of the entity.

    Show fields (32)
    • idinteger

      Primary key of the unified category. Internal ID.

    • category_typestring

      Type of the category, for example course or membership.

    • childrenarray<UnifiedCategory30>

      Child categories.

    • parentUnifiedCategory30

      Parent category.

    • view_orderinteger

      Sort order of the category in lists.

    • is_publicboolean

      The category is shown publicly.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • search_stringstring

      Text that the entity can be searched by.

    • short_identifierstring

      Short identifier of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • image_urlstring

      URL of the image of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • visibility_typestring

    Type of visibility of the entity.

  • arslistarray<AccessRightStorage12>

    Access rights list that controls the visibility.

    Show fields (12)
    • idinteger

      Primary key of the access right entry. Internal ID.

    • userUser55

      User who gets the access right. Only set for user-specific rights.

    • access_tagAccessTag

      Access tag the right applies to. Only set for rights on a tag.

    • create_mainboolean

      Create permission for main records of the access tag.

    • edit_mainboolean

      Edit permission for main records of the access tag.

    • read_mainboolean

      Read permission for main records of the access tag.

    • create_childboolean

      Create permission for child records (for example items inside a main record).

    • edit_childboolean

      Edit permission for child records (for example items inside a main record).

    • read_childboolean

      Read permission for child records (for example items inside a main record).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

Request
curl --request PATCH \
  --url https://your-instance.iw-erp.de/api/media/feedback_board/42 \
  --header 'content-type: application/json' \
  --header 'x-iw-jwt-token: <TOKEN>' \
  --data '
{
  "data": {
    "name": "Beispiel",
    "public_title": "Beispiel",
    "public_description": "Text",
    "image_url": "https://vynst.de",
    "sort_order": 1,
    "allow_new_entries": true
  }
}
'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}

Soft-deletes a feedback board.

DELETE/api/media/feedback_board/{identifier}

Path parameters

identifierrequiredstring

Responses

200Delete a MediaFeedbackBoardMediaFeedbackBoard

Show fields (21)
  • is_publicboolean

    True when the board itself may be served to callers without a session.

  • idinteger

    Primary key of the feedback board. Internal ID.

  • namestring

    Internal name, shown in the admin UI only.

  • public_titlestring

    Title of the board shown to the public.

  • public_descriptionstring

    Description of the board shown to the public.

  • public_keystring

    Stable key for the public URL and widget embedding. Server-assigned, never accepted from API input — omitted from the oaInput groups on purpose. Changing it would break every page that already embeds this board.

  • image_urlstring

    URL of the image of the board.

  • sort_orderinteger

    Sort order of the board in lists.

  • allow_new_entriesboolean

    Members can create new entries.

  • allow_votingboolean

    Members can vote on entries.

  • allow_commentsboolean

    Members can comment on entries.

  • allow_guest_entriesboolean

    Guests can create new entries.

  • allow_guest_votesboolean

    Guests can vote on entries.

  • allow_guest_commentsboolean

    Guests can comment on entries.

  • moderation_requiredboolean

    Board-level override of the global moderation setting. Null means "use the global setting" — that is why this is nullable and not a plain bool.

  • createdstring (date-time)

    Point in time the entity was created.

  • updatedstring (date-time)

    Point in time the entity was last updated.

  • deletedboolean

    This property is used to mark an entity as deleted / archived

  • ucatsarray<UnifiedCategory30>

    Unified categories of the entity.

    Show fields (32)
    • idinteger

      Primary key of the unified category. Internal ID.

    • category_typestring

      Type of the category, for example course or membership.

    • childrenarray<UnifiedCategory30>

      Child categories.

    • parentUnifiedCategory30

      Parent category.

    • view_orderinteger

      Sort order of the category in lists.

    • is_publicboolean

      The category is shown publicly.

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • namestring

      Name of the entity.

    • addressstring

      Address as text.

    • address_streetstring

      Street of the address.

    • address_house_numberstring

      House number of the address.

    • address_street_levelstring

      Street and house number of the address.

    • address_costring

      Care-of line of the address.

    • address_citystring

      City of the address.

    • address_zipstring

      Postal code of the address.

    • address_admin_level1string

      First administrative level of the address, e.g. the federal state.

    • address_countrystring

      Country code of the address.

    • address_full_countrystring

      Full name of the country of the address.

    • address_geo_latstring

      Latitude of the address.

    • address_geo_lngstring

      Longitude of the address.

    • address_external_provider_idstring

      field to store the external provider id of the address. e.g. Google Maps PlaceID like google:ChIJVcKw5r90sEcRhdjNq6NItqE

    • main_phonestring

      Main phone number.

    • main_faxstring

      Main fax number.

    • main_emailstring

      Main e-mail address.

    • websitestring

      Website address.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

    • search_stringstring

      Text that the entity can be searched by.

    • short_identifierstring

      Short identifier of the entity.

    • slug_identifierstring

      Slug used in URLs of the entity.

    • image_urlstring

      URL of the image of the entity.

    • is_ui_filterboolean

      This property is used to mark an entity as a filter for the frontend

  • visibility_typestring

    Type of visibility of the entity.

  • arslistarray<AccessRightStorage12>

    Access rights list that controls the visibility.

    Show fields (12)
    • idinteger

      Primary key of the access right entry. Internal ID.

    • userUser55

      User who gets the access right. Only set for user-specific rights.

    • access_tagAccessTag

      Access tag the right applies to. Only set for rights on a tag.

    • create_mainboolean

      Create permission for main records of the access tag.

    • edit_mainboolean

      Edit permission for main records of the access tag.

    • read_mainboolean

      Read permission for main records of the access tag.

    • create_childboolean

      Create permission for child records (for example items inside a main record).

    • edit_childboolean

      Edit permission for child records (for example items inside a main record).

    • read_childboolean

      Read permission for child records (for example items inside a main record).

    • createdstring (date-time)

      Point in time the entity was created.

    • updatedstring (date-time)

      Point in time the entity was last updated.

    • deletedboolean

      This property is used to mark an entity as deleted / archived

Request
curl --request DELETE \
  --url https://your-instance.iw-erp.de/api/media/feedback_board/42 \
  --header 'x-iw-jwt-token: <TOKEN>'
Response 200 application/json
{
  "id": 42,
  "name": "Beispiel",
  "public_title": "Beispiel",
  "public_description": "Text",
  "image_url": "https://vynst.de",
  "is_public": true,
  "public_key": "string",
  "sort_order": 1,
  "allow_new_entries": true,
  "allow_voting": true
}