Updates an existing custom text field.

PUT /api/field/text

Updates an existing custom text field.

cURL

curl --request PUT \
  --url https://{install}/api/field/text \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entity": "<string>",
  "fieldType": "<string>",
  "contentType": "<string>",
  "maximum": 123,
  "defaultValue": "<string>",
  "name": "<string>",
  "prompt": "<string>",
  "description": "<string>",
  "isCore": true,
  "isFeature": true,
  "featureName": "<string>",
  "placement": [
    123
  ],
  "usage": [
    123
  ],
  "listEditable": true,
  "tenantId": "<string>",
  "id": "<string>",
  "created": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "updated": "2023-11-07T05:31:56Z",
  "updatedBy": "<string>",
  "deleted": true
}
'

import requests

url = "https://{install}/api/field/text"

payload = {
    "entity": "<string>",
    "fieldType": "<string>",
    "contentType": "<string>",
    "maximum": 123,
    "defaultValue": "<string>",
    "name": "<string>",
    "prompt": "<string>",
    "description": "<string>",
    "isCore": True,
    "isFeature": True,
    "featureName": "<string>",
    "placement": [123],
    "usage": [123],
    "listEditable": True,
    "tenantId": "<string>",
    "id": "<string>",
    "created": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "updated": "2023-11-07T05:31:56Z",
    "updatedBy": "<string>",
    "deleted": True
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.put(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PUT',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    entity: '<string>',
    fieldType: '<string>',
    contentType: '<string>',
    maximum: 123,
    defaultValue: '<string>',
    name: '<string>',
    prompt: '<string>',
    description: '<string>',
    isCore: true,
    isFeature: true,
    featureName: '<string>',
    placement: [123],
    usage: [123],
    listEditable: true,
    tenantId: '<string>',
    id: '<string>',
    created: '2023-11-07T05:31:56Z',
    createdBy: '<string>',
    updated: '2023-11-07T05:31:56Z',
    updatedBy: '<string>',
    deleted: true
  })
};

fetch('https://{install}/api/field/text', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

using RestSharp;


var options = new RestClientOptions("https://{install}/api/field/text");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "Bearer <token>");
request.AddJsonBody("{\n  \"entity\": \"<string>\",\n  \"fieldType\": \"<string>\",\n  \"contentType\": \"<string>\",\n  \"maximum\": 123,\n  \"defaultValue\": \"<string>\",\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCore\": true,\n  \"isFeature\": true,\n  \"featureName\": \"<string>\",\n  \"placement\": [\n    123\n  ],\n  \"usage\": [\n    123\n  ],\n  \"listEditable\": true,\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}", false);
var response = await client.PutAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{install}/api/field/text",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'entity' => '<string>',
    'fieldType' => '<string>',
    'contentType' => '<string>',
    'maximum' => 123,
    'defaultValue' => '<string>',
    'name' => '<string>',
    'prompt' => '<string>',
    'description' => '<string>',
    'isCore' => true,
    'isFeature' => true,
    'featureName' => '<string>',
    'placement' => [
        123
    ],
    'usage' => [
        123
    ],
    'listEditable' => true,
    'tenantId' => '<string>',
    'id' => '<string>',
    'created' => '2023-11-07T05:31:56Z',
    'createdBy' => '<string>',
    'updated' => '2023-11-07T05:31:56Z',
    'updatedBy' => '<string>',
    'deleted' => true
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://{install}/api/field/text"

	payload := strings.NewReader("{\n  \"entity\": \"<string>\",\n  \"fieldType\": \"<string>\",\n  \"contentType\": \"<string>\",\n  \"maximum\": 123,\n  \"defaultValue\": \"<string>\",\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCore\": true,\n  \"isFeature\": true,\n  \"featureName\": \"<string>\",\n  \"placement\": [\n    123\n  ],\n  \"usage\": [\n    123\n  ],\n  \"listEditable\": true,\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}")

	req, _ := http.NewRequest("PUT", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

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

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.put("https://{install}/api/field/text")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"entity\": \"<string>\",\n  \"fieldType\": \"<string>\",\n  \"contentType\": \"<string>\",\n  \"maximum\": 123,\n  \"defaultValue\": \"<string>\",\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCore\": true,\n  \"isFeature\": true,\n  \"featureName\": \"<string>\",\n  \"placement\": [\n    123\n  ],\n  \"usage\": [\n    123\n  ],\n  \"listEditable\": true,\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{install}/api/field/text")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"entity\": \"<string>\",\n  \"fieldType\": \"<string>\",\n  \"contentType\": \"<string>\",\n  \"maximum\": 123,\n  \"defaultValue\": \"<string>\",\n  \"name\": \"<string>\",\n  \"prompt\": \"<string>\",\n  \"description\": \"<string>\",\n  \"isCore\": true,\n  \"isFeature\": true,\n  \"featureName\": \"<string>\",\n  \"placement\": [\n    123\n  ],\n  \"usage\": [\n    123\n  ],\n  \"listEditable\": true,\n  \"tenantId\": \"<string>\",\n  \"id\": \"<string>\",\n  \"created\": \"2023-11-07T05:31:56Z\",\n  \"createdBy\": \"<string>\",\n  \"updated\": \"2023-11-07T05:31:56Z\",\n  \"updatedBy\": \"<string>\",\n  \"deleted\": true\n}"

response = http.request(request)
puts response.read_body

Authorizations

Authorization · string · header · required

JWT Bearer token. Obtain via the OAuth 2.0 token endpoint.

Body

application/jsonapplication/*+json

The text field definition with updated values.

entity · null | string

fieldType · null | string

contentType · string

maximum · integer<int32>

defaultValue · string

name · string

prompt · string

description · string

isCore · boolean

isFeature · boolean

featureName · string

placement · integer[]

usage · integer[]

listEditable · boolean

tenantId · string

id · string

created · string<date-time>

createdBy · string

updated · string<date-time>

updatedBy · string

deleted · boolean

Response

200

application/json

Text field updated successfully.