CreateWebLinkTemplate

POST

https://api.cbf.tcn.com/api/v0alpha/org/weblinktemplate/create

Creates a new WebLinkTemplate as defined by request message CreateWebLinkTemplateRequest.
Required Permissions:
ORG_EDIT

Request

Authorization

JWT Bearer

Add the parameter

Authorization

to Headers

Example:

Authorization: ********************

Body Params application/jsonRequired

Example

{
    "web_link_template": {
        "web_link_template_id": "string",
        "display_name": "string",
        "description": "string",
        "is_js_link": true,
        "base_url": [
            {
                "agent_field": {
                    "option": "AGENT_FIELD_OPTION_AGENT_FIRST_NAME"
                }
            }
        ],
        "parameters": [
            {
                "key": "string",
                "value": [
                    {
                        "agent_field": {
                            "option": "AGENT_FIELD_OPTION_AGENT_FIRST_NAME"
                        }
                    }
                ]
            }
        ]
    }
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.cbf.tcn.com/api/v0alpha/org/weblinktemplate/create' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "web_link_template": {
        "web_link_template_id": "string",
        "display_name": "string",
        "description": "string",
        "is_js_link": true,
        "base_url": [
            {
                "agent_field": {
                    "option": "AGENT_FIELD_OPTION_AGENT_FIRST_NAME"
                }
            }
        ],
        "parameters": [
            {
                "key": "string",
                "value": [
                    {
                        "agent_field": {
                            "option": "AGENT_FIELD_OPTION_AGENT_FIRST_NAME"
                        }
                    }
                ]
            }
        ]
    }
}'

Responses

🟢200OK

application/json

Success

Body

Example

{}

🟢200Success

Modified at 2025-09-26 15:44:58

ClearEmailUnsubscribeAcknowledgement

ListWebLinkTemplates