Access is invite-only during beta. Once invited, create a key to personalize these examples. Production sending requires a separate review.
Send with a template
Pass template.id and variables instead of html.
Publish the template first. Then send over POST /api/v1/emails or POST /api/v1/teams/:obfuscated_team_id/clusters/:obfuscated_cluster_id/sends.
template.id is the alias (welcome) or the public id (TpLmQr). variables is the Liquid assign hash. Nested objects and arrays are allowed.
send-template.sh
1
curl -sS -X POST \
2
-H 'Authorization: Bearer YOUR_API_KEY' \
3
-H 'Content-Type: application/json' \
4
-d '{
5
"from": "hello@mail.example.com",
6
"to": ["you@example.com"],
7
"template": {
8
"id": "welcome",
9
"variables": {
10
"name": "Ada",
11
"body": "Your account is ready.",
12
"action_url": "https://example.com/start"
13
}
14
},
15
"unique_args": {"campaign_id": "cmp_123"}
16
}' \
17
https://app.postshiba.com/api/v1/emails
A nested {send: {template: …}} body works the same way.
Overrides
| Request field | Behavior |
|---|---|
from |
Overrides the template From. Still must be a verified domain. |
subject |
Replaces the rendered template subject. Not Liquid. |
reply_to |
Overrides the template Reply-To. |
html or text |
Rejected. 422 {error: invalid, field: template}. |
to, cc, bcc, headers, unique_args, attachments, tenant |
Same as a normal send. |
Errors
| error | When |
|---|---|
invalid / template is unknown |
No template with that id or alias on the token's team. |
invalid / template is not published |
The template is still a draft. |
invalid / template cannot be combined with html or text |
You passed both. |
invalid / template |
Liquid failed to render. |
cluster_not_ready, domain_unverified, credential_missing, suppressed, firewall, kyc_required |
Same gates as a normal send. |
The composed mail still goes through unique args, attachments, and custom headers.