--- updatedAt: 2026-05-04T07:02:55.000Z agentTools: projectIndex: https://developers.intandem.tech/llms.txt --- # Create a NotificationTemplate ## Overview Create a new notification template. .**. **Available for Directory and App tokens** # OpenAPI definition ```json { "openapi": "3.1.0", "info": { "title": "Communication", "description": "Unified OpenAPI specification for communication domain", "version": "3.0", "x-generated": { "sourceFiles": [ "business_phone_numbers.json", "contact_channels.json", "legacy_v1_communication.json", "communication.json", "activity_message.json", "communication.json", "conversations.json", "notification_template.json", "legacy_v2_communication.json", "staff_notification.json", "messages.json" ], "pathNormalizations": [ { "file": "legacy_v1_communication.json", "basePath": "/platform/v1", "transformations": [ { "original": "/conversations", "normalized": "/platform/v1/conversations", "basePath": "/platform/v1" }, { "original": "/clients/{client_id}/conversations", "normalized": "/platform/v1/clients/{client_id}/conversations", "basePath": "/platform/v1" }, { "original": "/messages", "normalized": "/platform/v1/messages", "basePath": "/platform/v1" }, { "original": "/numbers/dedicated_numbers/assign", "normalized": "/platform/v1/numbers/dedicated_numbers/assign", "basePath": "/platform/v1" }, { "original": "/numbers/dedicated_numbers/set_two_way_texting_status", "normalized": "/platform/v1/numbers/dedicated_numbers/set_two_way_texting_status", "basePath": "/platform/v1" }, { "original": "/numbers/twilio", "normalized": "/platform/v1/numbers/twilio", "basePath": "/platform/v1" }, { "original": "/numbers/twilio/{sub_account_id}", "normalized": "/platform/v1/numbers/twilio/{sub_account_id}", "basePath": "/platform/v1" } ] }, { "file": "communication.json", "basePath": "/business/communication", "transformations": [ { "original": "/channels", "normalized": "/business/communication/channels", "basePath": "/business/communication" }, { "original": "/channels/{uid}", "normalized": "/business/communication/channels/{uid}", "basePath": "/business/communication" }, { "original": "/messages", "normalized": "/business/communication/messages", "basePath": "/business/communication" }, { "original": "/messages/{messageUid}", "normalized": "/business/communication/messages/{messageUid}", "basePath": "/business/communication" }, { "original": "/sessions", "normalized": "/business/communication/sessions", "basePath": "/business/communication" }, { "original": "/sessions/typing", "normalized": "/business/communication/sessions/typing", "basePath": "/business/communication" }, { "original": "/sessions/{uid}", "normalized": "/business/communication/sessions/{uid}", "basePath": "/business/communication" } ] }, { "file": "conversations.json", "basePath": "/v2", "transformations": [ { "original": "/conversations/{id}", "normalized": "/v2/conversations/{id}", "basePath": "/v2" } ] }, { "file": "legacy_v2_communication.json", "basePath": "/v2", "transformations": [ { "original": "/conversations/{conversation_id}/messages", "normalized": "/v2/conversations/{conversation_id}/messages", "basePath": "/v2" } ] }, { "file": "messages.json", "basePath": "/business/messaging", "transformations": [ { "original": "/v1/channels", "normalized": "/business/messaging/v1/channels", "basePath": "/business/messaging" }, { "original": "/v1/channels/typing", "normalized": "/business/messaging/v1/channels/typing", "basePath": "/business/messaging" } ] } ], "pathConflicts": [], "componentConflicts": [ { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_contact_channels", "files": [ "merged", "contact_channels.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_communication", "files": [ "merged", "communication.json" ] }, { "type": "schema", "name": "Response", "resolution": "Renamed to Response_communication", "files": [ "merged", "communication.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_activity_message", "files": [ "merged", "activity_message.json" ] }, { "type": "schema", "name": "Response", "resolution": "Renamed to Response_communication", "files": [ "merged", "communication.json" ] }, { "type": "schema", "name": "ErrorResponse", "resolution": "Renamed to ErrorResponse_conversations", "files": [ "merged", "conversations.json" ] } ], "totalPaths": 35, "totalComponents": 43 } }, "servers": [ { "url": "https://api.vcita.biz", "description": "Unified API Gateway server" } ], "paths": { "/v3/communication/notification_templates": { "post": { "summary": "Create a NotificationTemplate", "description": "## Overview\nCreate a new notification template. .**.\n\n**Available for Directory and App tokens**", "parameters": [], "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "code_name": { "type": "string", "description": "Unique identifier name for the notification" }, "title": { "type": "array", "description": "The display name of the notification template that appears in the staff portal notification settings. This is what users see when browsing available notification options (e.g., \"Payment Received Notification\"). Should contain at least one English locale entry when creating a template.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "description": { "type": "array", "description": "A brief explanation that appears in the staff portal notification settings to help them understand what this notification is for and when it will be triggered. Should contain at least one English locale entry when creating a template.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "category": { "type": "string", "description": "The functional category this notification belongs to (e.g., \"payments\", \"booking\", \"documents\").", "enum": [ "payments", "clients", "calendar", "booking", "marketing", "teamchat", "scheduling", "advertising", "group_events", "documents", "messages", "reviews", "social", "account" ] }, "configurable_by_staff": { "type": "boolean", "description": "Boolean flag that determines whether staff members can customize or modify this notification template through the staff portal." }, "content": { "type": "object", "description": "Notification content for 'email', 'staff_portal', and/or 'sms'. Not all content sections are required - only the channels that are relevant to the notification need to be populated.", "properties": { "staff_portal": { "type": "object", "description": "Staff portal notification content. This section is optional and may be omitted or contain empty arrays for templates not intended for staff portal delivery.", "properties": { "title": { "type": "array", "description": "Title for staff portal notification. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "message_body": { "type": "array", "description": "Message body for staff portal notification. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "deep_link": { "type": "string", "description": "Optional deep link URL for notification action." } } }, "email": { "type": "object", "description": "Email notification content. This section is optional and may contain empty arrays for templates not intended for email delivery.", "properties": { "subject": { "type": "array", "description": "Email subject line. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "top_image": { "type": "object", "description": "Image at the top of the email.", "properties": { "url": { "type": "string", "description": "Image URL." }, "width": { "type": "integer", "description": "Image width in pixels." }, "alt": { "type": "array", "description": "Alternative text for the image.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } }, "main_title": { "type": "array", "description": "Header or introduction text for the email. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "main_text": { "type": "array", "description": "Main content of the email. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "middle_image": { "type": "object", "description": "Image in the middle of the email.", "properties": { "url": { "type": "string", "description": "Image URL." }, "width": { "type": "integer", "description": "Image width in pixels." }, "alt": { "type": "array", "description": "Alternative text for the image.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } }, "middle_text": { "type": "array", "description": "Middle content of the email.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "footer_text": { "type": "array", "description": "Footer or closing text for the email.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "primary_cta_button": { "type": "object", "description": "Call-to-action button details.", "properties": { "text": { "type": "array", "description": "Button text.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "url": { "type": "string", "description": "Button URL." }, "alt": { "type": "array", "description": "Alternative text for the button.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } }, "secondary_cta_button": { "type": "object", "description": "Secondary call-to-action button details.", "properties": { "text": { "type": "array", "description": "Button text.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "url": { "type": "string", "description": "Button URL." }, "alt": { "type": "array", "description": "Alternative text for the button.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } } } }, "sms": { "type": "object", "description": "SMS notification content. This section is optional and may contain empty arrays for templates not intended for SMS delivery.", "properties": { "message_body": { "type": "array", "description": "Message body for SMS notification. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "deep_link": { "type": "string", "description": "Optional deep link URL for SMS notification action." } } } } } }, "required": [ "code_name", "title", "description", "category", "configurable_by_staff", "content" ] } } } }, "responses": { "201": { "description": "NotificationTemplate created successfully", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates whether the API request was successful (true) or failed (false)." }, "data": { "type": "object", "description": "The response payload. Present on successful responses (success: true)." }, "error": { "type": "string", "description": "Error message for simple error responses. Used in some legacy endpoints." }, "errors": { "type": "array", "description": "Array of error objects for detailed error responses. Present on error responses (success: false).", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found')." }, "message": { "type": "string", "description": "Human-readable error message." }, "field": { "type": "string", "description": "The field that caused the error (for validation errors)." } }, "required": [ "code", "message" ] } } }, "required": [ "success" ], "description": "Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string." }, { "properties": { "data": { "title": "NotificationTemplate", "description": "Metadata definition for notification templates and delivery settings.", "type": "object", "properties": { "uid": { "type": "string", "description": "Unique identifier for the entity instance." }, "code_name": { "type": "string", "description": "Unique identifier name for the notification" }, "title": { "type": "array", "description": "The display name of the notification template that appears in the staff portal notification settings. This is what users see when browsing available notification options (e.g., \"Payment Received Notification\"). Should contain at least one English locale entry when creating a template.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "description": { "type": "array", "description": "A brief explanation that appears in the staff portal notification settings to help them understand what this notification is for and when it will be triggered. Should contain at least one English locale entry when creating a template.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "category": { "type": "string", "description": "The functional category this notification belongs to (e.g., \"payments\", \"booking\", \"documents\").", "enum": [ "payments", "clients", "calendar", "booking", "marketing", "teamchat", "scheduling", "advertising", "group_events", "documents", "messages", "reviews", "social", "account" ] }, "configurable_by_staff": { "type": "boolean", "description": "Boolean flag that determines whether staff members can customize or modify this notification template through the staff portal." }, "delivery_channel": { "type": "array", "description": "List of delivery channels for the notification.", "items": { "type": "string", "enum": [ "push", "pane", "email", "sms" ] }, "minItems": 1 }, "trigger_type": { "type": "string", "description": "Type of trigger for the notification.", "enum": [ "system", "client" ] }, "content": { "type": "object", "description": "Notification content for 'email', 'staff_portal', and/or 'sms'. Not all content sections are required - only the channels that are relevant to the notification need to be populated.", "properties": { "staff_portal": { "type": "object", "description": "Staff portal notification content. This section is optional and may be omitted or contain empty arrays for templates not intended for staff portal delivery.", "properties": { "title": { "type": "array", "description": "Title for staff portal notification. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "message_body": { "type": "array", "description": "Message body for staff portal notification. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "deep_link": { "type": "string", "description": "Optional deep link URL for notification action." } } }, "email": { "type": "object", "description": "Email notification content. This section is optional and may contain empty arrays for templates not intended for email delivery.", "properties": { "subject": { "type": "array", "description": "Email subject line. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "top_image": { "type": "object", "description": "Image at the top of the email.", "properties": { "url": { "type": "string", "description": "Image URL." }, "width": { "type": "integer", "description": "Image width in pixels." }, "alt": { "type": "array", "description": "Alternative text for the image.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } }, "main_title": { "type": "array", "description": "Header or introduction text for the email. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "main_text": { "type": "array", "description": "Main content of the email. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "middle_image": { "type": "object", "description": "Image in the middle of the email.", "properties": { "url": { "type": "string", "description": "Image URL." }, "width": { "type": "integer", "description": "Image width in pixels." }, "alt": { "type": "array", "description": "Alternative text for the image.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } }, "middle_text": { "type": "array", "description": "Middle content of the email.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "footer_text": { "type": "array", "description": "Footer or closing text for the email.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "primary_cta_button": { "type": "object", "description": "Call-to-action button details.", "properties": { "text": { "type": "array", "description": "Button text.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "url": { "type": "string", "description": "Button URL." }, "alt": { "type": "array", "description": "Alternative text for the button.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } }, "secondary_cta_button": { "type": "object", "description": "Secondary call-to-action button details.", "properties": { "text": { "type": "array", "description": "Button text.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "url": { "type": "string", "description": "Button URL." }, "alt": { "type": "array", "description": "Alternative text for the button.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } } } } }, "sms": { "type": "object", "description": "SMS notification content. This section is optional and may contain empty arrays for templates not intended for SMS delivery.", "properties": { "message_body": { "type": "array", "description": "Message body for SMS notification. May be an empty array if not configured.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } }, "deep_link": { "type": "string", "description": "Optional deep link URL for SMS notification action." } } } } }, "created_at": { "type": "string", "format": "date-time", "description": "ISO8601 timestamp of when the entity was created." }, "updated_at": { "type": "string", "format": "date-time", "description": "ISO8601 timestamp of the last update to the entity." } }, "required": [ "uid", "code_name", "title", "description", "category", "configurable_by_staff", "delivery_channel", "trigger_type", "content", "created_at", "updated_at" ], "definitions": { "localizedTextList": { "type": "array", "description": "List of localized strings. Each item is a locale-value pair: locale is a locale (from enum), value is a string. Each language can appear only once.", "uniqueItems": true, "items": { "type": "object", "properties": { "locale": { "type": "string", "enum": [ "en", "fr", "de", "it", "pl", "pt", "es", "nl", "he", "sl", "en_gb" ] }, "value": { "type": "string" } }, "required": [ "locale", "value" ] } } }, "example": { "uid": "notif-001", "code_name": "welcome_new_user", "title": [ { "locale": "en", "value": "Welcome Notification" }, { "locale": "fr", "value": "Notification de bienvenue" }, { "locale": "de", "value": "Willkommensbenachrichtigung" } ], "description": [ { "locale": "en", "value": "Sent to new users upon registration." }, { "locale": "fr", "value": "Envoyé aux nouveaux utilisateurs lors de l'inscription." }, { "locale": "es", "value": "Enviado a los nuevos usuarios al registrarse." } ], "category": "account", "configurable_by_staff": true, "delivery_channel": [ "push", "email" ], "trigger_type": "system", "content": { "staff_portal": { "title": [ { "locale": "en", "value": "Welcome!" }, { "locale": "fr", "value": "Bienvenue!" }, { "locale": "es", "value": "¡Bienvenido!" } ], "message_body": [ { "locale": "en", "value": "Thanks for joining us!" }, { "locale": "fr", "value": "Merci de nous avoir rejoints!" } ], "deep_link": "https://example.com/welcome" }, "email": { "subject": [ { "locale": "en", "value": "Welcome to Our Service" }, { "locale": "fr", "value": "Bienvenue à notre service" }, { "locale": "de", "value": "Willkommen bei unserem Service" } ], "top_image": { "url": "https://example.com/banner.png", "width": 600, "alt": [ { "locale": "en", "value": "Welcome banner" }, { "locale": "fr", "value": "Bannière de bienvenue" } ] }, "main_title": [ { "locale": "en", "value": "Hello and Welcome!" }, { "locale": "fr", "value": "Bonjour et bienvenue!" } ], "main_text": [ { "locale": "en", "value": "We're excited to have you on board." }, { "locale": "es", "value": "Estamos emocionados de tenerte con nosotros." } ], "middle_image": { "url": "https://example.com/mid.png", "width": 400, "alt": [ { "locale": "en", "value": "Mid section image" }, { "locale": "es", "value": "Imagen de la sección media" } ] }, "middle_text": [ { "locale": "en", "value": "Here are some tips to get started." }, { "locale": "fr", "value": "Voici quelques conseils pour commencer." } ], "footer_text": [ { "locale": "en", "value": "Best regards, The Team" }, { "locale": "de", "value": "Mit freundlichen Grüßen, Das Team" } ], "primary_cta_button": { "text": [ { "locale": "en", "value": "Get Started" }, { "locale": "fr", "value": "Commencer" } ], "url": "https://example.com/start", "alt": [ { "locale": "en", "value": "Start now" }, { "locale": "fr", "value": "Commencez maintenant" } ] }, "secondary_cta_button": { "text": [ { "locale": "en", "value": "Contact Support" }, { "locale": "es", "value": "Contactar Soporte" } ], "url": "https://example.com/support", "alt": [ { "locale": "en", "value": "Support" }, { "locale": "es", "value": "Soporte" } ] } }, "sms": { "message_body": [ { "locale": "en", "value": "Welcome! Thanks for joining us. Get started:" }, { "locale": "fr", "value": "Bienvenue! Merci de nous avoir rejoints. Commencez:" }, { "locale": "es", "value": "¡Bienvenido! Gracias por unirte. Comienza:" } ], "deep_link": "https://example.com/welcome" } }, "created_at": "2024-06-01T12:00:00Z", "updated_at": "2024-06-01T12:00:00Z" } } } } ] } } } }, "400": { "description": "Invalid request", "content": { "application/json": { "schema": { "allOf": [ { "type": "object", "properties": { "success": { "type": "boolean", "description": "Indicates whether the API request was successful (true) or failed (false)." }, "data": { "type": "object", "description": "The response payload. Present on successful responses (success: true)." }, "error": { "type": "string", "description": "Error message for simple error responses. Used in some legacy endpoints." }, "errors": { "type": "array", "description": "Array of error objects for detailed error responses. Present on error responses (success: false).", "items": { "type": "object", "properties": { "code": { "type": "string", "description": "Machine-readable error code (e.g., 'already_exists', 'invalid', 'not_found')." }, "message": { "type": "string", "description": "Human-readable error message." }, "field": { "type": "string", "description": "The field that caused the error (for validation errors)." } }, "required": [ "code", "message" ] } } }, "required": [ "success" ], "description": "Generic wrapper object for API responses. Success responses contain 'data', while error responses contain 'errors' array or 'error' string." } ] }, "example": { "success": false, "errors": [ { "code": "validation_error", "message": "The request contains invalid data" } ] } } } } }, "tags": [ "Notification Templates" ], "security": [ { "Bearer": [] } ] } } }, "components": { "securitySchemes": { "Bearer": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT", "description": "Provide a valid bearer token in the Authorization header. Example: 'Authorization: Bearer {app_token}'" } } } } ```