← Back to API Reference
/customization_elements
Tag: customization_elements
getModular customization objects for the personalization engine
Parameters
| Name | In | Type | Format | Required | Description |
|---|---|---|---|---|---|
id | query | string | — | — | — |
name | query | string | — | — | — |
code | query | string | — | — | — |
element_type | query | string | — | — | — |
constraints | query | string | — | — | — |
default_styles | query | string | — | — | — |
allowed_placements | query | string | — | — | — |
default_placement | query | string | — | — | — |
description | query | string | — | — | — |
is_active | query | string | — | — | — |
sort_order | query | string | — | — | — |
created_by | query | string | — | — | — |
created_at | query | string | — | — | — |
updated_at | query | string | — | — | — |
deleted_at | query | string | — | — | — |
select | query | string | — | — | Filtering Columns |
order | query | string | — | — | Ordering |
Range | header | string | — | — | Limiting and Pagination |
Range-Unit | header | string | — | — | Limiting and Pagination |
offset | query | string | — | — | Limiting and Pagination |
limit | query | string | — | — | Limiting and Pagination |
Prefer | header | string | — | — | Preference |
Example
bash
curl "https://szkofkgbqogzlbqtcrke.supabase.co/rest/v1/customization_elements?select=*&limit=10" \
-H "apikey: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"Responses
200OK
206Partial Content
postModular customization objects for the personalization engine
Parameters
| Name | In | Type | Format | Required | Description |
|---|---|---|---|---|---|
customization_elements | body | object | — | — | customization_elements |
select | query | string | — | — | Filtering Columns |
Prefer | header | string | — | — | Preference |
Example
bash
curl -X POST "https://szkofkgbqogzlbqtcrke.supabase.co/rest/v1/customization_elements" \
-H "apikey: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-H "Prefer: return=representation" \
-d '{
"name": "example",
"code": "example",
"element_type": "example",
"constraints": {},
"default_styles": {}
}'Responses
201Created
patchModular customization objects for the personalization engine
Parameters
| Name | In | Type | Format | Required | Description |
|---|---|---|---|---|---|
id | query | string | — | — | — |
name | query | string | — | — | — |
code | query | string | — | — | — |
element_type | query | string | — | — | — |
constraints | query | string | — | — | — |
default_styles | query | string | — | — | — |
allowed_placements | query | string | — | — | — |
default_placement | query | string | — | — | — |
description | query | string | — | — | — |
is_active | query | string | — | — | — |
sort_order | query | string | — | — | — |
created_by | query | string | — | — | — |
created_at | query | string | — | — | — |
updated_at | query | string | — | — | — |
deleted_at | query | string | — | — | — |
customization_elements | body | object | — | — | customization_elements |
Prefer | header | string | — | — | Preference |
Example
bash
curl -X PATCH "https://szkofkgbqogzlbqtcrke.supabase.co/rest/v1/customization_elements?id=eq.YOUR_ID" \
-H "apikey: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-H "Prefer: return=representation" \
-d '{"name": "example"}'Responses
204No Content
deleteModular customization objects for the personalization engine
Parameters
| Name | In | Type | Format | Required | Description |
|---|---|---|---|---|---|
id | query | string | — | — | — |
name | query | string | — | — | — |
code | query | string | — | — | — |
element_type | query | string | — | — | — |
constraints | query | string | — | — | — |
default_styles | query | string | — | — | — |
allowed_placements | query | string | — | — | — |
default_placement | query | string | — | — | — |
description | query | string | — | — | — |
is_active | query | string | — | — | — |
sort_order | query | string | — | — | — |
created_by | query | string | — | — | — |
created_at | query | string | — | — | — |
updated_at | query | string | — | — | — |
deleted_at | query | string | — | — | — |
Prefer | header | string | — | — | Preference |
Example
bash
curl -X DELETE "https://szkofkgbqogzlbqtcrke.supabase.co/rest/v1/customization_elements?id=eq.YOUR_ID" \
-H "apikey: YOUR_API_KEY" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"Responses
204No Content
Schema
Modular customization objects for the personalization engine
| Column | Type | Format | Nullable | Default | Notes |
|---|---|---|---|---|---|
idPK | string | uuid | — | extensions.uuid_generate_v4() | This is a Primary Key. |
name | string | text | — | — | — |
code | string | text | — | — | — |
element_type | string | text | — | — | — |
constraints | object | jsonb | — | — | — |
default_styles | object | jsonb | — | — | — |
allowed_placements | array | text[] | ✓ | — | — |
default_placement | string | text | ✓ | — | — |
description | string | text | ✓ | — | — |
is_active | boolean | boolean | — | — | |
sort_order | integer | integer | — | 0 | — |
created_by | string | uuid | ✓ | — | — |
created_at | string | timestamp with time zone | ✓ | now() | — |
updated_at | string | timestamp with time zone | ✓ | now() | — |
deleted_at | string | timestamp with time zone | ✓ | — | — |