Skip to content
X-Buddy
Tiếng Việt

API reference

Create or edit a message template

template_save — Without template_id: create.

Markdown version

template_save · Changes an X-Buddy setting

Without template_id: create. With template_id: replace name / kind / text (expected_revision required). Only {{name}}, {{first_name}} and {{handle}} exist; the text is stored exactly as given.
REST POST /api/public/v1/templates
MCP tool template_save
Permission needed campaigns.manage — Owner, Manager, Operator
Scope group automation:write
Group Campaigns
Shown up front in profiles Automation

Input

Field Type Required Description
template_id string (uuid) No Template to change (omit to create).
name string (1–60 chars) Yes
kind dm · reply · quote · post Yes
body string (1–4000 chars) Yes
expected_revision integer (1–∞) No The revision you read (optimistic locking); a newer revision fails with revision_conflict.

Result

Returns the operation's result in the { data, meta } envelope.

Needs an idempotency key (Idempotency-Key, 8–128 characters). Retrying with the same key never repeats the action.

Versioned setting: send the expected_revision (or If-Match) you read, or the write is refused.

Example

Call over REST

curl -X POST "https://reach-link-craft.lovable.app/api/public/v1/templates" \
  -H "Authorization: Bearer $XBUDDY_API_KEY" \
  -H "Idempotency-Key: 6f1c2a90-example-key" \
  -H 'If-Match: "3"' \
  -H "Content-Type: application/json" \
  -d '{"name":"Example","kind":"dm","body":"Hello from X-Buddy"}'

Call over MCP

{
  "method": "tools/call",
  "params": {
    "name": "template_save",
    "arguments": {
      "name": "Example",
      "kind": "dm",
      "body": "Hello from X-Buddy",
      "idempotency_key": "6f1c2a90-example-key",
      "expected_revision": 3
    }
  }
}

Errors you may get

Code HTTP Retryable
unauthorized 401 No
key_expired 401 No
integration_revoked 401 No
connection_not_linked 403 No
integration_paused 403 No
workspace_integrations_paused 403 No
integration_authorization_lost 403 No
workspace_suspended 403 No
forbidden 403 No
invalid_input 422 No
rate_limited 429 Yes
internal 500 Yes
read_only 403 No
idempotency_key_required 428 No
idempotency_conflict 409 No
idempotency_processing 409 Yes
conflict 409 No
precondition_failed 422 No
revision_required 428 No
revision_conflict 412 No
not_found 404 No

Back to all operations