Skip to main content
PATCH
Update a template
Requires the IAM action email:UpdateTemplate. See EMAIL permissions for the full list, what each one covers, and an example policy.

Authorizations

Authorization
string
header
required

An OAuth 2.0 bearer token, sent as Authorization: Bearer <token>. This is the recommended way to authenticate.

Get one by exchanging a service account's access key pair at POST /v1/oauth/token with grant_type=client_credentials. It is the standard client-credentials grant, so any OAuth-aware library will obtain and refresh it for you.

Tokens last an hour by default. The same access key pair is separately your AWS SigV4 credential for the S3-compatible object endpoint, which speaks nothing else.

Path Parameters

template_id
string<uuid>
required

Body

application/json

Omitted fields are preserved. An empty subject clears it. body_template must be nonempty and body_type must be text or html. Null values are rejected.

subject_template
string
body_template
string
Minimum string length: 1
body_type
enum<string>
Available options:
text,
html

Response

The updated template.

template
object
required