For the complete documentation index, see llms.txt. This page is also available as Markdown.

Imprints

Introduction

Imprints provide an organization's legal disclosure as inline content or a link.

The text field uses the shared Rich Text HTML format.

Model Definition

Alias

imprint

Capabilities

Admin: List

List all Imprints in administration scope.

Definition

GET /api/administration/imprints

Request Keys

Key
Type
Default
Description

select

string

All fields

Comma-separated fields to return.

limit

integer

No limit

Maximum number of records.

filter

object

No filters

sort

string

Repository order

Comma-separated fields; prefix a field with - for descending order.

Example Request

Example Response

Admin: Show

Show one Imprint in administration scope.

Definition

GET /api/administration/imprints/{imprint}

Route Parameters

Parameter
Type
Description

imprint

integer

Imprint ID.

Request Keys

Key
Type
Default
Description

select

string

All fields

Comma-separated fields to return.

Example Request

Example Response

Admin: Create

Create a new Imprint.

Definition

POST /api/administration/imprints

Request Keys

Key
Type
Default
Description

lang_id

string

System language

Language key. Use en-US for this example.

text

string | null

null

Disclosure content in Rich Text HTML.

link

string | null

null

URL that provides the disclosure.

Behavior

  • At least one of text or link is required.

  • When link has a value, the imprint redirects to that URL instead of rendering text.

  • The authenticated user is stored as the creating user.

Example Request

Example Response

Admin: Update

Update an existing Imprint.

Definition

PUT /api/administration/imprints/{imprint}

Route Parameters

Parameter
Type
Description

imprint

integer

Imprint ID.

Request Keys

Key
Type
Description

lang_id

string

Language key.

text

string | null

Disclosure content in Rich Text HTML.

link

string | null

URL that provides the disclosure.

Behavior

  • Each update must provide at least one of text or link.

  • When link has a value, the imprint redirects to that URL instead of rendering text.

  • The authenticated user replaces the creating user stored on the record.

Example Request

Example Response

Admin: Delete

Delete an existing Imprint.

Definition

DELETE /api/administration/imprints/{imprint}

Route Parameters

Parameter
Type
Description

imprint

integer

Imprint ID.

Example Request

Example Response

Last updated