Skip to main content
PATCH
Update a template

Authorizations

x-api-key
string
header
required

Your Recoup API key. Learn more.

Path Parameters

id
string<uuid>
required

The unique identifier (UUID) of the template to update

Body

application/json

Fields to update on the template

All fields are optional. Only supplied fields are updated.

title
string

Short human-readable title for the template

Required string length: 3 - 50
description
string

Description of what the template does

Required string length: 10 - 200
prompt
string

The agent prompt body

Required string length: 20 - 10000
tags
string[]

Free-form tags used to categorize the template. Pass an empty array to clear tags.

is_private
boolean

When true, the template is restricted to the creator and the accounts listed in share_emails

share_emails
string<email>[]

Replaces the existing share list for the template. Only applied when the template is (or becomes) private.

Response

Template updated successfully

status
enum<string>
required

Status of the request

Available options:
success
template
object
required