Samva
DashboardAPI
ChannelsPlatformMailboxesDevelopersEmail templatesIntegrationsAPI Reference
Templates

Update a template

Updates template metadata. View request and response details for this Samva email API endpoint.

PATCH
/v1/templates/{id}

Updates template metadata. Setting entryPath points the template at another file in its project and keeps its id, slug, and publications; move the file in Git separately. Source changes use the project workspace API.

Authorization

apiKey
headerx-api-key<token>

Path Parameters

id*string
Match^tmpl_[0-9a-hjkmnp-tv-z]{16,24}$

Request Body

application/json
  1. body
data*

Response Body

Template

application/json
  1. response
id*TemplateId
Match^tmpl_[0-9a-hjkmnp-tv-z]{16,24}$
slug*string
name*string
channel*string
Value in"sms""whatsapp""email"
projectId*TemplateProjectId
Match^tproj_[0-9a-hjkmnp-tv-z]{16,24}$
namespaceId*|

The namespace the template's project belongs to; every entry in a project shares it. Null at organization level. A namespace-scoped key reaches only its own namespace's templates and shared ones.

shared*boolean

Whether the template's project is shared with every namespace. Every entry in a project shares it. A namespace-scoped key reads and sends a shared template in its own namespace but cannot change it. Only an organization-level project is shared.

entryPath*string
Match^(?!\/)(?!.*\\)(?!.*(?:^|\/)\.{1,2}(?:\/|$))(?!.*(?:^|\/)\.git(?:\/|$))(?:templates|emails)\/.+\.tsx$
Lengthlength <= 1024
status*string
Value in"draft""pending""approved""published""rejected""archived"
isActive*boolean
publishedAt*string|null
brand*|null
fromDefault*|null
usageCount*integer
Range0 <= value <= 9007199254740991
lastUsedAt*string|null
createdAt*string
updatedAt*string
familyId*|null
description*string|null
category*|null
replyToDefault*array<string>|null
trackingDefault*|null
email*|null
sms*|null
whatsapp*|null
publicationId*|null
inputContractId*|null
inputSchema*|null
Example Request
import { createClient } from "samva";const samva = createClient({ apiKey: process.env.SAMVA_API_KEY! });const result = await samva.templates.update({  "id": "example",  "data": {}});
Example Response
{  "id": "string",  "slug": "string",  "name": "string",  "channel": "sms",  "projectId": "string",  "namespaceId": "string",  "shared": true,  "entryPath": "string",  "status": "draft",  "isActive": true,  "publishedAt": "string",  "brand": {    "slug": "string",    "digest": "string",    "stale": true  },  "fromDefault": {    "email": "string",    "name": "string"  },  "usageCount": 0,  "lastUsedAt": "string",  "createdAt": "string",  "updatedAt": "string",  "familyId": "string",  "description": "string",  "category": "transactional",  "replyToDefault": [    "string"  ],  "trackingDefault": {    "opens": true,    "clicks": true  },  "email": {    "subject": "string",    "preheader": "string",    "headers": {      "property1": "string",      "property2": "string"    }  },  "sms": {    "body": "string",    "encoding": "string",    "estimatedSegments": -9007199254740991,    "category": "transactional"  },  "whatsapp": {    "name": "string",    "language": "string",    "category": "marketing",    "components": [      {        "type": "HEADER",        "format": "TEXT",        "text": "string",        "example": {          "header_text": [            "string"          ]        }      }    ]  },  "publicationId": "string",  "inputContractId": "string",  "inputSchema": {    "property1": "string",    "property2": "string"  }}

Related documentation

Save a template project workspace

Validates the effective project tree and saves it as one Git commit on the template repository's default branch.

List template project commit history

Returns recent history from the template repository's default branch. Use this endpoint to list template project commit history through the Samva email API.