Update Custom Attribute
curl --request PATCH \
--url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId} \
--header 'Content-Type: application/json' \
--data '
{
"apiKeyName": "<string>",
"inputType": "<string>",
"name": "<string>",
"config": {
"currencyDisplayType": "<string>",
"currencyCode": "<string>",
"recordReference": {},
"aiWizard": "<string>",
"dateDisplayType": "<string>"
},
"defaultValue": "<string>",
"description": "<string>",
"isEditable": true,
"isMultiSelect": true,
"isRequired": true,
"isUnique": true,
"validation": "<string>"
}
'import requests
url = "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}"
payload = {
"apiKeyName": "<string>",
"inputType": "<string>",
"name": "<string>",
"config": {
"currencyDisplayType": "<string>",
"currencyCode": "<string>",
"recordReference": {},
"aiWizard": "<string>",
"dateDisplayType": "<string>"
},
"defaultValue": "<string>",
"description": "<string>",
"isEditable": True,
"isMultiSelect": True,
"isRequired": True,
"isUnique": True,
"validation": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
apiKeyName: '<string>',
inputType: '<string>',
name: '<string>',
config: {
currencyDisplayType: '<string>',
currencyCode: '<string>',
recordReference: {},
aiWizard: '<string>',
dateDisplayType: '<string>'
},
defaultValue: '<string>',
description: '<string>',
isEditable: true,
isMultiSelect: true,
isRequired: true,
isUnique: true,
validation: '<string>'
})
};
fetch('https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'apiKeyName' => '<string>',
'inputType' => '<string>',
'name' => '<string>',
'config' => [
'currencyDisplayType' => '<string>',
'currencyCode' => '<string>',
'recordReference' => [
],
'aiWizard' => '<string>',
'dateDisplayType' => '<string>'
],
'defaultValue' => '<string>',
'description' => '<string>',
'isEditable' => true,
'isMultiSelect' => true,
'isRequired' => true,
'isUnique' => true,
'validation' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}"
payload := strings.NewReader("{\n \"apiKeyName\": \"<string>\",\n \"inputType\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {\n \"currencyDisplayType\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"recordReference\": {},\n \"aiWizard\": \"<string>\",\n \"dateDisplayType\": \"<string>\"\n },\n \"defaultValue\": \"<string>\",\n \"description\": \"<string>\",\n \"isEditable\": true,\n \"isMultiSelect\": true,\n \"isRequired\": true,\n \"isUnique\": true,\n \"validation\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}")
.header("Content-Type", "application/json")
.body("{\n \"apiKeyName\": \"<string>\",\n \"inputType\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {\n \"currencyDisplayType\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"recordReference\": {},\n \"aiWizard\": \"<string>\",\n \"dateDisplayType\": \"<string>\"\n },\n \"defaultValue\": \"<string>\",\n \"description\": \"<string>\",\n \"isEditable\": true,\n \"isMultiSelect\": true,\n \"isRequired\": true,\n \"isUnique\": true,\n \"validation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiKeyName\": \"<string>\",\n \"inputType\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {\n \"currencyDisplayType\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"recordReference\": {},\n \"aiWizard\": \"<string>\",\n \"dateDisplayType\": \"<string>\"\n },\n \"defaultValue\": \"<string>\",\n \"description\": \"<string>\",\n \"isEditable\": true,\n \"isMultiSelect\": true,\n \"isRequired\": true,\n \"isUnique\": true,\n \"validation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "success",
"data": {
"_id": "64ad815b273e66dae1afe10f",
"apiKeyName": "name",
"inputType": "text",
"name": "Name",
"config": {
"currencyDisplayType": null,
"currencyCode": null,
"recordReference": [],
"aiWizard": null,
"dateDisplayType": null
},
"defaultValue": null,
"description": "",
"isEditable": true,
"isMultiSelect": false,
"isRequired": false,
"isUnique": false,
"validation": "none"
}
}
{
"status": false,
"message": "No token provided"
}
Attributes
Update Custom Attribute
This endpoint updates an existing attribute for a specified target (collection or list).
PATCH
/
api
/
v1
/
attributes
/
{target}
/
{targetId}
/
{attributeId}
Update Custom Attribute
curl --request PATCH \
--url https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId} \
--header 'Content-Type: application/json' \
--data '
{
"apiKeyName": "<string>",
"inputType": "<string>",
"name": "<string>",
"config": {
"currencyDisplayType": "<string>",
"currencyCode": "<string>",
"recordReference": {},
"aiWizard": "<string>",
"dateDisplayType": "<string>"
},
"defaultValue": "<string>",
"description": "<string>",
"isEditable": true,
"isMultiSelect": true,
"isRequired": true,
"isUnique": true,
"validation": "<string>"
}
'import requests
url = "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}"
payload = {
"apiKeyName": "<string>",
"inputType": "<string>",
"name": "<string>",
"config": {
"currencyDisplayType": "<string>",
"currencyCode": "<string>",
"recordReference": {},
"aiWizard": "<string>",
"dateDisplayType": "<string>"
},
"defaultValue": "<string>",
"description": "<string>",
"isEditable": True,
"isMultiSelect": True,
"isRequired": True,
"isUnique": True,
"validation": "<string>"
}
headers = {"Content-Type": "application/json"}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'Content-Type': 'application/json'},
body: JSON.stringify({
apiKeyName: '<string>',
inputType: '<string>',
name: '<string>',
config: {
currencyDisplayType: '<string>',
currencyCode: '<string>',
recordReference: {},
aiWizard: '<string>',
dateDisplayType: '<string>'
},
defaultValue: '<string>',
description: '<string>',
isEditable: true,
isMultiSelect: true,
isRequired: true,
isUnique: true,
validation: '<string>'
})
};
fetch('https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'apiKeyName' => '<string>',
'inputType' => '<string>',
'name' => '<string>',
'config' => [
'currencyDisplayType' => '<string>',
'currencyCode' => '<string>',
'recordReference' => [
],
'aiWizard' => '<string>',
'dateDisplayType' => '<string>'
],
'defaultValue' => '<string>',
'description' => '<string>',
'isEditable' => true,
'isMultiSelect' => true,
'isRequired' => true,
'isUnique' => true,
'validation' => '<string>'
]),
CURLOPT_HTTPHEADER => [
"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://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}"
payload := strings.NewReader("{\n \"apiKeyName\": \"<string>\",\n \"inputType\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {\n \"currencyDisplayType\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"recordReference\": {},\n \"aiWizard\": \"<string>\",\n \"dateDisplayType\": \"<string>\"\n },\n \"defaultValue\": \"<string>\",\n \"description\": \"<string>\",\n \"isEditable\": true,\n \"isMultiSelect\": true,\n \"isRequired\": true,\n \"isUnique\": true,\n \"validation\": \"<string>\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
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.patch("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}")
.header("Content-Type", "application/json")
.body("{\n \"apiKeyName\": \"<string>\",\n \"inputType\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {\n \"currencyDisplayType\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"recordReference\": {},\n \"aiWizard\": \"<string>\",\n \"dateDisplayType\": \"<string>\"\n },\n \"defaultValue\": \"<string>\",\n \"description\": \"<string>\",\n \"isEditable\": true,\n \"isMultiSelect\": true,\n \"isRequired\": true,\n \"isUnique\": true,\n \"validation\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.zixflow.com/api/v1/attributes/{target}/{targetId}/{attributeId}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n \"apiKeyName\": \"<string>\",\n \"inputType\": \"<string>\",\n \"name\": \"<string>\",\n \"config\": {\n \"currencyDisplayType\": \"<string>\",\n \"currencyCode\": \"<string>\",\n \"recordReference\": {},\n \"aiWizard\": \"<string>\",\n \"dateDisplayType\": \"<string>\"\n },\n \"defaultValue\": \"<string>\",\n \"description\": \"<string>\",\n \"isEditable\": true,\n \"isMultiSelect\": true,\n \"isRequired\": true,\n \"isUnique\": true,\n \"validation\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": true,
"message": "success",
"data": {
"_id": "64ad815b273e66dae1afe10f",
"apiKeyName": "name",
"inputType": "text",
"name": "Name",
"config": {
"currencyDisplayType": null,
"currencyCode": null,
"recordReference": [],
"aiWizard": null,
"dateDisplayType": null
},
"defaultValue": null,
"description": "",
"isEditable": true,
"isMultiSelect": false,
"isRequired": false,
"isUnique": false,
"validation": "none"
}
}
{
"status": false,
"message": "No token provided"
}
Description
This API endpoint allows the update of an existing attribute within a specified target, either a collection or a list. Attributes define the nature and characteristics of the data stored within the target.Path
string
required
Specifies the target type, which can be either “collection” or “list.”
string
required
A unique identifier for the target, either a collection ID or a list ID, depending on the target type.
string
required
A unique identifier for the attribute to be updated.
Body
string
The updated API key name used to store data in the collection or list for this field.
string
The updated input type or nature of the field. Possible values include text, number, checkbox, currency, date, timestamp, rating, status, select, multiselect, record-reference, actor-reference, domain, file, ai-wizard, email-address, phone-number.
string
The updated human-readable name of the field.
object
Updated configuration settings for the attribute, including currency display type, currency code, record reference, AI wizard, and date display type.
Show config
Show config
string
Accepted values: “code,” “name,” “narrowSymbol,” “symbol.” Specifies how currency should be displayed.
string
The updated currency code (e.g., “EUR,” “GBP,” “USD,” “CAD,” “AUD”).
array_string
An updated array of collection IDs connected to this attribute.
string
The updated AI wizard field prompt.
string
Defines how to display the updated date field.
string
The updated default value for the attribute.
string
An updated description providing additional information about the attribute.
boolean
Indicates whether the attribute is editable (true/false).
boolean
Indicates whether the attribute supports multiple selections (true/false).
boolean
Indicates whether the attribute is required (true/false).
boolean
Indicates whether the attribute values must be unique (true/false).
string
The updated validation type for the attribute. Possible values include “none,” “email,” “url,” “phone,” “customRegex.”
Response
boolean
Indicates the success or failure of the attribute update. In this case,
true signifies a successful operation.
string
Provides a human-readable message accompanying the response. In this instance,
it confirms the successful update of the attribute.
object
An object containing details of the updated attribute:
Show data
Show data
string
A unique identifier for the updated attribute, allowing for precise referencing.
string
The API key name used to store data in the collection or list for this field.
string
Defines the updated input type or nature of the field.
string
The updated human-readable name of the field.
object
Updated configuration settings for the attribute.
string
The updated default value for the attribute.
string
An updated description providing additional information about the attribute.
boolean
Indicates whether the updated attribute is editable.
boolean
Indicates whether the updated attribute supports multiple selections.
boolean
Indicates whether the updated attribute is required.
boolean
Indicates whether the updated attribute values must be unique.
string
The updated validation type for the attribute.
{
"status": true,
"message": "success",
"data": {
"_id": "64ad815b273e66dae1afe10f",
"apiKeyName": "name",
"inputType": "text",
"name": "Name",
"config": {
"currencyDisplayType": null,
"currencyCode": null,
"recordReference": [],
"aiWizard": null,
"dateDisplayType": null
},
"defaultValue": null,
"description": "",
"isEditable": true,
"isMultiSelect": false,
"isRequired": false,
"isUnique": false,
"validation": "none"
}
}
{
"status": false,
"message": "No token provided"
}