Skip to content
docs
Browse the docsTemplates

API reference

Templates API

Saved inbox settings. Every templates endpoint with its scope, parameters, body and an example answer.

Base URL https://api.dissolve.email. Send an API key or OAuth access token as Authorization: Bearer <token> (Authentication); an OAuth token needs the scope on each endpoint. Errors follow one shape.

EndpointSummary
GET /v1/templatesList templates
POST /v1/templatesCreate a template
DELETE /v1/templates/{id}Delete a template

List templates

GET/v1/templatesinboxes:read

Saved inbox settings (domain, forwarding, a webhook address) to create inboxes from, default first (Free 3, Pro 10, Business 25).

curl "https://api.dissolve.email/v1/templates" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "templates": [
    {
      "id": "tpl9Wm2QxK5rNc8Vz1LpT",
      "name": "Forwarded",
      "domain": null,
      "forwardTo": "me@example.com",
      "webhookUrl": null,
      "isDefault": true,
      "createdAt": "2026-11-19T10:00:00.000Z",
      "updatedAt": "2026-11-19T10:00:00.000Z"
    }
  ],
  "limit": 10,
  "used": 1
}

Create a template

POST/v1/templatesrules:manage

Saves settings to pass as templateId when creating an inbox. Forwarding needs Pro or Business.

Body (application/json)

NameTypeRequiredDescription
namestringyesThe template's name. At most 100 characters.
domainstring or nullnoA domain from GET /v1/domains.
forward_tostring or nullnoForward new inboxes' mail here (Pro and Business).
webhook_urlstring or nullnoA webhook address kept with the template.
is_defaultbooleannoUse it when no template is named. Default false.
curl -X POST "https://api.dissolve.email/v1/templates" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name":"Forwarded","forward_to":"me@example.com","is_default":true}'

Response 201

JSON
{
  "id": "tpl9Wm2QxK5rNc8Vz1LpT",
  "name": "Forwarded",
  "domain": null,
  "forwardTo": "me@example.com",
  "webhookUrl": null,
  "isDefault": true,
  "createdAt": "2026-11-19T10:00:00.000Z",
  "updatedAt": "2026-11-19T10:00:00.000Z"
}

Delete a template

DELETE/v1/templates/{id}rules:manage

Deletes the template. Inboxes made from it are unchanged.

Path parameters

NameDescription
idThe template id.
curl -X DELETE "https://api.dissolve.email/v1/templates/$TEMPLATE_ID" \
  -H "Authorization: Bearer $DISSOLVE_API_KEY"

Response 200

JSON
{
  "success": true
}

Something wrong or missing on this page? Tell us at support@dissolve.email.View as Markdown