Skip to main content
POST
Create a widget

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new Widget resource

name
string
title
string | null
description
string | null
type
string
default:popup
widgetType
string
default:donation
heroImage
string | null
settings
(string | null)[]
product
string<iri-reference> | null
Example:

"/api/v1/products/1"

isActive
boolean
default:true
tag
string<iri-reference> | null
Example:

"/api/v1/tags/1"

Response

Widget resource created

id
integer
read-only
uuid
string | null
name
string
title
string | null
description
string | null
type
string
default:popup
widgetType
string
default:donation
heroImage
string | null
settings
(string | null)[]
tenant
string<iri-reference>
Example:

"/api/v1/tenants/1"

product
string<iri-reference> | null
Example:

"/api/v1/products/1"

isActive
boolean
default:true
createdAt
string<date-time>
updatedAt
string<date-time> | null
tag
string<iri-reference> | null
Example:

"/api/v1/tags/1"

subscriberCount
integer | null