Runs examples for real against your account. Test keys only; kept in this tab, never stored on our side. Get a key
ZapSMTP / Docs / Click actions

Describe an action

PATCH/v1/actions/{name}

Change an action’s description. An action that links use but nobody declared is declared by this call.

Requires a full-access live key; test keys get 403 test_key_restricted.

Like create, the response carries zero stats; read them with GET /actions/{name}.

Path parameters

namestringrequired
Action name, as written in data-zap-action.

Body parameters

descriptionstring
The new description; leaving it out sets it to empty. Limits: at most 500 bytes → 422 invalid_parameter

Errors

restricted_api_keyHTTP 403
test_key_restrictedHTTP 403
test-mode keys can send test email and read, not change the account: use a live key
not_foundHTTP 404
action not found (the name is not a valid action name)
invalid_parameterHTTP 422
description: at most 500 bytes
PATCH/v1/actions/{name}
curl -X PATCH 'https://zapsmtp.xyz/v1/actions/confirm_order' \
  -H "Authorization: Bearer $ZAP_API_KEY" \
  -H 'Content-Type: application/json' \
  -d '{
  "description": "Customer confirms an order from the receipt email"
}'
Set ZAP_API_KEY in your environment.
Response 200 OK
{
  "object": "action",
  "name": "confirm_order",
  "description": "Customer confirms an order from the receipt email",
  "declared": true,
  "created_at": "2026-10-24T09:12:00Z",
  "updated_at": "2026-10-27T10:05:00Z",
  "clicks_7d": 0,
  "clicks_30d": 0,
  "unique_clickers_30d": 0,
  "last_click_at": null,
  "templates": 0,
  "webhooks": []
}