/

Browse the help center

Add or edit template property

Creates a new template property or updates an existing one within the specified template.

Reference

POST https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do

Creates a new template property or updates an existing one within the specified template. The property type determines which fields are applicable: FILE properties support allowedContentTypes, STRING properties support url/multiline/maxLength validation, INTEGER properties support minValue/maxValue/step, SELECT properties support key-value pairs and an optional 'Please Select' option, and BOOLEAN/PLACEMENT_KEY have no extra configuration. The macro key must be unique within the template and must not conflict with reserved system macros or existing file keys. The template version is incremented after the property is saved. Requires edit permission on the template; a refused call saves nothing.

Form Params

templateId integer required

Unique numeric identifier of the template to add the property to or that contains the property being edited

300

type string

Type of the property to create (default FILE) — ignored when propertyId names an existing property

STRING

propertyId integer

ID of the template property to edit — omit to create a new one

40

key string

Property key used in template content (format: $$KEY$$); the platform's own macro names, such as $$CLICK_URL$$, are reserved and refused

$$HEADLINE$$

moderation boolean

Whether this property requires moderation approval

false

order integer

Display order of this property in the form

1

required boolean

Whether this property is required when creating a banner

true

title string

Property display title

Click URL

Responses

200

Operation result with success status

400

Bad request — invalid or missing parameters

401

Authentication error

403

Forbidden — insufficient permissions

404

propertyId names a property of another template

Language

cURL Request

curl --request POST \
  --url 'https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do' \
  --header 'X-Api-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --data-urlencode 'templateId=300' \
  --data-urlencode 'type=STRING' \
  --data-urlencode 'propertyId=40' \
  --data-urlencode 'key=$$HEADLINE$$'

Python Request

import requests

response = requests.request("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do", headers={"X-Api-Key": "YOUR_API_KEY"}, data={"templateId": "300", "type": "STRING", "propertyId": "40", "key": "$$HEADLINE$$"})
print(response.json())

Node Request

const response = await fetch('https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do', {
  method: 'POST',
  headers: { 'X-Api-Key': 'YOUR_API_KEY', 'Content-Type': 'application/x-www-form-urlencoded' },
  body: new URLSearchParams({"templateId":"300","type":"STRING","propertyId":"40","key":"$$HEADLINE$$"}),
});

console.log(await response.json());

Java Request

HttpClient client = HttpClient.newHttpClient();

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do"))
    .header("X-Api-Key", "YOUR_API_KEY")
    .header("Content-Type", "application/x-www-form-urlencoded")
    .method("POST", HttpRequest.BodyPublishers.ofString("templateId=300&type=STRING&propertyId=40&key=%24%24HEADLINE%24%24"))
    .build();

HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

C# Request

using var client = new HttpClient();

var request = new HttpRequestMessage(new HttpMethod("POST"), "https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do");
request.Headers.Add("X-Api-Key", "YOUR_API_KEY");
request.Content = new FormUrlEncodedContent(new Dictionary<string, string> { ["templateId"] = "300", ["type"] = "STRING", ["propertyId"] = "40", ["key"] = "$$HEADLINE$$" });

var response = await client.SendAsync(request);
Console.WriteLine(await response.Content.ReadAsStringAsync());

Go Request

package main

import (
	"fmt"
	"io"
	"net/http"
	"strings"
)

func main() {
	req, _ := http.NewRequest("POST", "https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do", strings.NewReader(`templateId=300&type=STRING&propertyId=40&key=%24%24HEADLINE%24%24`))
	req.Header.Set("X-Api-Key", "YOUR_API_KEY")
	req.Header.Set("Content-Type", "application/x-www-form-urlencoded")

	res, _ := http.DefaultClient.Do(req)
	defer res.Body.Close()

	out, _ := io.ReadAll(res.Body)
	fmt.Println(string(out))
}

PHP Request

<?php
$ch = curl_init("https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, ["X-Api-Key: YOUR_API_KEY", "Content-Type: application/x-www-form-urlencoded"]);
curl_setopt($ch, CURLOPT_POSTFIELDS, 'templateId=300&type=STRING&propertyId=40&key=%24%24HEADLINE%24%24');

echo curl_exec($ch);
curl_close($ch);

Ruby Request

require 'net/http'
require 'json'

uri = URI("https://YOUR-NETWORK-DOMAIN/rest-api/template/template-property/edit.do")
request = Net::HTTP::Post.new(uri)
request['X-Api-Key'] = 'YOUR_API_KEY'
request['Content-Type'] = 'application/x-www-form-urlencoded'
request.set_form_data('templateId' => "300", 'type' => "STRING", 'propertyId' => "40", 'key' => "$$HEADLINE$$")

response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |http| http.request(request) }
puts response.body