Create template

POST

/templates

Creates a template. type is required and must be a known template type.

Create a segment folder: send type = folders and subType = custom.
Persist data.id and pass it as folderIds on segments.

Returns 400 FOLDER_LIMIT_EXCEEDED when the workspace already has 500 folders.

Request

Authorization

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Body Params application/jsonRequired

Examples

Responses

🟢200

application/json

Created template (JSON:API)

Bodyapplication/json

🟠400

🟠401

Request Example

Shell

JavaScript

Java

Swift

curl --location 'https://app.highperformr.ai/api/templates' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Q3 outbound",
    "type": "folders",
    "subType": "custom",
    "description": "Campaign audiences for Q3"
}'

Response Example

200 - Success

{
    "data": {
        "id": "folder_abc123",
        "type": "templates",
        "attributes": {
            "name": "Q3 outbound",
            "description": "Campaign audiences for Q3",
            "type": "folders",
            "subType": "custom",
            "isDefault": false,
            "createdAt": "2026-09-24T07:00:00.000Z"
        }
    }
}

Modified at 2026-09-24 07:44:15

Filter templates

Get template by ID