Update Template with Specified ID

POST

https://v1.vocu.ai/api/template/{id}

This is a full replacement, not a partial update: contents and metadata are overwritten wholesale. Omitting description removes it from metadata rather than preserving the previous value; name is the sole exception — omit it and the current name is kept.

contents is required and its absence returns 400 VALIDATION_MISSING_FIELD. That check runs before the ownership lookup, so a request without contents against a non-existent template returns 400 rather than 404.

A template that does not exist or belongs to someone else returns 404 RESOURCE_NOT_FOUND.

A successful response is just { status: 200 } and does not include the updated template — call GET /api/template/{id} if you need the new state.

INFO

See the Errors document for the full code reference. Always use the X-Vocu-App-Request-Id response header when troubleshooting.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Path Params

Body Params application/json

Example

{
    "name": "Food Description",
    "description": "Generation template containing food descriptions",
    "contents": [
        {
            "voiceId": "894cdf24-195a-4213-b15f-0395e08e6422",
            "text": "Three artichokes with melon, sun-dried tomatoes, pumpkin, onion, and capers. Served with a side of grilled kiwi, plus your choice of artichoke or green beans."
        },
        {
            "voiceId": "95bc36d7-b0bc-44db-a1da-6a52a97b7222",
            "text": "Eel slow-simmered in a rich tomato sauce with arugula, accompanied by creamy bok choy."
        }
    ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location 'https://v1.vocu.ai/api/template/' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "name": "Food Description",
    "description": "Generation template containing food descriptions",
    "contents": [
        {
            "voiceId": "894cdf24-195a-4213-b15f-0395e08e6422",
            "text": "Three artichokes with melon, sun-dried tomatoes, pumpkin, onion, and capers. Served with a side of grilled kiwi, plus your choice of artichoke or green beans."
        },
        {
            "voiceId": "95bc36d7-b0bc-44db-a1da-6a52a97b7222",
            "text": "Eel slow-simmered in a rich tomato sauce with arugula, accompanied by creamy bok choy."
        }
    ]
}'

Responses

🟢200Template Updated Successfully

application/json

Updated (no data; fetch the detail endpoint if you need the new state)

Bodyapplication/json

Example

{
    "status": 200,
    "message": "OK"
}

🟠400Bad request

🟠401Unauthorized

🟠404Not found

🟠429Rate limited

Modified at 2026-08-23 09:24:46

Create New Template

Delete Template with Specified ID