Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Dialer SDK
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API Documentation
Dialer SDK
  1. Call Action Templates
  • Platform
    • Users
      • List Users
      • Create User
      • Get User Details
      • Update User
      • Partial Update User
      • Delete User
    • Groups
      • Get Group Tree
      • List Child Groups
      • Get Group Details
      • List Groups
      • Get Org Unit Hierarchy
      • Update Group
      • Partial Update Group
      • Delete Group
      • Create Group
    • Webhooks
      • Create Webhook
      • Get Webhook Details
      • List Webhooks
      • Update Webhook
      • Partial Update Webhook
      • Delete Webhook
    • Media Prompts
      • List Prompts
      • Get Prompt by ID
      • Upload Prompt
      • Delete Prompt
  • AI Voice Agents
    • List AI Voice Agents
      GET
    • Get Agent Details
      GET
    • Delete Agent
      DELETE
  • Phone Numbers
    • Assigned Numbers
      GET
    • Provisioned Numbers
      GET
    • Reserved Numbers
      DELETE
    • Phone Numbers
      POST
    • Available Numbers
      GET
  • Provisioned Routes
    • List Provisioned Routes
      GET
    • Create Provisioned Route
      POST
    • Get Provisioned Route Details
      GET
    • Delete Provisioned Route
      DELETE
    • Update Provisioned Route
      PUT
    • Partial Update Provisioned Route
      PATCH
  • SMS Broadcasts
    • List Broadcasts
      GET
    • Create Broadcast
      POST
    • Get Broadcast Details
      GET
    • Update Broadcast
      PUT
    • Partial Update Broadcast
      PATCH
    • Delete Broadcast
      DELETE
  • Conversation
    • Calls
      • Get Calls List
      • Get Call By ID
      • Email Call Data
      • Move Call to Another Group
      • Add Notes to Calls
      • Upload Call Recording
      • Add Tags to Call
    • SMS
      • Get SMS Conversations
      • Get SMS Conversation By ID
    • Opportunity Recovery
      • Get Conversations By Custom Insights
    • Agent Performance
      • Get Agent Performance Metrics
    • Attribution Engine
      • Get Marketing Attribution Data
  • Blacklist
    • List blacklisted numbers
    • Add numbers to blacklist
    • Delete numbers from blacklist
  • Call Action Templates
    • Create Call Action Template
      POST
    • Update Call Action Template
      PUT
  • Campaigns
    • List Campaigns
    • Create Campaign
    • Get Campaign Details
    • Update Campaign
    • Partial Update Campaign
    • Delete Campaign
  • Custom Insights
    • Get Custom Insights
    • Create New Custom Insight
    • Get Custom Insight By Id
    • Update Custom Insight
    • Partial Update Custom Insight
    • Delete Custom Insight
  • Custom Source
    • Get Custom Sources
    • Create Custom Source
    • Delete Custom Sources (Single or Multiple)
  • DNI
    • List DNI Settings
    • Update DNI Setting
    • Delete DNI Setting
    • Create DNI Setting
  • Geo Locations
    • List Geo Locations
    • Create Geo Location
    • Get Geo Location
    • Update Geo Location
    • Partially Update Geo Location
    • Delete Geo Location
    • List Geo Location Routes
    • Create Geo Location Route
    • Get Geo Location Route
    • Update Geo Location Route
    • Partially Update Geo Location Route
    • Delete Geo Location Route
    • Import Geo Location Routes from CSV
  • Insights
    • List Insights
    • Create Insight
    • Get Insight Details
    • Delete Insight
  • Scorecards
    • List Scorecards
    • Get Scored Calls Report
    • Create Scorecard
    • Add or Update Call Title
    • Duplicate Scorecard
    • Archive Scorecard
  • Miscellaneous
    • List Ad Sources
    • List Industries
    • List Tags
    • Create Tag
    • Update Tag
    • Delete Tag
  • Subscriptions
    • List Webhook Subscriptions
    • Create Webhook Subscription
    • Delete Webhook Subscription
  1. Call Action Templates

Create Call Action Template

POST
https://platform-api.convirza.com/v3/call-action/template
Call Action Templates
Last modified:2026-07-24 13:10:44

Creates a reusable call action template that can be applied to multiple organization units.

Request Structure

  • org_unit_id: Parent organization unit ID
  • template: Template configuration (name, visibility, active status, applied groups)
  • triggerArray: Actions to perform (email, SMS, webhook, tag, etc.)
  • actionsArray: Conditions/rules that determine when to trigger

Available Trigger Types

  • email_alert — Send email notifications
  • tag_call — Apply tags to calls
  • webhook — Trigger HTTP webhook
  • callback — Flag for callback
  • sms_alert — Send SMS (requires sms_action_trigger)
  • attach_scorecard — Attach scorecard to call

SMS Trigger Configuration
When using sms_alert, include sms_action_trigger:

  • sms_action_target_type: "phone_number", "caller", "assigned_agent", or "agent"
  • sms_action_target_agent: Array of user IDs (for "agent" type)
  • sms_action_target_number: Phone number (for "phone_number" type)
  • outbound_sms: SMS message text
  • opt_out_sms: Opt-out message text

Rule Conditions

  • actionName: Data field to evaluate
  • actionCondition: Operator (is, is not, contains, >, <, etc.)
  • actionValue: Value to compare
  • jointype: NONE (first rule), AND, OR
  • actionRuleIndicatorName: Display name
  • unitValue: Unit (seconds, minutes, etc.)

Roles required: Admin or Standard

Request

Authorization
Bearer Token
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
or
Body Params application/jsonRequired

Examples

Responses

🟢201
application/json
Template created successfully
Bodyapplication/json

🟠400
🟠401
🔴500
Request Request Example
Shell
JavaScript
Java
Swift
curl --location 'https://platform-api.convirza.com/v3/call-action/template' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{
    "org_unit_id": 70035,
    "template": {
        "template_name": "Repeat Call Tag Alert",
        "editor": "DG Test1",
        "last_modified": "",
        "visible_for_subgroups": true,
        "applied_to": [
            74195,
            74194
        ],
        "active": true
    },
    "triggerArray": [
        {
            "triggerName": "tag_call",
            "triggerValues": [
                "931"
            ],
            "sms_action_trigger": {
                "sms_action_target_type": "",
                "sms_action_target_agent": [],
                "sms_action_target_number": "",
                "outbound_sms": "",
                "opt_out_sms": "",
                "sms_template": ""
            }
        }
    ],
    "actionsArray": [
        {
            "jointype": "NONE",
            "actionName": "repeat_call",
            "actionCondition": "is",
            "actionValue": true,
            "unitValue": "",
            "actionRuleIndicatorName": null
        }
    ]
}'
Response Response Example
201 - Example 1
{
    "code": 201,
    "message": "Success",
    "data": {
        "template_id": 123
    },
    "request_id": "550e8400-e29b-41d4-a716-446655440000",
    "timestamp": "2026-04-21T10:30:00.000Z"
}
Modified at 2026-07-24 13:10:44
Previous
Delete numbers from blacklist
Next
Update Call Action Template
Built with