Template Modules API
Create, retrieve, update, and delete reusable email content modules. Modules are blocks of email content (stored as JSON) that can be inserted into any template via the visual editor.
Note
For a user guide on using modules in the visual editor, see Saved Modules.
Endpoints
| Method | Path | Description |
|---|---|---|
GET | /v1/template-modules | List modules |
POST | /v1/template-modules | Create a module |
GET | /v1/template-modules/{id} | Get a module |
PUT | /v1/template-modules/{id} | Update a module |
DELETE | /v1/template-modules/{id} | Delete a module |
Authentication
All endpoints require a JWT bearer token:
bash
curl "https://synapse-api.pyrx.tech/v1/template-modules" \
-H "Authorization: Bearer eyJhbGciOiJS..."
| Operation | Required permission |
|---|---|
| List, Get | templates:read |
| Create, Update, Delete | templates:write |
Missing permission returns:
json
{
"detail": "Missing permission: templates:read"
}
Module Object
json
{
"id": "m1o2d3u4-l5e6-7890-abcd-ef1234567890",
"name": "Standard Footer",
"description": "Company footer with social links and unsubscribe",
"category": "footer",
"tags": ["footer", "social", "unsubscribe"],
"blocks_json": [
{
"id": "blk-1",
"type": "divider",
"props": { "style": "solid", "color": "#e5e7eb", "thickness": "1px" },
"styles": { "paddingTop": "24px", "paddingBottom": "16px" }
},
{
"id": "blk-2",
"type": "paragraph",
"props": { "text": "You received this email because you signed up at example.com." },
"styles": { "fontSize": "12px", "color": "#6b7280", "textAlign": "center" }
}
],
"thumbnail_url": null,
"is_synced": false,
"created_by": "mem_abc123",
"created_at": "2026-04-10T08:00:00Z",
"updated_at": "2026-04-15T14:30:00Z"
}
Fields
| Field | Type | Description |
|---|---|---|
id | UUID | Module identifier |
name | string | Unique name within the workspace (1--255 characters) |
description | string or null | Optional description |
category | string | One of: header, footer, cta, content, custom |
tags | string[] | Optional tags for filtering and organization |
blocks_json | array | Array of email block objects (the module's content) |
thumbnail_url | string or null | Optional preview image URL |
is_synced | boolean | Whether this module syncs updates to templates that use it |
created_by | string or null | Member ID of the creator |
created_at | datetime | Creation timestamp |
updated_at | datetime | Last update timestamp |
List Modules
bash
curl "https://synapse-api.pyrx.tech/v1/template-modules" \
-H "Authorization: Bearer eyJhbGciOiJS..."
Query Parameters
| Parameter | Type | Description |
|---|---|---|
category | string | Filter by category: header, footer, cta, content, custom |
Response (200 OK)
Returns an array of module objects, ordered by updated_at descending (most recently modified first).
json
[
{
"id": "m1o2d3u4-l5e6-7890-abcd-ef1234567890",
"name": "Standard Footer",
"description": "Company footer with social links and unsubscribe",
"category": "footer",
"tags": ["footer", "social"],
"blocks_json": [ "..." ],
"thumbnail_url": null,
"is_synced": false,
"created_by": "mem_abc123",
"created_at": "2026-04-10T08:00:00Z",
"updated_at": "2026-04-15T14:30:00Z"
}
]
Create a Module
bash
curl -X POST "https://synapse-api.pyrx.tech/v1/template-modules" \
-H "Authorization: Bearer eyJhbGciOiJS..." \
-H "Content-Type: application/json" \
-d '{
"name": "Hero Section",
"description": "Full-width hero with image and CTA button",
"category": "content",
"tags": ["hero", "featured"],
"blocks_json": [
{
"id": "blk-img",
"type": "image",
"props": { "src": "https://cdn.example.com/hero.jpg", "alt": "Hero image", "width": "600px" },
"styles": { "paddingBottom": "16px" }
},
{
"id": "blk-btn",
"type": "button",
"props": { "text": "Get Started", "url": "https://example.com/signup", "buttonColor": "#1D9E75", "textColor": "#ffffff", "borderRadius": "8px", "align": "center" },
"styles": {}
}
]
}'
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
name | string | Yes | Module name (1--255 characters, must be unique) |
description | string | No | Description |
category | string | No | header, footer, cta, content, or custom (default: custom) |
tags | string[] | No | Tags (default: empty array) |
blocks_json | array | Yes | Array of email block objects |
Response (201 Created)
Returns the full module object.
Note
Module names must be unique within your workspace. Creating a module with a duplicate name returns 409 Conflict.
Get a Module
bash
curl "https://synapse-api.pyrx.tech/v1/template-modules/m1o2d3u4-l5e6-7890-abcd-ef1234567890" \
-H "Authorization: Bearer eyJhbGciOiJS..."
Returns the full module object, or 404 if not found.
Update a Module
bash
curl -X PUT "https://synapse-api.pyrx.tech/v1/template-modules/m1o2d3u4-l5e6-7890-abcd-ef1234567890" \
-H "Authorization: Bearer eyJhbGciOiJS..." \
-H "Content-Type: application/json" \
-d '{
"name": "Hero Section v2",
"tags": ["hero", "featured", "v2"]
}'
All fields are optional. Only the fields you include are updated.
Request Body
| Field | Type | Description |
|---|---|---|
name | string | New name (1--255 characters, must be unique) |
description | string | New description |
category | string | New category |
tags | string[] | New tags |
blocks_json | array | New block content |
Response (200 OK)
Returns the updated module object. If the new name conflicts with an existing module, returns 409 Conflict.
Delete a Module
bash
curl -X DELETE "https://synapse-api.pyrx.tech/v1/template-modules/m1o2d3u4-l5e6-7890-abcd-ef1234567890" \
-H "Authorization: Bearer eyJhbGciOiJS..."
Returns 204 No Content on success. Deleting a module does not affect templates that already contain copies of its blocks.
Error Codes
| Status | Description |
|---|---|
| 403 | Missing templates:read or templates:write permission |
| 404 | Module not found |
| 409 | Module name already exists in this workspace |
| 422 | Validation error (e.g., name too long, invalid category) |