CreateWebLinkTemplate

POST

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

Org

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

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

web_link_template

object (WebLinkTemplate)

web_link_template

optional

web_link_template_id

string

web_link_template_id

optional

display_name

string

display_name

optional

description

string

description

optional

is_js_link

boolean

is_js_link

optional

base_url

array[null (WebLinkBaseOption) {11}]

base_url

optional

parameters

array[object (WebLinkParameter) {2}]

parameters

optional

Example

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

Request 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 '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": [
            {}
        ],
        "parameters": [
            {
                "key": "string",
                "value": [
                    {}
                ]
            }
        ]
    }
}'

Responses

🟢200OK

application/json

Success

Body

object {0}

Example

{}

🔴500Server Error

Modified at 2025-04-18 19:29:54

ClearEmailUnsubscribeAcknowledgement

ListWebLinkTemplates