POST/v1/message-templates/{id}/set-default

Make a template the default

Makes this template the default for its channel and category, displacing whoever held that slot — the default is what a composer offers first, and the one a route writing its own letter picks up. One default per (channel, category), held by a unique index rather than by hope. Takes no body; the channel and category come off the row.

Access class: workspace.

Send request

Use the documented inputs to call this endpoint directly.

API serverbase URL

Bearer tokensessionoptional

Stored only in this browser for the session security scheme and reused on every API page in this group.

Parameters

Values are applied to the request and the example on the right.

idpath · stringrequired

Request body

application/jsonrequired

bodyobjectoptional

paramsoptional

queryobjectoptional

Responses

201application/json

the action's answer

{
  "data": {
    "bodyFormat": "string",
    "bodyTemplate": "string",
    "category": "string",
    "channel": "string",
    "closingTemplate": "string",
    "createdAt": "string",
    "createdByUserId": 1,
    "detail": {},
    "documentType": "string",
    "entityKind": "string",
    "greetingTemplate": "string",
    "id": 1,
    "isActive": true,
    "isDefault": true,
    "name": "string",
    "subjectTemplate": "string",
    "updatedAt": "string"
  }
}

dataoptional

defaultapplication/json

a refusal: {"error": "<what a person needs to read>"}. 401 no credential, 402 the plan does not include this, 403 the seat does not, 404 the thing does not exist or is not yours to see.

{
  "error": "string"
}

errorstringrequired