Skip to content
Console
On this page

Create a template

Creates a template.

Creates a template.

  • Path POST https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates
  • Scope notify:write
  • Effect write — a successful call changes state.
  • Collection templates
  • Query template_id, validate_only

Request

FieldTypeWhat it is
parentstringThe parent to create in. Required.
template_idstringThe template id, the final name segment; the server assigns one when empty.
templateTemplateThe template to create; only caller-writable fields are read. Required.
validate_onlyboolValidate and return the result without writing anything.

Template

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/templates/{template}.
metaResourceMetaResource metadata.
specTemplateSpecDesired state. Required.

ResourceMeta

FieldTypeWhat it is
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.

TemplateSpec

FieldTypeWhat it is
emailEmailContentEmail content.
smsSmsContentSMS content.
pushPushContentPush content.
inboxInboxContentIn-app inbox content.
send_limitSendLimitA per-recipient send limit on messages rendered from this template; unset admits every message.

EmailContent

FieldTypeWhat it is
sender_addressstringThe From address; its domain is a verified Email Domain. Required.
subjectstringThe subject. Required.
html_bodystringThe HTML body.
text_bodystringThe plain-text body.
sender_namestringThe From display name, for example the app's name.

SmsContent

FieldTypeWhat it is
senderstringThe SMS Sender. Required.
bodystringThe body. Required.

PushContent

FieldTypeWhat it is
titlestringThe title. Required.
bodystringThe body.
datastructData delivered with the notification.
senderstringDeliver only to this Sender's registered browsers, never other apps or origins belonging to the same recipient. Required.

InboxContent

FieldTypeWhat it is
titlestringThe title. Required.
bodystringThe body.
action_uristringWhere the item links.

SendLimit

FieldTypeWhat it is
min_intervaldurationAt least this long between two messages to one recipient.
max_per_hourint32At most this many messages to one recipient in any hour; 0 is no limit.

Response

FieldTypeWhat it is
namestringorgs/{org}/projects/{project}/envs/{env}/templates/{template}.
uidstringtpl_<cell><ulid>; never reused. Output only.
metaResourceMetaResource metadata.
specTemplateSpecDesired state. Required.
statusTemplateStatusObserved state. Output only.

ResourceMeta

FieldTypeWhat it is
generationint64Increases by one on every change to spec. Output only.
etagstringStrong ETag (AIP-154): changes on any change to spec, status, or metadata. Send it back as If-Match or etag to make Update and Delete conditional; a mismatch fails with ABORTED / 409 ETAG_MISMATCH. Output only.
create_timetimestampWhen the Resource was created. Output only.
update_timetimestampWhen the Resource last changed. Output only.
delete_timetimestampSet while the Resource is being deleted. Output only.
labelsmap<string, string>Caller-writable, indexed labels (AIP-122 label rules).
annotationsmap<string, string>Caller-writable, unindexed annotations.
display_namestringCaller-writable human-readable name.
creatorstringThe principal that created the Resource. Output only.

TemplateSpec

FieldTypeWhat it is
emailEmailContentEmail content.
smsSmsContentSMS content.
pushPushContentPush content.
inboxInboxContentIn-app inbox content.
send_limitSendLimitA per-recipient send limit on messages rendered from this template; unset admits every message.

TemplateStatus

FieldTypeWhat it is
observed_generationint64The generation this status was computed from. Output only.
conditionsCondition[]Ready, Reconciling, Stalled. Output only.
versionint64The version the current spec is; messages pin it. Output only.

EmailContent

FieldTypeWhat it is
sender_addressstringThe From address; its domain is a verified Email Domain. Required.
subjectstringThe subject. Required.
html_bodystringThe HTML body.
text_bodystringThe plain-text body.
sender_namestringThe From display name, for example the app's name.

SmsContent

FieldTypeWhat it is
senderstringThe SMS Sender. Required.
bodystringThe body. Required.

PushContent

FieldTypeWhat it is
titlestringThe title. Required.
bodystringThe body.
datastructData delivered with the notification.
senderstringDeliver only to this Sender's registered browsers, never other apps or origins belonging to the same recipient. Required.

InboxContent

FieldTypeWhat it is
titlestringThe title. Required.
bodystringThe body.
action_uristringWhere the item links.

SendLimit

FieldTypeWhat it is
min_intervaldurationAt least this long between two messages to one recipient.
max_per_hourint32At most this many messages to one recipient in any hour; 0 is no limit.

Condition

FieldTypeWhat it is
typestringThe condition type, for example Ready.
statusConditionStatusWhether the condition holds. One of true, false, unknown.
observed_generationint64The generation this observation was made against.
reasonstringA machine-readable UpperCamelCase reason.
messagestringA customer-safe human-readable message.
severitySeverityHow severe a FALSE condition is. One of info, warning, error.
transition_timetimestampWhen status last changed.

Errors

Every error arrives in the body Errors describes.

Examples

curl -X POST "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/templates" \
  -H "Authorization: Bearer $SYLPHX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"spec":{}}'